EasyExcel使用总结

简单总结一下EasyExcel的使用.

EasyExcel是阿里处理Excel的一款工具，非常好用。与Apache的poi不同，EasyExcel占用内存小。所以是很好的选择。文档中的功能较多，这里只做简单的读写。

文档链接：写excel · 语雀EasyExcel写Excel的示例https://www.yuque.com/easyexcel/doc/write#06e004ef-17

使用：

 读取：

首先我们不管是读取还是写入，都应该用一个字段名和表头相对应的实体类来接收，EasyExcel本身用来接收的是一个linkedHashMap。我们开发过程中，使用实体来接收比较便于后续处理。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class DemoData {
    @ExcelProperty("字符串标题")
    private String string;
    @ExcelProperty("日期标题")
    private Date date;
    @ExcelProperty("数字标题")
    private Double doubleData;
}

 其次就是读取还需要一个监听器，这里可以自己定义，也可以使用easyExcel中的监听器，这里都做一下展示：

自定义监听器：可以在invoke中进行逻辑编写，这里的监听器有个注意的地方：

有个很重要的点 DemoDataListener 不能被spring管理，要每次读取excel都要new,然后里面用到spring可以构造方法传进去，这样就可以使用Spring管理的类。

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

    /**
     * 每隔5条存储数据库，实际使用中可以100条，然后清理list ，方便内存回收
     */
    private static final int BATCH_COUNT = 100;
    /**
     * 缓存的数据
     */
    private List cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
    /**
     * 假设这个是一个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) {
        log.info("解析到一条数据:{}", JSON.toJSONString(data));
        cachedDataList.add(data);
        // 达到BATCH_COUNT了，需要去存储一次数据库，防止数据几万条数据在内存，容易OOM
        if (cachedDataList.size() >= BATCH_COUNT) {
            saveData();
            // 存储完成清理 list
            cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
        }
    }

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

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

EasyExcel自带的监听器：这里面的 new PageReadListener就是自带的监听器，可以替换成我们自定义的监听器。

 String fileName = "C:\\Users\\XXX\\Desktop\\43-XXX--技术调研&技术应用\\43-汇客--技术调研&技术应用\\资料\\excel读取测试.xlsx";
        EasyExcel.read(fileName, DemoData.class, new PageReadListener(dataList -> {
            for (DemoData demoData : dataList) {
//                log.info("读取到一条数据{}", JSON.toJSONString(demoData));
                System.out.println("输出信息：" + demoData);
            }
        })).sheet().doRead();

这样就可将我们的表格读取出来。文档中也有相对应的说明。

写入： 

写入的操作可以不用监听器

   String fileName = "C:\\Users\\XXX\\Desktop\\demo.xlsx";
        EasyExcel.write(fileName, DemoData.class)
                .sheet("模板")
                .doWrite(() -> {
                    // 分页查询数据
                    return 你要写入的数据;
                });

最后的doWrite()也可以这样写：

        String fileName = "C:\\Users\\XX\\Desktop\\demo.xlsx";
        EasyExcel.write(fileName, DemoData.class)
                .sheet("模板")
                .doWrite(直接写你的数据，不用return);

这样就可以进行表格的导入导出。 

sheet代表表格中下面的表格名称

如果想自己决定03,07的版本，那就可以直接像上面那样链式编程，进行设置.excelType();

03:表格后缀xls

07:表格后缀xlsx