EasyExcel 框架使用-读
EasyExcel 框架使用
官方介绍：JAVA解析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 版本
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>2.2.9</version>
</dependency>
在EasyExcel 使用之前先要讲一下EasyExcel 的Listener
Listener 里有处理每一条数据的方法
ReadListener源码：
public interface ReadListener<T> extends Listener {
// 当解析抛出异常，会被此方法进行捕获
void onException(Exception exception, AnalysisContext context) throws Exception;
// 解析表数据的表头，headMap 默认表格第一行数据
void invokeHead(Map<Integer, CellData> headMap, AnalysisContext context);
// 讲一条数据解析后的对象 data，可以在这个方法中进行再次处理
void invoke(T data, AnalysisContext context);
// 官方介绍：返回额外信息调用，没使用过
void extra(CellExtra extra, AnalysisContext context);
// 解析完成后，会运行此方法
void doAfterAllAnalysed(AnalysisContext context);
// 校验是否继续解析，默认true
boolean hasNext(AnalysisContext context);
}
这个方法会有一个传入的泛型，就是将表格每一行数据解析成的对象
举个例子：如果我们就想转换成List
我们就可以转换了，当然官方有一个默认List
但是你想获取解析表格的数据最好自己重写AnalysisEventListener，这样你能把我数据的处理流程
EasyExcel 使用
读数据
EasyExcel 读数据有许多不同的方法，我们使用NoModelDataListener来看一下可以怎么解析表格数据
public void test() {
// file 可以是文件，可以是流，也可以是文件路径 但必须是.xsl或.xslx文件
File file = new File("");
// 读取读取传入excel文件中某一张表的数据
// 第一种：sheet() 默认(不传参数)为第一种表
// sheetNo 也可以指定第几张表，表以0开始计数
// sheetName 也可以指定表名
// 读取成功后文件流会自动关闭
EasyExcel.read(file,new NoModelDataListener()).sheet(0,"").doRead();
// 第一种：sheet() 默认为第一张表，也可以指定第几张表，表以0开始计数
ExcelReader reader = EasyExcel.read(file, new NoModelDataListener()).build();
// 第一种：readSheet() 默认(不传参数)为第一种表
// sheetNo 也可以指定第几张表，表以0开始计数
// sheetName 也可以指定表名
//sheet不能读取多次，多次读取需要重新读取文件
ReadSheet sheet = EasyExcel.readSheet().build();
reader.read(sheet);
// 记得关闭ExcelReader
reader.finish();
// EasyExcel 也可以替换成 EasyExcelFactory
// EasyExcel 继承 EasyExcelFactory，EasyExcel没有对EasyExcelFactory进行任何重写
// 所以EasyExcel与EasyExcelFactory相当于同一个类
// 读取读取传入excel文件，所有的表数据
// 第一种
// 但是如果解析失败抛出异常或者Listener的hasNext方法返回false后就不会继续往下执行
EasyExcel.read(file,new NoModelDataListener()).doReadAll();
// 第二种
// 但是如果解析失败抛出异常，停止解析但是会关闭一些excelReader的数据，需要重新新建excelReader才能继续循环执行
// Listener的hasNext方法返回false后就不会继续往下执行，不会出现上面的问题
ExcelReader excelReader = EasyExcel.read(file, new NoModelDataListener()).build();
List<ReadSheet> readSheets = excelReader.excelExecutor().sheetList();
for (ReadSheet readSheet : readSheets) {
excelReader.read(readSheet);
}
// 记得关闭ExcelReader
excelReader.finish();
}
自定义Listener
上面说了读取方式，下面说一下自定义Listener
其实我们可以封装一个通用的Listener
这是我自己封装的Listener
@Slf4j
public class DefaultExcelListener<T> extends AnalysisEventListener<T> {
// 解析后的数据
private final List<T> rows = new ArrayList();
// 解析表数据的表头，headMap 默认表格第一行数据
@Override
public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
log.info("======================================================");
log.info("解析第一行数据:{}" + JSON.toJSONString(headMap));
log.info("======================================================");
}
// 讲一条数据解析后的对象 data，将解析后的数据保存到 rows中
@Override
public void invoke(T object, AnalysisContext context) {
rows.add(object);
}
// 读取完excel数据后的操作
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
log.info("成功读取【" + rows.size() + "】条数据");
}
// 在读取excel异常 获取其他异常下会调用本接口。抛出异常则停止读取。如果这里不抛出异常则 继续读取下一行。
@Override
public void onException(Exception exception, AnalysisContext context) {
System.out.println("解析失败，但是继续解析下一行:{}" + exception.getMessage());
}
public List<T> getRows() {
return rows;
}
}
我们传入泛型对象（对象属性添加EasyExcel 注解）就可以进行解析，最后获取rows就可以得到解析后的数据
当然也可以根据自己的理解进行修改
使用中的问题
说一下在使用过程中遇到的问题
1.想要停止解析的问题
EasyExcel 想要解析需要抛出ExcelAnalysisStopException才能停止解析
例如你想检验表头，表头不匹配就不进行解析
@Override
public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
// 不匹配
throw new ExcelAnalysisStopException();
}
抛出异常后会被onException方法进行捕获
那就在onException中再抛出ExcelAnalysisStopException就可以抛出
@Override
public void onException(Exception exception, AnalysisContext context) {
if (exception instanceof ExcelAnalysisStopException) {
throw new ExcelAnalysisStopException("");
}
System.out.println("解析失败，但是继续解析下一行:{}" + exception.getMessage());
}
但是就一些的版本是不能抛出这个异常，onException会被上层进行捕获，重新抛 出一个异常
所以想要停止解析，通过hasNext是比较保险的
2.将表格中单元格数据进行转换成对象时，不会校验字符串“”
将单元格数据转换成对象使用有专门的转换器Converter
Converter接口
public interface Converter<T> {
// 转换后对象的类型
Class supportJavaTypeKey();
// 单元格数据类型
CellDataTypeEnum supportExcelTypeKey();
// cellData单元格数据
// T转换后的对象
// 将单元格数据转化成对象：主要是读的时候使用
T convertToJavaData(CellData cellData, ExcelContentProperty contentProperty,
GlobalConfiguration globalConfiguration) throws Exception;
// 将对象转化成对象单元格数据：主要是写的时候使用
CellData convertToExcelData(T value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration)
throws Exception;
}
EasyExcel 有一些基础类型的默认转换器，也是继承Converter接口
如果我们需要自定义转换器也可以继承这个接口对方法进行重写
在EasyExcel 使用转换器的时候会默认使用String转基本对象的方法
但是其中没有进行对字符串””的校验，所以在转换Data等对象时会报错
我是自定义进行解决的，不知道是不是我使用方式不对，还是已经有解决但是我没有使用到，如果大家发现是我没有发现，希望能告诉我一下
EasyExcel 默认转换器都是使用自定义的基础类型utils进行转换
自定义Converter
说一下自定义Converter的使用
当我们自定义Converter后可以通过@ExcelProperty()指定对象中的某个属性使用自定义转换器
也可以在EasyExcel.read()后指定
EasyExcel.read(fileName, ConverterData.class, new ConverterDataListener())
// 这里注意 我们也可以registerConverter来指定自定义转换器， 但是这个转换变成全局了， 所有java为string,excel为string的都会用这个转换器。
// 如果就想单个字段使用请使用@ExcelProperty 指定converter
.registerConverter(new CustomStringStringConverter())
// 读取sheet
.sheet().doRead();
@ExcelProperty()
用于属性：与表头进行匹配
value表头名称，可以配置多级表头
index表序列号
converter自定义转换器，将单元格数据转换成对象
到这里我们就可以使用EasyExcel 进行读取数据进行处理，目前我就使用到了EasyExcel 读取，后面使用到写数据再更新写出数据
