java excel动态表头 导入 java excel 动态复杂表头

前言

项目组祖传的POI代码，是基于entity实体类来固定格式解析，对应EXCEL是多少表头展示解析多少表头，需要改祖传代码，比较麻烦，时间不够。故用二次封装POI的EasyExcel来进行简易实现。

使用EasyExcel的优点

是基于POI进行的封装，其特点是：

1. 占用内存少。3M的excel用POI sax依然需要100M，而easyExcel只是KB级别。
2. 简洁。poi代码臃肿，easyExcel只需几行代码。

处理流程

1. 读取Excel文件输入流：InputStream；
2. 将数据输入流映射到自定义的Listenner（重写）；
3. Listenner中对每一行数据进行处理（分为表头和表身）；
4. 解析完毕，获取Listenner中自创建数据结构缓存的数据；

依赖

PS：如果项目中已经存在poi、poi-ooxml、poi-ooxml-schemas版本，起码要3.17以上。

<!-- fastjson -->
<!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
<dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>fastjson</artifactId>
   <version>1.2.75</version>
</dependency>

<!--easyExcel-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>2.2.6</version>
</dependency>

解析单行表头的Excel

单行表头，不定表头列和数据列。

自定义处理Listenner

自定义Listenner重写核心的三个方法，这个Listenner有点像是流式计算的算子一样：

1. invoke：处理每一行数据；
2. invokeHeadMap：处理表头数据；
3. doAfterAllAnalysed：处理完毕的后置操作；

/**
 * @Author: cbry
 * @Date: 2022/2/11 10:07
 * @Description:
 **/
public class ExcelListener extends AnalysisEventListener<Map<Integer, String>> {
    //Excel数据缓存结构
    private List<Map<Integer, Map<Integer, String>>> list;
    //Excel表头（列名）数据缓存结构
    private Map<Integer, String> headTitleMap = new HashMap<>();

    public ExcelListener() {
        list = new ArrayList<>();
    }

    /** 解析表头外的所有行数据 **/
    @Override
    public void invoke(Map<Integer, String> data, AnalysisContext context) {
        System.out.println("解析单行数据：" + JSON.toJSONString(data));
        Map<Integer, Map<Integer, String>> map = new HashMap<>();
        map.put(context.readRowHolder().getRowIndex(), data);
        list.add(map);
    }

    /** 解析完的后置操作 **/
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        System.out.println("所有数据解析完成");
    }

    /** 解析表头数据 **/
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        headTitleMap = headMap;
    }

    public List<Map<Integer, Map<Integer, String>>> getList() {
        return list;
    }

    public Map<Integer, String> getHeadTitleMap() {
        return headTitleMap;
    }

}

处理主类

取出Listener缓存的数据，并将表头和表数据组装为JSON格式数据，这里有一个存储的顺序的问题，见下：

/**
 * @Author: cbry
 * @Date: 2022/2/11 10:09
 * @Description:
 **/
public class ParseDynamicExcelMain {
    public static void main(String[] args) throws FileNotFoundException {

        //初始化本地Excel文件流
        File file = new File("D:\\cbry\\开发\\移动大屏\\dimension.xlsx");
        FileInputStream fis = new FileInputStream(file);

        //使用监听器处理文件流
        ExcelListener parseListener = new ExcelListener();
        EasyExcel.read(fis, parseListener).sheet().doRead();

        //获取Listenner缓存的数据结构
        List<Map<Integer, Map<Integer, String>>> list = parseListener.getList();
        Map<Integer, String> headTitleMap = parseListener.getHeadTitleMap();

        //将表头为key，数据为val组合新的Map，用于转换JSON格式
        List<Map<String, String>> mapList = new ArrayList<>();
        for (int i = 0; i < list.size(); i++) {
            Map<Integer, Map<Integer, String>> integerMapMap = list.get(i);
            integerMapMap.forEach((k, l) -> {
                Map<String, String> map = new LinkedHashMap<>();
                l.forEach((y, z) -> {
                    map.put(headTitleMap.get(y), z);
                });
                mapList.add(map);
            });
        }
        System.out.println(mapList);
        System.out.println("=============================");
        System.out.println(JSON.toJSONString(mapList));
    }
}

解析结果

这里我们注意一点：同样的put，hashMap结果无序，LinkedHashMap有序：。

解析效果（使用hashMap存储结果）：

使用LinkedHashMap：

若要处理entity对象

通过处理实体类对象，我们可以指定列的下标或者列名，来获取局部的Excel的列数据。

重写Listenner

将Listenner的传参类型修改为entity对象类型即可，重写invoke，无需重写invokeHeadMap方法。

public class ExcelListener extends AnalysisEventListener<User> {

public void invoke(User user, AnalysisContext context) {

构建实体类对象

index 参数代表excel对应的列； value表示列对应的名称，在写入excel时作用较大；

/**
     * 如果仅仅只用名字(value)去匹配，这里需要注意，如果名字重复，会导致只有一个字段读取到数据
     */
public class User {
    
    @ExcelProperty(index = 0,value = "完成率")
    private String completeRate;
    
    @ExcelProperty(index = 1,value = "数据日期")
    private String dataDate;
    
    @ExcelProperty(index = 2,value = "目标值")
    private String goalVal;
    
    @ExcelProperty(index = 3,value = "完成值")
    private String completeVal;
    
    //省略空参和全参构造方法
}

读取多个sheet

// 读取excel
            ExcelReader excelReader = EasyExcel.read(inputStream, User.class, listener)
                    .build();
            // 读取sheet0
            ReadSheet readSheet = EasyExcel.readSheet(0).build();
            // 将 sheet 写入 Reader
            excelReader.read(readSheet);

写入Excel

比如写入一个User类对象的数据：

EasyExcel.write(fileName, User.class)
     .sheet("cbry")							// 指定sheet名称
     .doWrite(new User());		//写入数据

单行表头读取解析效果

参考

Alibaba Easy Excel：官网文档永远值得确定。

SpringBoot 整合EasyExcel 获取动态Excel列名 陈彦斌：博主的这个demo存在顺序不一致的问题，文中已修补。