EasyExcel01 - 核心api
本文整理自掘金大佬 - 竹子爱熊猫
https://juejin.cn/post/7405158045662576640
文章目录
- EasyExcel01 - 核心api
- 一:初相识EasyExcel
- 1:写入excel入门
- 2:读取Excel入门
- 二:数据模型注解
- 1:读写通用注解
- 1.1:@ExcelProperty注解
- 1.2:@ExcelIgnore注解
- 1.3:@ExcelIgnoreUnannotated注解
- 1.4:@DateTimeFormat注解
- 1.5:@NumberFormat注解
- 2:生成注解
- 2.1:@ColumnWidth注解
- 2.2:@ContentFontStyle注解
- 2.3:其他注解
- 三:核心API全解
- 1:EasyExcel入口类
- 2:读对象
- 2.1:ExcelReaderBuilder
- 2.2:ExcelReaderSheetBuilder
- 2.3:ReadListener
- 3:写对象
- 3.1:ExcelWriterBuilder
- 3.2:ExcelWriterSheetBuilder
- 3.3:ExcelWriterTableBuilder
- 3.4:WriteHandler
- 4:导入导出接口
一:初相识EasyExcel
EasyExcel
是一个高效、低内存占用的Excel
处理框架,提供了简洁易用的API
接口,使得我们能更加高效、灵活的处理Excel
文件
当然,EasyExcel
并非一个完全从零构建的开源项目,而是阿里巴巴在POI
的基础上做了进一步封装
下面内容来自easyExcel官网:
POI
也好,JXL
也罢,它们都存在一个严重的问题就是非常的耗内存,尽管POI
提供了一套SAX
模型能在一定程度上解决OOM
问题,但它仍然存在一些缺陷,对内存消耗依旧较大。因此,
EasyExcel
重写了POI
对07
版Excel
文件的解析,一个3MB
的文件用原生的POI-SAX
去解析,需要消耗100MB
左右的内存,改用EasyExcel
可以降低到几MB,并且再大的文件也不会出现内存溢出;03
版依赖POI-SAX
模式,也在上层做了模型转换的封装,让使用者更加简单方便。
一个75MB
的Excel
文件,每行数据二十五列,总计46W
条数据,能够在23
秒解析、读取完成,并且仅消耗了16MB
内存,这个结果无疑是惊人的!
同时,如果内存足够充裕,还可以开启急速模式换取更快的处理性能。
当然,这个数据来源于实验环境,在硬件配置较差、或读取数据后还需要清洗、落库等情况下,性能上会有所差异。但是不管怎么说,在资源占用、性能方面都完胜POI
原生的处理方式
对EasyExcel
有了基本认知后,下面来一起快速上手实操一下,首先咱们需要导入下相关依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>4.0.2</version>
</dependency>
这里我们可以使用最新的4.0.2
版本,也可以选择之前的稳定版本,3.1.x
以后的版本API
大致相同,新的版本也会向前兼容(3.1.x
之前的版本,部分API
可能在高版本被废弃)
关于POI、JDK
版本适配问题
1:写入excel入门
package com.example.bootrocketmq.study.wheel.easyexcel;
import lombok.*;
import java.util.Date;
/**
* @author cui haida
* 2024/12/21
*/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
private Long id; // 主键id
private String name; // 姓名
private String sex; // 性别
private String hobby; // 爱好
private Date birthday; // 生日
}
假设有一个Person
集合,目前想把其中的数据,生成并写入到Excel
文件该怎么做?十分简单
package com.example.bootrocketmq.study.wheel.easyexcel;
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.write.builder.ExcelWriterBuilder;
import com.alibaba.excel.write.builder.ExcelWriterSheetBuilder;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
/**
* @author cui haida
* 2024/12/21
*/
public class SimpleWriteDemo {
private static void writeDemo() {
List<Person> personList = new ArrayList<>();
Person person = new Person(1L, "cuihaida", "男", "打游戏", new Date());
Person person2 = new Person(2L, "cuihaida2", "女", "打游戏2", new Date());
personList.add(person);
personList.add(person2);
// 可以写绝对路径
String fileName = "person数据-" + System.currentTimeMillis() + ".xlsx";
// 创建ExcelWriterBuilder, 默认创建内存模式,通过write方式指定文件名和实体类。
ExcelWriterBuilder write = EasyExcel.write(fileName, Person.class);
// 创建ExcelWriterSheetBuilder,默认创建第一个sheet,通过sheet方式指定sheet名
ExcelWriterSheetBuilder sheet = write.sheet("person列表");
// 通过dowrite(list)的方式写入到excel中
sheet.doWrite(personList);
write.autoCloseStream(true);
System.out.println("写入成功");
}
public static void main(String[] args) {
writeDemo();
}
}
2:读取Excel入门
看完写入操作后,下面来看看如何读取Excel
文件里的数据,咱们就以前面生成的文件作为解析目标,首先需要定义一个监听器
package com.example.bootrocketmq.study.wheel.easyexcel;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import java.util.ArrayList;
import java.util.List;
/**
* @author cui haida
* 2024/12/22
*/
public class PersonListener extends AnalysisEventListener<Person> {
// 一会读出来的数据都放在这里
private final List<Person> data = new ArrayList<>();
/**
* 读excel一行一行的读, 每次都会调用这个invoke方法
* @param person person实体数据
* @param analysisContext 上下文对象
*/
@Override
public void invoke(Person person, AnalysisContext analysisContext) {
System.out.println("每读取到一行,都会触发这个函数,读取到的内容是: " + person.toString());
// 加入到结果中
data.add(person);
}
/**
* 读取完所有数据后调用这个方法
* @param analysisContext 上下文对象
*/
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
System.out.println("读取完毕,一共读取了" + analysisContext.readSheetHolder().getTotal() + "行");
}
/**
* 获取读取的数据
* @return 数据
*/
public List<Person> getData() {
return data;
}
}
这个监听器很简单,无非就是将每条读取到的数据添加到data
集合里,然后对外提供了一个获取数据的方法
其实这个监听器不定义也可以,因为EasyExcel
有默认的监听器
package com.example.bootrocketmq.study.wheel.easyexcel;
import com.alibaba.excel.EasyExcel;
import java.util.List;
/**
* @author cui haida
* 2024/12/22
*/
public class SimpleReadDemo {
public static void main(String[] args) {
String fileName = "person数据-1734779595717.xlsx";
PersonListener listener = new PersonListener();
// 读取excel的内容,要转化成的对象(Person.class), 监听器(PersonListener)
EasyExcel.read(fileName, Person.class, listener).sheet().doRead();
List<Person> data = listener.getData();
System.out.println(data);
}
}
二:数据模型注解
从上面可以发现,不管是读取文件还是写入文件,都需要传递一个具体的class
这个类叫做数据模型类,主要是用来映射Java对象和excel列的匹配关系的。【java对象 - excel列】
为了更好的满足各种报表需求,easyExcel提供了各种注解进行辅助,主要有两大类
1:读写通用注解
通用注解是指在类、字段上添加后,对于读写场景都会生效的注解,而这些通用注解也是最常用的
1.1:@ExcelProperty注解
@ExcelProperty
注解在读取用于映射excel表头,在写入时用于控制生成的excel表头
作用范围:数据实体类的字段上
注解释义:用于映射excel列和实体字段的匹配关系
可选参数:(注意优先级 -> index > order > value)
参数 | 说明 |
---|---|
value | 以列名形式匹配excel列,多行头会匹配最后一行 |
order | 以权重形式匹配excel列,值越小越靠前,优先级高于value |
index | 以索引形式匹配excel列,优先级高于order & value |
converter | 数据格式转换器,解析时会根据指定的转换器处理对应数据 |
该注解是EasyExcel
中最重要的注解,它提供了列名、权重、索引三种列匹配模式
不过在解析excel
文件时,官方只建议同时使用一种,因为就算指定了多种,它们也会有优先级关系,大可不必多此一举。
在写入的场景中,确实常常将index,value一起使用 -> value用于控制列名称,index用于控制列的顺序。
@ExcelProperty(value="姓名", index=1)
private String name;
这代表name
字段在excel
文件的列名为“姓名”,位于表格的第二列(B
列)
1.2:@ExcelIgnore注解
作用范围:数据实体类的字段上
注解释义:当前字段不参与excel的匹配,即处理时候忽略这个字段。
@ExcelIgnore
private String name; // name字段不参与excel列的映射匹配
1.3:@ExcelIgnoreUnannotated注解
作用范围:数据模型类上
注解释义:匹配列时忽略所有未使用@ExcelProperty
注解的字段
如果类中许多字段都不想参与excel
读写,而你又嫌挨个加@ExcelIgnore
注解麻烦,这时就可以直接在类上加一个@ExcelIgnoreUnannotated
注解,以此来忽略所有未添加@ExcelProperty
注解的字段
1.4:@DateTimeFormat注解
作用范围:数据实体类的字段上
注解释义:用String
接收日期数据时,会根据指定格式转换日期
可选参数:
参数 | 说明 |
---|---|
value | 日期数据转换为字符串的目标格式 |
use1904windowing | excel日期数据默认从1900 年开始,但有些会从1904 开始 |
在解析excel
文件时,如果使用String
字段接收日期数据,就会根据指定的格式转换数据,格式可以参考java.text.SimpleDateFormat
的写法,例如yyyy-MM-dd HH:mm:ss
。
而在往excel
写数据时,如果Java中的字段类型为Date、LocalDate、LocalDateTime
等日期类型,则会将日期数据转换为指定的格式写入对应列
1.5:@NumberFormat注解
作用范围:数据实体类的字段上
注解释义:用String接受数据类型时,会根据指定格式转换数值
可选参数:
参数 | 说明 |
---|---|
value | 数值转成字符串的目标格式 |
roundingMode | 数值格式化时的舍入模式,如四舍五入、向上取整等 |
这个注解和前一个注解类似,只不过是用于将非整数类型的数值数据转换成给定格式,格式可以参考java.text.DecimalFormat
的写法,如#.##
。
除了可以指定格式外,还可以指定舍入模式,枚举可参考java.math.RoundingMode
类
2:生成注解
2.1:@ColumnWidth注解
作用范围:数据模型类上、字段上
注解释义:设置列的宽度
这个注解如果加在类上,则会对所有字段生效;如果单独加在某个字段上,则只对特定的列有效,单位是px
2.2:@ContentFontStyle注解
作用范围:数据模型类上、字段上
注解释义:用于设置单元格内容字体格式的注解
可选参数:
参数 | 说明 |
---|---|
fontName | 字体名称,如“黑体、宋体、Arial”等 |
fontHeightInPoints | 字体高度,以磅为单位 |
italic | 是否设置斜体(字体倾斜) |
strikeout | 是否设置删除线 |
color | 字体的颜色,通过RGB 值来设置 |
typeOffset | 偏移量,用于调整字体的位置 |
underline | 是否添加下划线 |
bold | 是否对字体加粗 |
charset | 设置编码格式,只能对全局生效(字段上设置无效) |
这个注解用于设置主体内容的字体样式(不包含表头),与上个注解同理,加在类上对整个excel
文件生效,加在字段上只对单列有效,可以通过该注解来设置字体风格、高度、是否斜体等属性
2.3:其他注解
- @HeadFontStyle注解 -> 用于定制标题字体格式
- @HeadRowHeight注解 -> 用于设置标题行的行高
- @HeadStyle注解 -> 用于设置标题样式
- @OnceAbsoluteMerge注解 -> 用于合并指定的单元格
- @ContentLoopMerge注解 -> 用于合并单元格
三:核心API全解
1:EasyExcel入口类
基于一开始的简单读写案例,会发现所有excel
相关的动作都始于EasyExcel
这个类,而这个类也被称为入口类,主要用来构建各种excel
操作的实例(如读、写)。
public class EasyExcel extends EasyExcelFactory {
public EasyExcel() {
}
}
可以发现这是一个空的实现,EasyExcel
类直接继承了EasyExcelFactory
,拥有的所有API
底层也由EasyExcelFactory
提供,所以,我们直接分析EasyExcelFactory
即可:
// 基于给定的文件、数据模型类,构建一个Excel写入对象
public static ExcelWriterBuilder write(File file, Class head)
// 基于给定的流、数据模型类,构建一个Excel写入对象
public static ExcelWriterBuilder write(OutputStream outputStream, Class head)
// 基于给定的sheet号、sheet名称,构建一个Sheet写入对象
public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo, String sheetName)
// 基于给定的表格号,构建一个Table写入对象
public static ExcelWriterTableBuilder writerTable(Integer tableNo)
// 基于给定的文件、数据模型类,构建一个Excel读取对象
public static ExcelReaderBuilder read(File file, ReadListener readListener)
// 基于给定的文件、数据模型类,构建一个Excel读取对象
public static ExcelReaderBuilder read(InputStream inputStream, ReadListener readListener)
// 基于给定的sheet号、sheet名称,构建一个Sheet读取对象
public static ExcelReaderSheetBuilder readSheet(Integer sheetNo, String sheetName)
对于重复的方法不在说明,上面列出的是EasyExcelFactory
类中的核心方法,其作用主要是构建读、写excel
文件的对象,以便于后续读取、写入excel
数据
简单了解这个入口类后,下面来看看这些构建出的读写对象
2:读对象
EasyExcel
中,与读取数据相关的核心类主要有三个:ExcelReaderBuilder、ExcelReaderSheetBuilder、ReadListener
2.1:ExcelReaderBuilder
ExcelReaderBuilder
只是为了满足链式调用封装出的Builder
类,其内部会构建一个读取工作簿的ReadWorkbook
对象,这就相当于你在实体类上加了个@Builder
注解
所谓的工作簿,可以简单理解成一个Excel
文件,下面看看它的API
:
API | 参数说明 |
---|---|
converter | 数据转换器,默认内置了很多,如果读取的数据需要特定转换,则可以按需添加 |
registerReadListener | 注册监听器,读取数据时会触发已注册的监听器 |
headRowNumber | 文件中头的行数,默认为1,文件的列头是多行时设置 |
head | excel数据的表头列表(以字符串列表形式指定),官方建议使用模型类的方式 |
clazz | 与excel数据映射的模型类,与head 二选一,都未指定时会用Map 读取所有数据 |
use1904windowing | 日期格式是否以1904 年开始,兼容特殊的excel 文件 |
useScuentificFormat | 数字转文本的时候在较大的数值的是否是否采用科学计数法 |
autoTrim | 是否开启自动去除前后空格,开启后会对读到的头信息、数据去空格 |
上述这些参数,也是ExcelReaderSheetBuilder
对象具备的通用属性
下面是独特参数:
excelType
:指定要读取的excel
文件类型,支持XLS、XLSX、CSV
;inputStream
:指定读取数据的文件流,底层会创建临时文件来转换数据;file
:要读取数据的目标文件,与inputStream
二选一;mandatoryUseInputStream
:强制从流中读数据(不会创建临时文件,性能会变差);charset
:设置文件内容编码格式,读取CSV
文件时有效,默认UTF-8
;autoCloseStream
:读取完毕后是否自动关闭读取的流(默认开启);readCache
:设置读取数据的缓存配置(默认5M
内使用内存,其余使用EhCache
);readCacheSelector
:设置什么时候使用内存、什么时候使用磁盘来存储缓存数据;ignoreEmptyRow
:读取数据行时,是否忽略所有字段为空的行,默认开启;password
:读取excel
文件的密码(文件加密时使用);xlsxSAXParserFactoryName
:指定POI-SAX
模式读取使用的实现类;useDefaultListener
:是否使用默认监听器来将excel
数据行转换为Java对象;extraReadSet
:接收额外需要读取内容的set
,如评论、超链接、合并单元的内容;readDefaultReturn
:对于excel中不点击单元格看不到的内容数据、接收时的格式;
了解这些参数后,我们在读取Excel
文件时如何设置呢?先来看看最开始读取文件的代码:
EasyExcel.read(fileName, ZhuZi.class, zhuZiListener).sheet().doRead();
这行代码中,EasyExcel.read()
方法执行后,会返回一个ExcelReaderBuilder
对象
执行sheet()
方法后会返回一个ExcelReaderSheetBuilder
对象
而最后的doRead()
方法则是触发真正解析excel
、读取数据的步骤
既然如此,那么我们在调用EasyExcel.read()
方法后、sheet()
方法前,就可以继续调用上面提到的一系列方法设置参数,例如:
EasyExcel.read(fileName, ZhuZi.class, zhuZiListener)
.excelType(ExcelTypeEnum.CSV) // 通过excelType()将读取目标的格式切换成了.csv文件
.sheet().doRead();
2.2:ExcelReaderSheetBuilder
与ExcelReaderBuilder
对象一样,ExcelReaderSheetBuilder
内部维护着一个ReadSheet
对象,Builder
类单纯用于满足链式调用的编程风格。
接触过Excel
的小伙伴应该都知道一点,一个Excel
文件内部可以维护多个Sheet
(工作表单),而ReadSheet
就是专门用来读取表单数据的类,前面在聊ExcelReaderBuilder
类时提到的公用参数,ReadSheet
也同样具备,那么相同的参数作用在不同的对象上,区别是什么?
很简单,如果针对整个工作簿设置的参数,会对所有Sheet
生效;单独针对ReadSheet
设置的参数,则只针对特定的表单有效。
如果一个文件的不同Sheet
数据格式不一样,就可以基于这种特性来实现不同的解析逻辑。那么下面来看看ReadSheet
独有的参数:
sheetNo
:指定需要读取数据的目标Sheet
编码(默认为0,表示读第一个);sheetName
:根据表单名字去匹配要读取数据的目标Sheet
。
是的,你没有看错,ReadSheet
的独立参数就这两个,如果你在创建表单读取对象时就已经指定了编号、名称,那么这两个参数甚至也用不到。好了,那如何针对不同Sheet
设置参数呢?
大家还记得ReadSheet
对象是在何时创建的吗?当调用.sheet()
方法后创建的,所以为Sheet
设置参数很简单
EasyExcel.read(fileName, ZhuZi.class, zhuZiListener)
.sheet(1)
.headRowNumber(2) // 表示从第二个Sheet中读取数据,而这个表单里的表头是两行,即:从第三行才正式开始读取数据
.doRead();
2.3:ReadListener
读取监听器,EasyExcel
框架中的监听器体系结构如下:
Listener
:内部为空实现,仅抽象为顶层接口,用于维护体系结构及拓展性;ReadListener
:读取监听器的顶层接口,读取excel
文件时会被触发;IgnoreExceptionReadListener
:读取时发生异常会触发的监听器,可以在这里处理异常确保读取不会终止;AnalysisEventListener
:解析事件监听器,每当读取到一行数据,都会触发该类或子类的invoke()
方法;PageReadListener
:分页读取监听器,当读取的数据量达到指定的数量会被触发,处理完一页后才会读下页数据;ModelBuildEventListener
:默认装载的监听器,用于在解析到excel
数据行时,将数据转换为指定类对象;SyncReadListener
:解析事件监听器的子类,默认会将所有数据行添加到一个Object
集合(使用小数据场景);ZhuZiListener
:自定义的监听器,继承自解析事件监听器,内部带有自定义的业务逻辑
在调用EasyExcel.read()
方法时,传递的第三个入参就是监听器
或者可以通过registerReadListener()
来注册,不过有一点要注意:同一个工作簿或表单读取对象,可以同时注册多个监听器。
这就有点类似于Filter
过滤器链一样,而EasyExcel
存在多个监听器时,会根据添加的顺序来触发。
上面列出的一堆监听器,重点关注AnalysisEventListener
即可,因为在实现导入的业务时,通常会继承它来自定义处理业务数据的逻辑,比如可以在invoke()
方法里实现数据校验、落库等逻辑。
3:写对象
关于Excel
数据写入的核心类,主要ExcelWriterBuilder、ExcelWriterSheetBuilder、ExcelWriterTableBuilder、WriterHandler
这四个
3.1:ExcelWriterBuilder
ExcelWriterBuilder
代表一个写入工作簿对象,也就是调用EasyExcel.writer()
方法返回的对象,内部维护着一个WriteWorkbook
对象,它支持设置的参数列表如下:
converter
:数据转换器,如果读取的数据需要特定转换,则可以按需添加;head
:excel数据的表头列表(以字符串列表形式指定);clazz
:与excel数据映射的模型类,与head
二选一;autoTrim
:是否开启自动去除前后空格,开启后写入数据前会对数据去空格;use1904windowing
:日期格式是否以1904
年开始,兼容特殊的excel
文件;useScientificFormat
:数字转文本的时候在较大的数值的是否是否采用科学计数法;
上面这些是ExcelReaderBuilder
类中也存在通用参数,甚至作用都是一模一样的
registerWriteHandler
:注册写入处理器,总共有工作簿、表单、数据行、单元格四个级别;relativeHeadRowIndex
:写入到excel
时,和顶部间隔几行,默认为0
;needHead
:是否需要生成数据表头(列头),默认开启;useDefaultStyle
:是否使用默认的样式(即简单写入案例中那个样式);automaticMergeHead
:是否开启自动合并头,头中相同的字段名,上下左右都会尝试合并;excludeColumnIndexes
:写入数据时,数据模型类中要忽略的字段下标;excludeColumnFieldNames
:写入数据时,数据模型类中要忽略的字段名称;includeColumnIndexes
:写入数据时,只需要导出的字段下标;includeColumnFieldNames
:写入数据时,只需要导出的字段名称;orderByIncludeColumn
:是否开启字段排序,默认不开启(根据类字段或指定head排序);filedCacheLocation
:数据模型的字段缓存模式,默认为ThreadLocal
,可以改为纯内存或不缓存。
上述参数是当前对象、WriterSheet、WriterTable
三者皆备的通用参数
再来看看ExcelWriterBuilder
的专属参数:
excelType
:写出的excel
文件类型;charset
:写出的数据编码格式(仅CSV
支持);password
:为生成的文件设置查看密码;autoCloseStream
:写入完成后是否自动关闭流,默认开启;file
:数据要写入的目标文件;outputStream
:数据要写入的目标流;templateFile
:模板文件(填充场景使用);templateInputStream
:模板文件流(填充场景使用);inMemory
:是否基于内存生成文件,默认不开启,会生成临时文件;writeExcelOnException
:写入过程抛出异常时,是否尝试把已有数据写入excel,默认关闭。
这些参数在写入excel
时怎么设置呢?同样先来看最开始的写入案例:
EasyExcel.write(fileName, ZhuZi.class).sheet("竹子数据").doWrite(zhuZis);
- 调用
EasyExcel.write()
方法后会得到一个ExcelWriterBuilder
对象 - 而执行
sheet()
后会返回一个ExcelWriterSheetBuilder
对象 - 最后的
doWrite()
方法代表真正触发数据写入逻辑。
为此,想要设置这些参数,只要在.write()
方法之后、.sheet()
方法之前调用对应方法即可
3.2:ExcelWriterSheetBuilder
ExcelWriterSheetBuilder
内部维护着一个WriteSheet
对象,代表表单写入对象,和表单读取对象类似
与上一个对象的唯一区别就在于:可以针对某一个具体sheet
去设置参数,而WriteSheet
具备的独立参数也就俩:
sheetNo
:将数据写入指定编码的Sheet
表单(默认为0);sheetName
:将数据写入到指定名字的表单中。
如果要为单独某一个表单设置参数,则只需要在调用了sheet()
方法之后、调用doWrite()
方法之前设置即可
3.3:ExcelWriterTableBuilder
与读取Excel
时不同,写入时多了一个WriterTable
类
这个类的作用是:按表格形式写入数据到Excel文件中,即:可以向一个表单里面写入多个数据表格,
而表格的专属参数只有一个,即:
tableNo
:需要写入的表格编码,默认值为0;
如果只往sheet
写入一个表格,这时就算把tableNo
设置成999
都没用。
只有当一个sheet
里写入多个表格时,就可以通过这个编号来控制先后顺序
而表格之间可以通过relativeHeadRowIndex
这个通用参数来控制间隔。
3.4:WriteHandler
写入处理器WriteHandler
,是EasyExcel
框架在生成excel
时非常重要的组件,它可以在写入过程中执行各种自定义的操作,比如自定义单元格样式、自定义合并单元格、数据行等。
因为框架内部实现了非常多的子类,所以整个WriteHandler
体系比读取监听器大上很多,光WriteHandler
就有二十多个子类,但其中很多我们用不到,因此就不一一做分析了,这里介绍几个较为重要的子类:
CellWriteHandler
:单元格写入处理器,每写入一个单元格时会被触发;RowWriteHandler
:数据行写入处理器,每写入一行数据时会被触发;SheetWriteHandler
:表单写入处理器,每写入一个表单时会被触发;WorkbookWriteHandler
:工作簿写入处理器,写入一个excel
文件时被触发;......
其实上面列出的四个类依旧是接口,大家可以根据具体的需求选择性实现,你可以在实现类里精准控制每个单元格的样式、更改内容、合并等,最后将其注册到对应的工作簿、表单写入对象上就能生效
4:导入导出接口
想要实现导入导出接口,关键点就在于如何从网络请求中读取Excel
数据,以及如何将生成的excel
文件返回
其实这个很简单,回想下前面读写核心类的参数,是不是支持通过流来指定要读取/写入的目标?
因此,我们可以基于输入/输出流来实现:
@RestController
@RequestMapping("/excel")
public class SimpleExcelController {
/*
* Excel导入接口(要解析的目标文件传入file字段)
* */
@PostMapping("/import")
public void excelImport(MultipartFile file) {
if (null == file) {
throw new RuntimeException("哎呀,网络出小差啦……");
}
ZhuZiListener listener = new ZhuZiListener();
try {
// 从上传的文件中获取流,并基于流读取excel文件的数据
EasyExcel.read(file.getInputStream(), ZhuZi.class, listener).sheet().doRead();
} catch (IOException e) {
throw new RuntimeException("Excel文件解析失败,请稍后重试~");
}
// 这里会获取到excel里的所有数据行,可以基于该数据进行校验、落库等业务操作
List<ZhuZi> excelData = listener.getData();
}
/*
* Excel导出接口(需要将response作为参数注入)
* */
@GetMapping("/export")
public void excelExport(HttpServletResponse response) {
// 内容类型也可以设置成application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
String fileName = "竹子数据-" + System.currentTimeMillis() + ".xlsx";
try {
// 防止中文乱码,使用URLEncoder重新编码
fileName = URLEncoder.encode(fileName, "UTF-8").replaceAll("\\+", "%20");
} catch (UnsupportedEncodingException e) {
throw new RuntimeException("Excel导出失败,请稍后重试");
}
response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName);
// 这里模拟从库里读取的集合数据
List<ZhuZi> zhuZis = new ArrayList<>();
ZhuZi zhuZi = new ZhuZi(1L, "竹子", "男", "熊猫", new Date());
zhuZis.add(zhuZi);
try {
// 这里指定excel数据的输出目标为响应流
EasyExcel.write(response.getOutputStream(), ZhuZi.class).sheet().doWrite(zhuZis);
} catch (IOException e) {
throw new RuntimeException("Excel导出失败,请稍后重试");
}
}
}
基于EasyExcel
来实现导入、导出格外简单,导入时,只需要通过MultipartFile
对象来接收excel
文件,然后从它的流中读取数据解析即可。
当然,如果你想对excel
表里的数据进行业务处理,可以选择在数据导入完成后,也可以直接在自定义的Listener
监听器类中,读到一条数据就处理一次。
再来看导出接口,这里会基于response
对象来实现,首先会将响应的数据声明为Excel
文件,等待EasyExcel
生成数据后,就会通过的OutputStream
输出流返回给调用方。
只不过要注意,如果文件名是中文,则需要在内部先做UTF-8
编码,否则调用方得到的文件名称就会乱码。