EasyExcel详解（结合官方文档）

EasyExcel

零、前言

文章是根据官方文档，加上自己的测试运行总结出来的，目前只总结的EasyExcel读的部分，写的部分还未完结，后续会更新

1、官方文档

https://easyexcel.opensource.alibaba.com/

2、EasyExcel的maven依赖

<!--Easy Excel-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.2.7</version>
</dependency>

一、具体使用演示&说明

1、读Excel

1.1 简单的读

创建一个读取对象，存储读取的内容

/**
 * 读对象
 * @author banana
 * @create 2023-12-26 11:39
 */

@Data  //生成getter、setter、toString、equals、hashCode等方法
public class ReadDemoData {
   
   
    
    private String string;

    private Date date;

    private Double doubleData;
}

创建一个读的监听器

package com.example.listener;

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.metadata.CellExtra;
import com.alibaba.excel.metadata.data.ReadCellData;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.alibaba.fastjson2.JSON;
import com.example.model.pojo.ReadDemoData;
import lombok.extern.slf4j.Slf4j;

import java.util.List;
import java.util.Map;

/**
 *
 * @author banana
 * @create 2023-12-26 11:50
 */

@Slf4j //Lombok 注解之一，它可以帮助我们在 Java 类中自动添加日志记录功能
public class ReadDemoDataListener implements ReadListener<ReadDemoData> {
   
   

    //每隔100条存储数据库，然后清理list，方便内存的回收
    private static final int BATCH_COUNT = 100;

    //缓存数据
    private List<ReadDemoData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);

    //在解析 Excel 过程中发生异常时调用的方法。可以在该方法中记录日志或者进行异常处理等操作
    @Override
    public void onException(Exception e, AnalysisContext analysisContext) throws Exception {
   
   

    }

    //在读取 Excel 文件表头时调用的方法。可用于对表头进行校验或者记录日志等操作
    @Override
    public void invokeHead(Map<Integer, ReadCellData<?>> headMap, AnalysisContext context) {
   
   

    }

    //在读取到一条数据时调用的方法。T 表示读取到的数据类型。可以在该方法中对读取到的数据进行处理或者记录日志等操作
    @Override
    public void invoke(ReadDemoData readDemoData, AnalysisContext analysisContext) {
   
   
        log.info("解析到一条数据：{}", JSON.toJSONString(readDemoData));
        cachedDataList.add(readDemoData);
        //达到BATCH_COUNT了,清空缓存，并可以去做一些处理（如存储一次数据库）
        //目的：防止几万条数据在内存中，容易OOM
        if(cachedDataList.size() >= BATCH_COUNT)
        {
   
   
            //一些业务操作（如存储数据库）
            //……
            saveData();

            //清除缓存
            cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
        }
    }

    //在读取 Excel 文件中除数据外的其他内容时调用的方法。例如，批注、超链接等。可以在该方法中进行相应的处理
    @Override
    public void extra(CellExtra cellExtra, AnalysisContext analysisContext) {
   
   

    }

    //在读取数据完成后调用的方法。可以在该方法中进行一些资源清理工作或者记录日志等操作
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
   
   
        //一些业务操作（如存储数据库,简单打印剩余数据）
        cachedDataList.stream().forEach(System.out::println);

        log.info("所有数据解析完成!");
    }

    //判断是否还有下一条数据需要读取。如果返回 true，会自动调用 invoke(T data, AnalysisContext analysisContext) 方法来读取下一条数据；
    // 如果返回 false，则结束读取数据的过程。
    @Override
    public boolean hasNext(AnalysisContext analysisContext) {
   
   
        return false;
    }

    //模拟数据存储(这里就是简单的打印一下)
    private void saveData(){
   
   
        log.info("{}条数据，开始存储数据库！", cachedDataList.size());
        cachedDataList.stream().forEach(System.out::println);
        log.info("存储数据库成功！");
    }
}

由于我们之后的测试都要在单元测试中进行，因此我们在单元测试目录下创建一个resources目录，用于后面对excel文件的读取

创建一个excel文件，名称为readExcel

该excel文件中共有四百十条数据

在单元测试中创建一个方法，专门根据名称去读取单元测试目录中resources目录下保存的excel文件

//根据文件名称，获取Excel目录地址
private String getExcelUrl(String docName){
   
   
    return this.getClass().getClassLoader().getResource("").getPath()  + docName;
}

之后创建一个单元测试类，去进行简单的读取操作

① 方法一：JDK8+ ,不用额外写一个DemoDataListener

实现代码：

//写法一
String fileName =  getExcelUrl("readExcel.xlsx");
// 这里默认每次会读取100条数据 然后返回过来 直接调用使用数据就行
// 具体需要返回多少行可以在`PageReadListener`的构造函数设置
EasyExcel.read(fileName, ReadDemoData.class, new PageReadListener<ReadDemoData>(dataList ->{
   
   
    for(ReadDemoData demoData : dataList){
   
   
        log.info("读取到一条数据{}", JSON.toJSONString(demoData));
    }
})).sheet().doRead();

具体运行结果：

我们可以看下PageReadListener源码，其就是继承ReadListener接口的一个实现类，相当于是EasyExcel帮我们写好的读的监听器，我们直接拿来用就好了

public class PageReadListener<T> implements ReadListener<T> {
   
   
    public static int BATCH_COUNT = 100;
    private List<T> cachedDataList;
    private final Consumer<List<T>> consumer;
    private final int batchCount;

    public PageReadListener(Consumer<List<T>> consumer) {
   
   
        this(consumer, BATCH_COUNT);
    }

    public PageReadListener(Consumer<List<T>> consumer, int batchCount) {
   
   
        this.cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
        this.consumer = consumer;
        this.batchCount = batchCount;
    }

    public void invoke(T data, AnalysisContext context)