建设网站需要多少费用,企业网站制作方法,西安大雁塔附近酒店推荐,全球速卖通卖家登录入口在我们平时工作中经常会遇到要操作Excel的功能#xff0c;比如导出个用户信息或者订单信息的Excel报表。你肯定听说过POI这个东西#xff0c;可以实现。但是POI实现的API确实很麻烦#xff0c;它需要写那种逐行解析的代码#xff08;类似Xml解析#xff09;。今天给大家推… 在我们平时工作中经常会遇到要操作Excel的功能比如导出个用户信息或者订单信息的Excel报表。你肯定听说过POI这个东西可以实现。但是POI实现的API确实很麻烦它需要写那种逐行解析的代码类似Xml解析。今天给大家推荐一款非常好用的Excel导入导出工具EasyPoi希望对大家有所帮助EasyPoi简介 用惯了SpringBoot的朋友估计会想到有没有什么办法可以直接定义好需要导出的数据对象然后添加几个注解直接自动实现Excel导入导出功能EasyPoi正是这么一款工具如果你不太熟悉POI想简单地实现Excel操作用它就对了EasyPoi的目标不是替代POI而是让一个不懂导入导出的人也能快速使用POI完成Excel的各种操作而不是看很多API才可以完成这样的工作。集成 在SpringBoot中集成EasyPoi非常简单只需添加如下一个依赖即可真正的开箱即用dependencygroupIdcn.afterturn/groupIdartifactIdeasypoi-spring-boot-starter/artifactIdversion4.4.0/version
/dependency使用 接下来介绍下EasyPoi的使用以会员信息和订单信息的导入导出为例分别实现下简单的单表导出和具有关联信息的复杂导出。简单导出我们以会员信息列表导出为例使用EasyPoi来实现下导出功能看看是不是够简单首先创建一个会员对象Member封装会员信息/*** 购物会员* Created by macro on 2021/10/12.*/
Data
EqualsAndHashCode(callSuper false)
public class Member {Excel(name ID, width 10)private Long id;Excel(name 用户名, width 20, needMerge true)private String username;private String password;Excel(name 昵称, width 20, needMerge true)private String nickname;Excel(name 出生日期, width 20, format yyyy-MM-dd)private Date birthday;Excel(name 手机号, width 20, needMerge true, desensitizationRule 3_4)private String phone;private String icon;Excel(name 性别, width 10, replace {男_0, 女_1})private Integer gender;
}在此我们就可以看到EasyPoi的核心注解Excel通过在对象上添加Excel注解可以将对象信息直接导出到Excel中去下面对注解中的属性做个介绍nameExcel中的列名width指定列的宽度needMerge是否需要纵向合并单元格format当属性为时间类型时设置时间的导出导出格式desensitizationRule数据脱敏处理3_4表示只显示字符串的前3位和后4位其他为*号replace对属性进行替换suffix对数据添加后缀。接下来我们在Controller中添加一个接口用于导出会员列表到Excel具体代码如下/*** EasyPoi导入导出测试Controller* Created by macro on 2021/10/12.*/
Controller
Api(tags EasyPoiController, description EasyPoi导入导出测试)
RequestMapping(/easyPoi)
public class EasyPoiController {ApiOperation(value 导出会员列表Excel)RequestMapping(value /exportMemberList, method RequestMethod.GET)public void exportMemberList(ModelMap map,HttpServletRequest request,HttpServletResponse response) {ListMember memberList LocalJsonUtil.getListFromJson(json/members.json, Member.class);ExportParams params new ExportParams(会员列表, 会员列表, ExcelType.XSSF);map.put(NormalExcelConstants.DATA_LIST, memberList);map.put(NormalExcelConstants.CLASS, Member.class);map.put(NormalExcelConstants.PARAMS, params);map.put(NormalExcelConstants.FILE_NAME, memberList);PoiBaseView.render(map, request, response, NormalExcelConstants.EASYPOI_EXCEL_VIEW);}
}LocalJsonUtil工具类可以直接从resources目录下获取JSON数据并转化为对象例如此处使用的members.json运行项目直接通过Swagger访问接口注意在Swagger中访问接口无法直接下载需要点击返回结果中的下载按钮才行访问地址http://localhost:8088/swagger-ui/下载完成后查看下文件一个标准的Excel文件已经被导出了。简单导入导入功能实现起来也非常简单下面以会员信息列表的导入为例。在Controller中添加会员信息导入的接口这里需要注意的是使用RequestPart注解修饰文件上传参数否则在Swagger中就没法显示上传按钮了/*** EasyPoi导入导出测试Controller* Created by macro on 2021/10/12.*/
Controller
Api(tags EasyPoiController, description EasyPoi导入导出测试)
RequestMapping(/easyPoi)
public class EasyPoiController {ApiOperation(从Excel导入会员列表)RequestMapping(value /importMemberList, method RequestMethod.POST)ResponseBodypublic CommonResult importMemberList(RequestPart(file) MultipartFile file) {ImportParams params new ImportParams();params.setTitleRows(1);params.setHeadRows(1);try {ListMember list ExcelImportUtil.importExcel(file.getInputStream(),Member.class, params);return CommonResult.success(list);} catch (Exception e) {e.printStackTrace();return CommonResult.failed(导入失败);}}
}然后在Swagger中测试接口选择之前导出的Excel文件即可导入成功后会返回解析到的数据。复杂导出当然EasyPoi也可以实现更加复杂的Excel操作比如导出一个嵌套了会员信息和商品信息的订单列表下面我们来实现下首先添加商品对象Product用于封装商品信息/*** 商品* Created by macro on 2021/10/12.*/
Data
EqualsAndHashCode(callSuper false)
public class Product {Excel(name ID, width 10)private Long id;Excel(name 商品SN, width 20)private String productSn;Excel(name 商品名称, width 20)private String name;Excel(name 商品副标题, width 30)private String subTitle;Excel(name 品牌名称, width 20)private String brandName;Excel(name 商品价格, width 10)private BigDecimal price;Excel(name 购买数量, width 10, suffix 件)private Integer count;
}然后添加订单对象Order订单和会员是一对一关系使用ExcelEntity注解表示订单和商品是一对多关系使用ExcelCollection注解表示Order就是我们需要导出的嵌套订单数据/*** 订单* Created by macro on 2021/10/12.*/
Data
EqualsAndHashCode(callSuper false)
public class Order {Excel(name ID, width 10,needMerge true)private Long id;Excel(name 订单号, width 20,needMerge true)private String orderSn;Excel(name 创建时间, width 20, format yyyy-MM-dd HH:mm:ss,needMerge true)private Date createTime;Excel(name 收货地址, width 20,needMerge true )private String receiverAddress;ExcelEntity(name 会员信息)private Member member;ExcelCollection(name 商品列表)private ListProduct productList;
}接下来在Controller中添加导出订单列表的接口由于有些会员信息我们不需要导出可以调用ExportParams中的setExclusions方法排除掉/*** EasyPoi导入导出测试Controller* Created by macro on 2021/10/12.*/
Controller
Api(tags EasyPoiController, description EasyPoi导入导出测试)
RequestMapping(/easyPoi)
public class EasyPoiController {ApiOperation(value 导出订单列表Excel)RequestMapping(value /exportOrderList, method RequestMethod.GET)public void exportOrderList(ModelMap map,HttpServletRequest request,HttpServletResponse response) {ListOrder orderList getOrderList();ExportParams params new ExportParams(订单列表, 订单列表, ExcelType.XSSF);//导出时排除一些字段params.setExclusions(new String[]{ID, 出生日期, 性别});map.put(NormalExcelConstants.DATA_LIST, orderList);map.put(NormalExcelConstants.CLASS, Order.class);map.put(NormalExcelConstants.PARAMS, params);map.put(NormalExcelConstants.FILE_NAME, orderList);PoiBaseView.render(map, request, response, NormalExcelConstants.EASYPOI_EXCEL_VIEW);}
}在Swagger中访问接口测试导出订单列表对应Excel下载完成后查看下文件EasyPoi导出复杂的Excel也是很简单的自定义处理如果你想对导出字段进行一些自定义处理EasyPoi也是支持的比如在会员信息中如果用户没有设置昵称我们添加下暂未设置信息。我们需要添加一个处理器继承默认的ExcelDataHandlerDefaultImpl类然后在exportHandler方法中实现自定义处理逻辑/*** 自定义字段处理* Created by macro on 2021/10/13.*/
public class MemberExcelDataHandler extends ExcelDataHandlerDefaultImplMember {Overridepublic Object exportHandler(Member obj, String name, Object value) {if(昵称.equals(name)){String emptyValue 暂未设置;if(valuenull){return super.exportHandler(obj,name,emptyValue);}if(value instanceof StringStrUtil.isBlank((String) value)){return super.exportHandler(obj,name,emptyValue);}}return super.exportHandler(obj, name, value);}Overridepublic Object importHandler(Member obj, String name, Object value) {return super.importHandler(obj, name, value);}
}然后修改Controller中的接口调用MemberExcelDataHandler处理器的setNeedHandlerFields设置需要自定义处理的字段并调用ExportParams的setDataHandler设置自定义处理器/*** EasyPoi导入导出测试Controller* Created by macro on 2021/10/12.*/
Controller
Api(tags EasyPoiController, description EasyPoi导入导出测试)
RequestMapping(/easyPoi)
public class EasyPoiController {ApiOperation(value 导出会员列表Excel)RequestMapping(value /exportMemberList, method RequestMethod.GET)public void exportMemberList(ModelMap map,HttpServletRequest request,HttpServletResponse response) {ListMember memberList LocalJsonUtil.getListFromJson(json/members.json, Member.class);ExportParams params new ExportParams(会员列表, 会员列表, ExcelType.XSSF);//对导出结果进行自定义处理MemberExcelDataHandler handler new MemberExcelDataHandler();handler.setNeedHandlerFields(new String[]{昵称});params.setDataHandler(handler);map.put(NormalExcelConstants.DATA_LIST, memberList);map.put(NormalExcelConstants.CLASS, Member.class);map.put(NormalExcelConstants.PARAMS, params);map.put(NormalExcelConstants.FILE_NAME, memberList);PoiBaseView.render(map, request, response, NormalExcelConstants.EASYPOI_EXCEL_VIEW);}
}再次调用导出接口我们可以发现昵称已经添加默认设置了。总结 体验了一波EasyPoi它使用注解来操作Excel的方式确实非常好用。如果你想生成更为复杂的Excel的话可以考虑下它的模板功能。参考资料 项目官网https://gitee.com/lemur/easypoi往期推荐再见 PostmanApifox 才是 YYDS再见收费的Navicat操作所有数据库靠它就够了MyBatis原生批量插入的坑与解决方案
