项目地址:https://github.com/PiKeZhao/excel-model.git
如果您对该项目有什么问题加群咨询哦978219630(各类电子书籍,学习视频等)
大家常用 Apache POI 的 HSSF(.xsl后缀),XSSF(.xlsl后缀)功能来实现 Excel的读取和写入。今天我们介绍一款超级简单的Excel处理工具,EasyExcel,首先看一下官网介绍:
Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存,poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题,但POI还是有一些缺陷,比如07版Excel解压缩以及解压后存储都是在内存中完成的,内存消耗依然很大。easyexcel重写了poi对07版Excel的解析,能够原本一个3M的excel用POI sax依然需要100M左右内存降低到几M,并且再大的excel不会出现内存溢出,03版依赖POI的sax模式。在上层做了模型转换的封装,让使用者更加简单方便
EasyExcel对POI进行了优化改进,让我们操作Excel更加的方便,话不多说直接交大家如何使用:
案例项目是基于spring-boot的
一。项目构建
我们使用spring官网快速构建项目工具构建spring-boot项目,https://start.spring.io。填写上对应的GROUPID,ARTIFACT,如果对于maven的这两个属性不知道的同学自行百度。
配置完成后,点击生成按钮,项目会通过浏览器自动下载,好了我们得到我们初版springboot项目了,接下来我们需要配置一下logback以及application
![4b226004d3df7a4400b4d5779aae2f1f.png](https://i-blog.csdnimg.cn/blog_migrate/db3f5a52fb1b88576f2fd7af0f02cd7d.jpeg)
application中我只是简单的配置了端口和文件上传大小限制,thymeleaf.cache=false是为了开发方便,热部署默认使用了springboot自带的thymeleaf作为前端模板。logback配置比较复杂,同学们按照自己的实际情况去配置,下图是我在本项目的配置,太长了只是截图一小段(这个配置是引用了其他同学的,当然我也有改动)
![c3db6c2fdc603d3dd28703a2b6e72b60.png](https://i-blog.csdnimg.cn/blog_migrate/9b12bbb31969732513642251962fc6f9.jpeg)
二。依赖引入
- 阿里的fastjson
- logback包logback-classic
- lombok
- 阿里的easyexcel
- spring boot依赖(spring-boot-starter,spring-boot-starter-web,spring-boot-starter-thymeleaf,spring-boot-devtools)
具体请看项目中的pom
三。功能实现
本demo项目同时实现了poi和easyExcel对Excel的读写功能。但是我们只讲解easyExcel的使用。
一。Excel读取实现(同时支持03和07)
- 我们需要构建一个DataListener继承AnalysisEventListener来处理读取到的内容,我们重写父类的两个重要的方法 invoke 和 doAfterAllAnalysed。
- invoke方法是每读取到一条数据都会进行回调
- doAfterAllAnalysed是当Excel读取完成之后回调
- 当然我们可以点开AnalysisEventListener源码看一下,发现他也是继承ReadListener接口,接口方法有5个,分别是 onException异常回调,invokeHead 标题读取回调,invoke数据读取回调,doAfterAllAnalysed所有读取完成之后回调,hasNext是否有下一条,有需要的同学可自行在实现类中重写这几个方法。
- 构建一个数据实体类,DemoData,注意类中属性的顺序一定要和Excel中列的属性一致,不然可能导致数据错乱,在实体类中我们可以自定义类型,特殊数据处理,导出标题等。此案例中只是设置了导出标题属性,如果想要其他设置同学们也可以自行到easyExcel官网查看文档
- 上述准备工作都做完之后我们需要来启动easyExcel。在controller端我们使用MultipartFile接收到文件流,EasyExcel.read(inputStream,DemoData.class,demoDataListener).sheet().doRead();开始调用读取,说下入参,inputStream:文件流;DemoData.class实体类,demoDataListener监听类,也可以说是数据处理类。
二。Excel写入实现
- ExcelController对应的是export方法。我们先说一下思路:
- 前端页面有个按钮选择了某个模板后点击导出Excel,这时我们需要根据选择的模板将数据查询出来并且组装到对应的实体类中
- 我们需要生成一个临时的Excel文件,当所有写入成功之后,需要返回给调用方一个inputStream,或者临时文件的路径(这里要考虑临时文件清理)
- controller将输入流copy到out流中返回给浏览器进行下载。
- 标题数据通过实体类中使用@ExcelProperty()注解实现或者自定义返回List数据主动调用.head方法设置标题
- 数据组装方法,将所需要写入的数据初始化到实体类中返回List集合调用.doWrite方法
- EasyExcel.write(fileName, DemoData.class).sheet("模板").doWrite(WebUtil.data());开始写入,说下入参,fileName 是我存放临时文件的路径, DemoData.classs实体类,.sheet("模板")默认构造一个sheet名字叫模板,WebUtil.data()数据组装方法返回List>。当读取完成之后返回给调用端临时文件目录。
我只是简单的描述了一下easyExcel的使用过程和思路,还有很多复杂的场景并没有说明,比如复杂头写入,导出样式设置等等,如果有需要我会发第二版来详细讲解,源码导读。文档有配置demo项目,项目我已经上传到github了大家可以自行下载:https://github.com/PiKeZhao/excel-model.git,这里说一下项目结构,如图:
![8cfaa0e77b525aa374da0ff3c47c250e.png](https://i-blog.csdnimg.cn/blog_migrate/9fac58e22a505e49155321cc152b3d56.jpeg)
easyExcel实现
![0f491e775184aabd41a7c64f65ef705c.png](https://i-blog.csdnimg.cn/blog_migrate/3465eb8c4e76985541c23cde68ae5c3e.jpeg)
poi导入导出实现
![0017267ef2562e0004339daa9f81fcd8.png](https://i-blog.csdnimg.cn/blog_migrate/fe5b4717ca34075ae8b0f1c650d5cb2e.jpeg)
Excel文件
![ea91d5f3ffd00bfb500fc5c256737486.png](https://i-blog.csdnimg.cn/blog_migrate/bf910ce7b28a6eaab77e910aeb3b4122.jpeg)