Easyexcel读取单/多sheet页

此文档会说明单个和多个的sheet页的读取方法，包括本人在使用过程中的踩坑点。

依赖不会的自行百度导入，话不多说，直接上干货。以下示例基于2.x，新版本基本类似

1、创建实体

实体是用来接收对应列的数据的，官方文档中说明了可以用列号和列名进行指定

@Data
public class DemoExcelVO {

    @ExcelIgnore
    private String idNo;

    @ExcelProperty(value = "工时类型")
    private String workType;

    @ExcelProperty(index = 3)
    private String deliveryPhase;

    @ExcelIgnore
    private Integer orderBy;

    @ExcelIgnore
    private String workTypeEmptyColumn;

    @ExcelIgnore
    private String column;
}

创建实体如上所示，workType字段就是按照列名进行读取，deliveryPhase则是按照列号进行读取，更推荐使用列名指定，避免列的顺序出现变动影响读取数据的准确性。

需要特别注意，文档中多余的字段需要使用@ExcelIgnore进行标注，或者干脆不要写在这个实体内，接受完数据后自己去转对应的实体VO或者DTO。

读取excel文件

读取的方式有两种，

1、使用匿名内部类

如果是单个sheet页可以使用匿名内部类，这样就可以不用额外去写一个DemoDataListener。示例如下：

EasyExcel.read(inputStream, DemoExcelVO.class, new AnalysisEventListener<DemoExcelVO>() {
    
    // 存放列数据
	List<DemoExcelVO> dataList = new ArrayList<>();
    
    /**
     * 这里会一行行的返回头
     *
     * @param headMap
     * @param context
     */
    @Override
    public void invokeHead(Map<Integer, CellData> headMap, AnalysisContext context) {
        // 这里是接收表头的，默认为第一行为表头，多行表头建议使用下面的第二种方法读excel
        Map<Integer, String> map = ConverterUtils.convertToStringMap(headMap, context);
        List<String> headNames = new ArrayList<>(map.values());
        // 这里可以做一些表头的校验之类的逻辑
        /** 逻辑处理
         * ....
         */
    }

    /**
     * 这个每一条数据解析都会来调用
     *
     * @param data
     * @param context
     */
    @Override
    public void invoke(DemoExcelVO data, AnalysisContext context) {
        // 它会按照你提供的实体对象一行一行的对应赋值，每读取一行就会进入一次这个方法，所以这个方法可以处理单行的数据逻辑，最后添加到list中
        /** 逻辑处理
         * ....
         */
        // 添加到list中
        dataList.add(data);
    }

    /**
     * 将解析的数据缓存入redis，过期时间为第二天结束
     *
     * @param context
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 上面把每一行的数据读取完之后，就会进入到这个方法，一般是处理dataList的数据
        /** 逻辑处理
         * ....
         */
    }
}).sheet().doRead();

2、写读的监听器

这里有讲究，因为有两种实现，可以实现ReadListener接口，也可以继承AnalysisEventListener，下面我们一起看看有什么不同。

1、实现ReadListener接口

public class DemoListener implements ReadListener {
    @Override
    public void onException(Exception exception, AnalysisContext context) throws Exception {
        
    }

    @Override
    public void invoke(Object data, AnalysisContext context) {

    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {

    }

    @Override
    public boolean hasNext(AnalysisContext context) {
        return false;
    }

    @Override
    public void invokeHead(Map headMap, AnalysisContext context) {

    }
}

这里我就不一一对类进行说明了，可以基本和我上面的匿名内部类说明逻辑相似。

有坑！这个地方要注意，如果我们是直接实现的ReadListener然后快捷键按出来的具体实现方法，如下：

默认的话是会全选的，那么出来就是上面我给的代码那样子。问题就是出在**hasNext()**这个方法，这里我也没去深究，但是如果你默认不去更改，return false的话是无法读取到数据的。借用一下别人的说明：hasNext()这个方法是如果此扫描器的输入中有另一个标记，则返回 true。在等待要扫描的输入时，此方法可能阻塞。扫描器将不执行任何输入。所以循环会一直下去。

因此我们要记得把这个hasNext()调整为true，或者直接把这个方法干掉！

2、继承AnalysisEventListener

public class DemoListener extends AnalysisEventListener {

    @Override
    public void invoke(Object data, AnalysisContext context) {

    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {

    }
}

需要重写的方法只有两个，分别是针对每行数据的处理和对最后结果的处理，如果数据简单推荐用继承AnalysisEventListener去实现监听器，没啥坑。

下面是针对本次demo的具体实现：

Listener类：

public class DemoListener implements ReadListener {

    // 存放列数据
    @Getter
    private final List<DemoExcelVO> dataList = new ArrayList<>();

    /**
     * 这里会一行行的返回头
     *
     * @param headMap
     * @param context
     */
    @Override
    public void invokeHead(Map<Integer, CellData> headMap, AnalysisContext context) {
        // 这里是接收表头的，默认为第一行为表头，多行表头建议使用下面的第二种方法读excel
        Map<Integer, String> map = ConverterUtils.convertToStringMap(headMap, context);
        List<String> headNames = new ArrayList<>(map.values());
        // 这里可以做一些表头的校验之类的逻辑
        /** 逻辑处理
         * ....
         */
    }

    /**
     * 这个每一条数据解析都会来调用
     *
     * @param data
     * @param context
     */
    @Override
    public void invoke(DemoExcelVO data, AnalysisContext context) {
        // 它会按照你提供的实体对象一行一行的对应赋值，每读取一行就会进入一次这个方法，所以这个方法可以处理单行的数据逻辑，最后添加到list中
        /** 逻辑处理
         * ....
         */
        // 添加到list中
        dataList.add(data);
    }

    /**
     * 将解析的数据缓存入redis，过期时间为第二天结束
     *
     * @param context
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 上面把每一行的数据读取完之后，就会进入到这个方法，一般是处理dataList的数据
        /** 逻辑处理
         * ....
         */
    }

    @Override
    public void onException(Exception exception, AnalysisContext context) throws Exception {
		// 这里是异常的处理，可以选择抛出自定义的异常。
    }

    @Override
    public boolean hasNext(AnalysisContext context) {
        return true;
    }
}

业务方法：

public void demoImport(MultipartFile file) {
        ExcelReader excelReader;
        try (InputStream inputStream = file.getInputStream()) {
            excelReader = EasyExcel.read(inputStream).build();
        }
        catch (IOException e) {
            throw new EdmpRuntimeException("文件流读取错误！");
        }
        if (excelReader == null) {
            throw new EdmpRuntimeException("文件流读取错误！");
        }
        // 读取Sheet页数据，如果是多个sheet页面需要多个Listener，比如readSheet1、readSheet2
        DemoListener demoListener = new DemoListener();
        ReadSheet readSheet = EasyExcel
                .readSheet("demo")
                .head(DemoExcelVO.class)
                .registerReadListener(demoListener)
                .build();
        excelReader.read(readSheet);
    	// 获取数据
		List<DemoExcelVO> dataList = demoListener.getDateList()
        /*
          处理业务
         */
}