- 前言
- 一、EasyExcel是什么?
- 1、概述:
- 2、案例分析
- 2.1 导入依赖
- 2.2 读excel数据到内存中
- 2.2.1 代码一
- 2.3 将数据写入excel中
EasyExcel的知识点记录及使用;
提供自己学习
EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel。
2、案例分析 2.1 导入依赖2.2 读excel数据到内存中 2.2.1 代码一com.alibaba easyexcel 3.1.0 poi-ooxml-schemas org.apache.poi
public AjaxResult importData(MultipartFile file) throws Exception {
//配置excel分析监听器
ExcelListener excelListener = new ExcelListener(tbClueService);
//读取excel表格数据
EasyExcel.read(file.getInputStream(), TbClueExcelVo.class, excelListener).sheet().doRead();
return AjaxResult.success(excelListener.getResult());
}
分析
(1)格式:
- 配置excel分析监听器
ExcelListener excelListener = new ExcelListener(tbClueService);
因为监听器不是单例的,每次读取一条数据就会创建一个监听器对象,所有不能交给spring管理, 所以一般会提供监听器(ExcelListener )的有参构造方法,由此传入需要使用的service层的接口, 该接口的实现类为单例,被spring管理,只能通过此方法传入。
- 读取 excel表格数据
// 在读的时候只需要new ExcelListener 监听器传入就行了 EasyExcel.read(file.getInputStream(), TbClueExcelVo.class, new ExcelListener()) // 需要读取批注 默认不读取 .extraRead(CellExtraTypeEnum.COMMENT) // 需要读取超链接 默认不读取 .extraRead(CellExtraTypeEnum.HYPERLINK) // 需要读取合并单元格信息 默认不读取 .extraRead(CellExtraTypeEnum.MERGE).sheet().doRead();
这个框架底层使用了建造者模式,每次读取一条数据,也就将一条数据封装到一个对象中(并且每次创 建一个excel分析监听器对象和数据对象)
(2)excel监听器代码
package com.huike.clues.utils.easyExcel; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import com.alibaba.excel.context.AnalysisContext; import com.alibaba.excel.event.AnalysisEventListener; import com.huike.clues.domain.dto.ImportResultDTO; import com.huike.clues.domain.vo.TbClueExcelVo; import com.huike.clues.service.ITbClueService; public class ExcelListener extends AnalysisEventListener{ public ITbClueService clueService; private ImportResultDTO resultDTO; //每隔5条存储数据库,实际使用中可以3000条,然后清理list ,方便内存回收 private static final int BATCH_COUNT = 5; List list = new ArrayList (); public ExcelListener(ITbClueService clueService) { this.clueService = clueService; this.resultDTO = new ImportResultDTO(); } @Override public void invoke(TbClueExcelVo data, AnalysisContext context) { //对于每一条数据的处理 list.add(data); // 在这里可以做一些其他的操作 就考自己去拓展了 // 达到BATCH_COUNT了,需要去存储一次数据库,防止数据几万条数据在内存,容易OOM if (list.size() >= BATCH_COUNT) { saveData(); // 存储完成清理 list list.clear(); } } @Override public void doAfterAllAnalysed(AnalysisContext context) { // 这里也要保存数据,确保最后遗留的数据也存储到数据库 // 当然也可以有很多其他操作 比如有些需要触发其他的 可以在这里调用 saveData(); } // 读取条额外信息:批注、超链接、合并单元格信息等 @Override public void extra(CellExtra extra, AnalysisContext context) { LOGGER.info("读取到了一条额外信息:{}", JSON.toJSONString(extra)); switch (extra.getType()) { case COMMENT: LOGGER.info("额外信息是批注,在rowIndex:{},columnIndex;{},内容是:{}", extra.getRowIndex(), extra.getColumnIndex(), extra.getText()); break; case HYPERLINK: if ("Sheet1!A1".equals(extra.getText())) { LOGGER.info("额外信息是超链接,在rowIndex:{},columnIndex;{},内容是:{}", extra.getRowIndex(), extra.getColumnIndex(), extra.getText()); } else if ("Sheet2!A1".equals(extra.getText())) { LOGGER.info( "额外信息是超链接,而且覆盖了一个区间,在firstRowIndex:{},firstColumnIndex;{},lastRowIndex:{},lastColumnIndex:{}," + "内容是:{}", extra.getFirstRowIndex(), extra.getFirstColumnIndex(), extra.getLastRowIndex(), extra.getLastColumnIndex(), extra.getText()); } else { Assert.fail("Unknown hyperlink!"); } break; case MERGE: LOGGER.info( "额外信息是超链接,而且覆盖了一个区间,在firstRowIndex:{},firstColumnIndex;{},lastRowIndex:{},lastColumnIndex:{}", extra.getFirstRowIndex(), extra.getFirstColumnIndex(), extra.getLastRowIndex(), extra.getLastColumnIndex()); break; default: } } //在转换异常 获取其他异常下会调用本接口。抛出异常则停止读取。如果这里不抛出异常则 继续读取下一行。 @Override public void onException(Exception exception, AnalysisContext context) { // 如果是某一个单元格的转换异常 能获取到具体行号 // 如果要获取头的信息 配合invokeHeadMap使用 if (exception instanceof ExcelDataConvertException) { ExcelDataConvertException excelDataConvertException = (ExcelDataConvertException)exception; LOGGER.error("第{}行,第{}列解析异常", excelDataConvertException.getRowIndex(), excelDataConvertException.getColumnIndex()); } } public ImportResultDTO getResult(){ return resultDTO; } }
分析监听器AnalysisEventListener< T>
AnalysisEventListener< T>继承了 ReadListener ,我们一般使用它的父接口
public interface ReadListener2.3 将数据写入excel中extends Listener { //在转换异常 获取其他异常下会调用本接口。抛出异常则停止读取。 //如果这里不抛出异常则 继续读取下一行。 void onException(Exception var1, AnalysisContext var2) throws Exception; // 调用invokeHeadMap来获取表头数据 void invokeHead(Map var1, AnalysisContext var2); // 一行行读取表格内容(每一条数据解析都会调用) void invoke(T var1, AnalysisContext var2); //读取条额外信息:批注、超链接、合并单元格信息等 void extra(CellExtra var1, AnalysisContext var2); // 当数据全部解析完后,此方法会执行 void doAfterAllAnalysed(AnalysisContext var1); //验证是否还有数据 boolean hasNext(AnalysisContext var1); }
(1)创建每条数据对应的数据对象
@Data
public class DemoData {
@ExcelProperty("字符串标题")
private String string;
@ExcelProperty("日期标题")
private Date date;
@ExcelProperty("数字标题")
private Double doubleData;
@ExcelIgnore
private String ignore;
}
(2)上代码
@Test
public void simpleWrite() {
// 写法1
String fileName = TestFileUtil.getPath() + "simpleWrite" +
System.currentTimeMillis() + ".xlsx";
// 这里 需要指定写用哪个class去写,然后写到第一个sheet,名字为模板
//然后文件流会自动关闭
// 如果这里想使用03 则 传入excelType参数即可
EasyExcel.write(fileName, DemoData.class).sheet("模板").doWrite(data());
// 写法2
fileName = TestFileUtil.getPath() + "simpleWrite" +
System.currentTimeMillis() + ".xlsx";
// 这里 需要指定写用哪个class去写
ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build();
WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
excelWriter.write(data(), writeSheet);
// 千万别忘记finish 会帮忙关闭流
excelWriter.finish();
}



