Java中使用EasyExcel技术进行简单的读操作（maven）

摘要：在这篇文章中我对java中使用EasyExcel技术中的读操作进行快速入门

引言：关于java中使用easyexcel进行写操作的关于入门，可参考文章：Java中使用EasyExcel技术进行简单的写操作（maven）_easyexcel maven_努力更新中的博客-CSDN博客

1.导入maven依赖

（1）easyexcel依赖（由于我们java程序中借助了easyexcel技术）

    <!-- 导入easy excel依赖 -->
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>easyexcel</artifactId>
      <version>2.2.0-beta2</version>
    </dependency>

（2）fastjson依赖（在读操作的监听器中，我使用fastjson工具对数据进行解析）

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>2.0.32</version>
</dependency>

2.编写读操作的测试类

public class StartReadTest {

    /**
     * 最简单的读
     * <p>
     * 1. 创建excel对应的实体对象 参照{@link DemoData}
     * <p>
     * 2. 由于默认一行行的读取excel，所以需要创建excel一行一行的回调监听器，参照{@link DemoDataListener}
     * <p>
     * 3. 直接读即可
     */
    @Test
    public void simpleRead() {

        // 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
        // 写法3：
//        fileName = TestFileUtil.getPath() + "demo" + File.separator + "demo.xlsx";
        // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
        String path = "E:\\fs-code\\easy-excel\\";
        String fileName = path + "simpleWriteExcel.xlsx";

        // sheet：可以指定工作表序号或工作表名称进行读
        EasyExcel.read(fileName, DemoData.class, new DemoDataListener()).sheet().doRead();
    }
}

3.指定实体类（也就是EasyExcel的读取格式，读取的数据使用该实体类进行封装）

@EqualsAndHashCode
public class DemoData {
    //    @ExcelProperty指定表头,如果不写的话，默认是实体类的属性名
    @ExcelProperty("字符串标题")
    private String string;

    // @DateTimeFormat注解设置excel中日期标题列的日期格式
    @DateTimeFormat("yyyy年MM月dd日")
    @ExcelProperty("日期标题")
    private Date date;

    @ExcelProperty("数字标题")
    private Double doubleData;

    /**
     * 忽略这个字段
     */
    @ExcelIgnore
    private String ignore;

    public DemoData() {
    }

    public DemoData(String string, Date date, Double doubleData) {
        this.string = string;
        this.date = date;
        this.doubleData = doubleData;
    }

    public String getString() {
        return string;
    }

    public void setString(String string) {
        this.string = string;
    }

    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }

    public Double getDoubleData() {
        return doubleData;
    }

    public void setDoubleData(Double doubleData) {
        this.doubleData = doubleData;
    }

    @Override
    public String toString() {
        return "DemoData{" +
                "string='" + string + '\'' +
                ", date=" + date +
                ", doubleData=" + doubleData +
                ", ignore='" + ignore + '\'' +
                '}';
    }
}

4.编写读操作的监听器（用于对Excel文件中的数据进行解析，将每一条数据都用我们定义的实体类进行存储，这里可以方便我们将读取出来的数据存储到数据库中（dao），实体类要一致）

// 有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去
@Slf4j
public class DemoDataListener extends AnalysisEventListener<DemoData> {

    /**
     * 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
     */
    private static final int BATCH_COUNT = 100;
    /**
     * 缓存的数据
     */
//    private List<DemoData> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    private List<DemoData> cachedDataList = new ArrayList<>();
    /**
     *
     * 假设这个是一个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
     */
//    读取数据会执行 invoke 方法
//    DemoData 类型
//    AnalysisContext 分析上下文
    @Override
    public void invoke(DemoData data, AnalysisContext context) {
//        log.info("解析到一条数据:{}", JSON.toJSONString(data));

        // 进行数据打印的控制台中；
//        log.debug(new Date() + "解析到的数据：" + JSON.toJSONString(data));
        log.debug(new Date() + "解析到的数据：" + JSON.toJSONString(data));
//        System.out.println(new Date() + "解析到的数据：" + JSON.toJSONString(data));

        cachedDataList.add(data);
        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
        if (cachedDataList.size() >= BATCH_COUNT) {
            saveData();
            // 存储完成清理 list
//            cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
            cachedDataList.clear();
        }
    }

    /**
     * 所有数据解析完成了 都会来调用
     *
     * @param context
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 这里也要保存数据，确保最后遗留的数据也存储到数据库
        saveData();
        log.info("所有数据解析完成！");
    }

    /**
     * 加上存储数据库
     */
    private void saveData() {
        log.info("{}条数据，开始存储数据库！", cachedDataList.size());
        demoDAO.save(cachedDataList);
        log.info("存储数据库成功！");
    }

}

5.如果需要将数据存储到数据库中的话，我们可以在dao/mapper层中进行操作数据库的操作

/**
 * 假设这个是你的DAO存储。当然还要这个类让spring管理，当然你不用需要存储，也不需要这个类。
 **/
public class DemoDAO {
    public void save(List<DemoData> list) {
        // 数据库的持久化操作：将数据写入到数据库当中

        // 如果是mybatis,尽量别直接调用多次insert,自己写一个mapper里面新增一个方法batchInsert,所有数据一次性插入
    }
}

注意：我这里只是对Java使用easyexcel技术进行读操作的快速入门，详细的内容参考easyexcel的官网：读Excel | Easy Excel (alibaba.com)