学习笔记——技术调研
学习笔记——技术调研——JWT
学习笔记——技术调研——EasyExcel
学习笔记——技术调研——EasyExcel
一、EasyExcel介绍
1.1 什么是EasyExcel
EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel。
github地址:https://github.com/alibaba/easyexcel
官网地址:https://easyexcel.opensource.alibaba.com/
1.2 版本支持
- 2+ 版本支持 Java7和Java6
- 3+ 版本至少 Java8
1.3 依赖jar包版本
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.0.5</version>
</dependency>
1.4 如何使用EasyExcel,EasyExcel能做什么
通过官网我们可以看到EasyExcel,主要是对Excel进行读写填充这样的操作
对应的导入的jar包同样也有提供
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.0.5</version>
</dependency>
读Excel
具体代码参考官网上的demo
https://easyexcel.opensource.alibaba.com/docs/current/quickstart/read
总结:
1)根据excel里的内容,创建对应的实体类
2)创建对应的监听类,并且实现ReadListener接口并且需要在监听器内,invoke方法和
doAfterAllAnalysed方法,其中invoke方法当EasyExcel解析了一条数据后就会执行,
doAfterAllAnalysed方法,在所有数据都解析完成后会执行
官网提供了多种方式与Excel中的列对应上
/**
* 强制读取第三个 这里不建议 index 和 name 同时用,要么一个对象只用index,要么一个对象只用name去匹配
*/
@ExcelProperty(index = 2)
/**
* 用名字去匹配,这里需要注意,如果名字重复,会导致只有一个字段读取到数据
*/
@ExcelProperty("字符串标题")
编写监听器继承AnalysisEventListener
public class ExcelListener extends AnalysisEventListener<TbClueExcelVo> {
/**
* 每解析一行数据都要执行一次
* @param data
* @param context
*/
@Override
public void invoke(TbClueExcelVo data, AnalysisContext context) {
xxx
}
/**
* 当所有数据都解析完成后会执行
* @param context
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
xxx
}
}
写Excel
EasyExcel.write(文件名, 基于数据定义的类.class)
.sheet("写入到第几页")
.doWrite(() -> {
return 数据;
});
EasyExcel.write(fileName, DemoData.class)
.sheet("模板")
.doWrite(() -> {
// 分页查询数据
return data();
});
private List<DemoData> data() {
List<DemoData> list = ListUtils.newArrayList();
for (int i = 0; i < 10; i++) {
DemoData data = new DemoData();
data.setString("字符串" + i);
data.setDate(new Date());
data.setDoubleData(0.56);
list.add(data);
}
return list;
}
二、常见API
2.1 关于常见类解析
- EasyExcel 入口类,用于构建开始各种操作
- ExcelReaderBuilder ExcelWriterBuilder 构建出一个 ReadWorkbook WriteWorkbook,可以理解成一个excel对象,一个excel只要构建一个
- ExcelReaderSheetBuilder ExcelWriterSheetBuilder 构建出一个 ReadSheet WriteSheet对象,可以理解成excel里面的一页,每一页都要构建一个
- ReadListener 在每一行读取完毕后都会调用ReadListener来处理数据
- WriteHandler 在每一个操作包括创建单元格、创建表格等都会调用WriteHandler来处理数据
- 所有配置都是继承的,Workbook的配置会被Sheet继承,所以在用EasyExcel设置参数的时候,在EasyExcel…sheet()方法之前作用域是整个sheet,之后针对单个sheet
2.2 读
2.2.1 注解
ExcelProperty
指定当前字段对应excel中的那一列。可以根据名字或者Index去匹配。当然也可以不写,默认第一个字段就是index=0,以此类推。千万注意,要么全部不写,要么全部用index,要么全部用名字去匹配。千万别三个混着用,除非你非常了解源代码中三个混着用怎么去排序的。ExcelIgnore
默认所有字段都会和excel去匹配,加了这个注解会忽略该字段DateTimeFormat
日期转换,用String
去接收excel日期格式的数据会调用这个注解。里面的value
参照java.text.SimpleDateFormat
NumberFormat
数字转换,用String
去接收excel数字格式的数据会调用这个注解。里面的value
参照java.text.DecimalFormat
ExcelIgnoreUnannotated
默认不加ExcelProperty
的注解的都会参与读写,加了不会参与
2.2.2 参数
2.2.2.1 通用参数
ReadWorkbook
,ReadSheet
都会有的参数,如果为空,默认使用上级。
converter
转换器,默认加载了很多转换器。也可以自定义。readListener
监听器,在读取数据的过程中会不断的调用监听器。headRowNumber
需要读的表格有几行头数据。默认有一行头,也就是认为第二行开始起为数据。head
与clazz
二选一。读取文件头对应的列表,会根据列表匹配数据,建议使用class。clazz
与head
二选一。读取文件的头对应的class,也可以使用注解。如果两个都不指定,则会读取全部数据。autoTrim
字符串、表头等数据自动trimpassword
读的时候是否需要使用密码
2.2.2.2 ReadWorkbook(理解成excel对象)参数
excelType
当前excel的类型 默认会自动判断inputStream
与file
二选一。读取文件的流,如果接收到的是流就只用,不用流建议使用file
参数。因为使用了inputStream
easyexcel会帮忙创建临时文件,最终还是file
file
与inputStream
二选一。读取文件的文件。autoCloseStream
自动关闭流。readCache
默认小于5M用 内存,超过5M会使用EhCache
,这里不建议使用这个参数。useDefaultListener
@since 2.1.4
默认会加入ModelBuildEventListener
来帮忙转换成传入class
的对象,设置成false
后将不会协助转换对象,自定义的监听器会接收到Map
对象,如果还想继续接听到class
对象,请调用readListener
方法,加入自定义的beforeListener
、ModelBuildEventListener
、 自定义的afterListener
即可。
2.2.2.3 ReadSheet(就是excel的一个Sheet)参数
sheetNo
需要读取Sheet的编码,建议使用这个来指定读取哪个SheetsheetName
根据名字去匹配Sheet,excel 2003不支持根据名字去匹配
2.3 写
2.3.1 注解
ExcelProperty
index 指定写到第几列,默认根据成员变量排序。value
指定写入的名称,默认成员变量的名字,多个value
可以参照快速开始中的复杂头ExcelIgnore
默认所有字段都会写入excel,这个注解会忽略这个字段DateTimeFormat
日期转换,将Date
写到excel会调用这个注解。里面的value
参照java.text.SimpleDateFormat
NumberFormat
数字转换,用Number
写excel会调用这个注解。里面的value
参照java.text.DecimalFormat
ExcelIgnoreUnannotated
默认不加ExcelProperty
的注解的都会参与读写,加了不会参与
2.3.2 参数
2.3.2.1 通用参数
WriteWorkbook
,WriteSheet
,WriteTable
都会有的参数,如果为空,默认使用上级。
-
converter
转换器,默认加载了很多转换器。也可以自定义。 -
writeHandler
写的处理器。可以实现WorkbookWriteHandler
,SheetWriteHandler
,RowWriteHandler
,CellWriteHandler
,在写入excel的不同阶段会调用 -
relativeHeadRowIndex
距离多少行后开始。也就是开头空几行 -
needHead
是否导出头 -
head
与clazz
二选一。写入文件的头列表,建议使用class。 -
clazz
与head
二选一。写入文件的头对应的class,也可以使用注解。 -
autoTrim
字符串、表头等数据自动trim
2.3.2.2 WriteWorkbook(理解成excel对象)参数
-
excelType
当前excel的类型 默认xlsx
-
outputStream
与file
二选一。写入文件的流 -
file
与outputStream
二选一。写入的文件 -
templateInputStream
模板的文件流 -
templateFile
模板文件 -
autoCloseStream
自动关闭流。 -
password
写的时候是否需要使用密码 -
useDefaultStyle
写的时候是否是使用默认头
2.3.2.3 WriteSheet(就是excel的一个Sheet)参数
-
sheetNo
需要写入的编码。默认0 -
sheetName
需要些的Sheet名称,默认同sheetNo
2.3.2.4 WriteTable(就把excel的一个Sheet,一块区域看一个table)参数
tableNo
需要写入的编码。默认0