
Spring Boot + EasyExcel导入导出,简直太好用了!
背景
老项目主要采用的POI框架来进行Excel数据的导入和导出,但经常会出现OOM的情况,导致整个服务不可用。后续逐步转移到EasyExcel,简直不能太好用了。
EasyExcel是阿里巴巴开源插件之一,主要解决了poi框架使用复杂,sax解析模式不容易操作,数据量大起来容易OOM,解决了POI并发造成的报错。主要解决方式:通过解压文件的方式加载,一行一行地加载,并且抛弃样式字体等不重要的数据,降低内存的占用。
在之前专门写过一篇文章《EasyExcel太方便易用了,强烈推荐!》,介绍EasyExcel功能的基本使用。今天这篇文章,我们基于SpringBoot来实现一下EasyExcel的集成,更加方便大家在实践中的直接使用。
SpringBoot项目集成
依赖集成
创建一个基础的SpringBoot项目,比如这里采用SpringBoot 2.7.2版本。
EasyExcel在SpringBoot的集成非常方便,只需引入对应的pom依赖即可。在上述dependencies中添加EasyExcel的依赖:
EasyExcel目前稳定最新版本2.2.11。如果想查看开源项目或最新版本,可在GitHub上获得:https://github.com/alibaba/easyexcel。
为了方便和简化代码编写,这里同时引入了Lombok的依赖,后续代码中也会使用对应的注解。
下面正式开始业务相关代码的编写。如果你想直接获得完整源码,对照源码阅读本篇文章,可在公号「程序新视界」内回“1007”获得完整源码。
实体类实现
这里创建一个Member,会员的实体类,并在实体类中填写基础的个人信息。
为了尽量多的演示EasyExcel的相关功能,在上述实体类中使用了其常见的一些注解:
● @ExcelIgnore:忽略掉该字段;
● @ExcelProperty("用户名"):设置该列的名称为”用户名“;
● @ColumnWidth(20):设置表格列的宽度为20;
● @DateTimeFormat("yyyy-MM-dd"):按照指定的格式对日期进行格式化;
● @ExcelProperty(value = "性别", converter = GenderConverter.class):自定义内容转换器,类似枚举的实现,将“男”、“女”转换成“0”、“1”的数值。
GenderConverter转换器的代码实现如下:
不同版本中,convertToJavaData和convertToExcelData的方法参数有所不同,对应的值的获取方式也不同,大家在使用时注意对照自己的版本即可。
业务逻辑实现
为方便验证功能,DAO层的逻辑便不再实现,直接通过Service层来封装数据,先来看导出功能的业务类实现。
MemberService实现
定义MemberService接口:
定义MemberServiceImpl实现类:
其中数据采用模拟的静态数据,返回Member列表。
简单导出实现
在Controller层的实现一个简单的导出实现:
这个实现方式非常简单直接,使用EasyExcel的write方法将查询到的数据进行处理,以流的形式写出即可。
在浏览器访问对应的链接,可下载到如下Excel内容:
简单导出
如果我们需要将导出的Excel进行一些格式化的处理,这就需要用到导出策略的实现了。
自定义导入实现
在EasyExcel执行write方法之后,获得ExcelWriterBuilder类,通过该类的registerWriteHandler方法可以设置一些处理策略。
这里先实现一个通用的格式策略工具类CommonCellStyleStrategy:
该类中示例设置了Excel的基础格式。
再来实现一个精细化控制单元格内容CellWriteHandler的实现类:
在这里,对单元格表头的第0个Cell设置了一个超链接。
通过上面的定义两个策略实现,在导出Excel可以使用上述两个策略实现:
通过浏览器,访问上述接口,导出的Excel格式如下:
附带格式的Excel
可以看出,导出的Excel已经附带了具体的格式。其中表头“用户名”上也携带了对应的超链接。其他更精细化的控制,大家可以在策略类中做进一步的控制。
同步获取结果导入实现
所谓的同步获取结果导入,就是执行导入操作时,将导入内容解析封装成一个结果列表返回给业务,业务代码再对列表中的数据进行集中的处理。
先来看同步导入的实现方式。
注意,在上述代码中,最终调用的是doReadSync()方法。
这里直接用PostMan进行相应的文件上传请求:
PostMan导入
执行导入请求,会发现控制台打印出对应的解析对象:
说明上传成功,并且解析成功。
基于监听导入实现
上面示例中是基于同步获取结果列表的形式进行导入,还有一种实现方式是基于监听器的形式来实现。这种形式可以达到边解析边处理业务逻辑的效果。
定义Listener:
在MemberExcelListener中可以针对每条数据进行对应的业务逻辑处理。
对外接口实现如下:
这里采用了doRead()方法进行读取操作。在PostMan中再次上传Excel,打印日志如下:
说明解析成功,并且在解析的过程中,进行了业务逻辑的处理。
小结
本篇文章基于SpringBoot集成EasyExcel的实现展开,为大家讲解了EasyExcel在实践中的具体运用。大家可根据需要,进行变通处理。同时,基于自定义转换器、自定义策略、自定义监听器等形式达到灵活适用于各种场景。希望本篇文章能给大家带来帮助。
文章转载自公众号:程序员新视界
