EasyExcel使用技巧
EasyExcel 高级使用
常用场景
- 数据导出称Excel表格
- 将Excel表中的信息导入
EasyExcel 常规使用
EasyExcel 常规使用参照官方文档：https://alibaba-easyexcel.github.io/index.html；此处就不再多赘述了~
- 本文中采用MyBatis-plus作为数据持久层框架
EasyExcel 封装统一的Listener
不同业务数据导入时需要有不同的接口和不同的实体类；按照官方文档的写法就需要写很多重复的Listener。此处将Listener用泛型进行修改一下，将Listener做成公共的。
官方写法
// 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
public class DemoDataListener extends AnalysisEventListener<DemoData> {
private static final Logger LOGGER = LoggerFactory.getLogger(DemoDataListener.class);
/**
* 每隔5条存储数据库，实际使用中可以3000条，然后清理list ，方便内存回收
*/
private static final int BATCH_COUNT = 5;
List<DemoData> list = new ArrayList<DemoData>();
/**
* 假设这个是一个DAO，当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
*/
private DemoDAO demoDAO;
public DemoDataListener() {
// 这里是demo，所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
demoDAO = new DemoDAO();
}
/**
* 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
*
* @param demoDAO
*/
public DemoDataListener(DemoDAO demoDAO) {
this.demoDAO = demoDAO;
}
/**
* 这个每一条数据解析都会来调用
*
* @param data
* one row value. Is is same as {@link AnalysisContext#readRowHolder()}
* @param context
*/
@Override
public void invoke(DemoData data, AnalysisContext context) {
LOGGER.info("解析到一条数据:{}", JSON.toJSONString(data));
list.add(data);
// 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
if (list.size() >= BATCH_COUNT) {
saveData();
// 存储完成清理 list
list.clear();
}
}
/**
* 所有数据解析完成了 都会来调用
*
* @param context
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
// 这里也要保存数据，确保最后遗留的数据也存储到数据库
saveData();
LOGGER.info("所有数据解析完成！");
}
/**
* 加上存储数据库
*/
private void saveData() {
LOGGER.info("{}条数据，开始存储数据库！", list.size());
demoDAO.save(list);
LOGGER.info("存储数据库成功！");
}
}
我的写法
public class ExcelDataListener<T> extends AnalysisEventListener<T> { // 使用泛型
private static final Logger log = LoggerFactory.getLogger(DemoDataListener.class);
private List<T> list = new ArrayList<>();
private BaseService baseService;// 这个是封装的公共的Service，所有的业务Service都要继承这个
public ExcelDataListener(BaseService baseService){
this.baseService = baseService;
}
@Override
public void invoke(T t, AnalysisContext analysisContext) {
log.info("解析到数据==》【{}】",t);
list.add(t);
if(list.size()>=SystemConstants.BATCH_COUNT){
batchSaveData();
}
}
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
batchSaveData();
}
// 调用Mapper 中的保存方法
private void batchSaveData(){
baseService.saveBatch(list);
}
}
调用
//buBaseWelderService 继承BaseService，此处将子接口传入
@Test
public void testExcel(){
String fileName = "D://wpqms_bu_base_welder.xlsx"; // excel 地址
EasyExcel.read(fileName, BuBaseWelderEntity.class,new ExcelDataListener<BuBaseWelderEntity>(buBaseWelderService)).sheet().doRead();
}
这样，就可以不用写多个重复的Listener，只用一个Listener即可
LocalDateTimeConverter 数据格式转化
在使用EasyExcel 的过程中，会出现时间数据不能转换的问题，用一个例子来告诉你这种问题怎么解决；
思想：先定义一个转换类，这个转换类继承EasyExcel 的Converter，泛型类型为LocalDateTime，然后在实体类上 将该转换类加上即可~
public class LocalDateTimeConverter implements Converter<LocalDateTime> {
private static final String DEFAULT_PATTERN = "yyyy-MM-dd HH:mm:ss";
@Override
public Class supportJavaTypeKey() {
return LocalDateTime.class;
}
@Override
public CellDataTypeEnum supportExcelTypeKey() {
return CellDataTypeEnum.STRING;
}
@Override
public LocalDateTime convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
return LocalDateTime.parse(cellData.getStringValue(), DateTimeFormatter.ofPattern(DEFAULT_PATTERN));
}
@Override
public CellData convertToExcelData(LocalDateTime localDateTime, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
return new CellData<>(localDateTime.format(DateTimeFormatter.ofPattern(DEFAULT_PATTERN)));
}
}
/**
* 职业病体检日期
*/
@ExcelProperty(converter = LocalDateTimeConverter.class)
private LocalDate zybtjDate;
奇怪的时间问题，解决方法如下：
@Override
public LocalDate convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
if (cellData.getType().equals(CellDataTypeEnum.NUMBER)) {
LocalDate localDate = LocalDate.of(1900, 1, 1);
//excel 有些奇怪的bug, 导致日期数差2
localDate = localDate.plusDays(cellData.getNumberValue().longValue() - 2);
return localDate;
} else if (cellData.getType().equals(CellDataTypeEnum.STRING)) {
return LocalDate.parse(cellData.getStringValue(), DateTimeFormatter.ofPattern("yyyy-MM-dd"));
} else {
return null;
}
}
其他数据转换
在实际开发过程中，有一些字段使用的是字典或者是一些特殊标识；比如：性别男用1表示，女用0表示；正常用1表示，异常用0表示等等，这种问题也需要创建一个转换类来解决。
package com.hrkj.zhbootsystem.files.easyExcelConverter;
import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.enums.CellDataTypeEnum;
import com.alibaba.excel.metadata.CellData;
import com.alibaba.excel.metadata.GlobalConfiguration;
import com.alibaba.excel.metadata.property.ExcelContentProperty;
/**
* @program: zhboot
* @description:
* @author: Kenson
* @create: 2021-06-04 10:36
**/
public class exampleConverter implements Converter<Integer> {
@Override
public Class supportJavaTypeKey() {
return Integer.class;
}
@Override
public CellDataTypeEnum supportExcelTypeKey() {
return CellDataTypeEnum.STRING;
}
@Override
public Integer convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
switch (cellData.getStringValue()){
case "班主任":
return 1;
case "普通教师":
return 2;
default:
return 0;
}
}
@Override
public CellData convertToExcelData(Integer integer, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {
switch (integer) {
case 1:
return new CellData("班主任");
case 2:
return new CellData("普通教师");
default:
return new CellData(String.valueOf(integer));
}
}
}
在实体类中的字段上 直接加上 @ExcelProperty(converter = exampleConverter.class) 即可~
本文 持续更新记录中，欢迎留言交流分享~
