java EasyExcel实现动态列解析和存表

Java EasyExcel实现动态列解析和存表

在Java中，EasyExcel是一款非常好用的Excel操作工具。本文将介绍如何使用EasyExcel实现动态列解析和存表。

准备工作

使用EasyExcel需要添加相应的依赖：

<dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>easyexcel</artifactId>
   <version>x.x.x</version>
</dependency>

其中x.x.x为EasyExcel的版本号。

动态列解析

动态列指的是Excel中列数不确定，可能在读取的时候会增加或减少。使用EasyExcel可以很方便地处理这种情况。

在读取Excel时，声明一个用于存放数据的List，声明实体类，并通过EasyExcel的@ExcelProperty注解设置与Excel列的映射关系。当遇到不存在的列时，EasyExcel会自动忽略。

例如，以下的实体类表示一个Excel文件，包含了一个不确定列数的表格。

public class ExcelFile {
   // 文件名
   private String fileName;
   // 表名
   private String sheetName;
   // 表头
   @ExcelProperty(index = 0)
   private List<String> headers;
   // 数据
   @ExcelProperty(index = 1)
   private List<Map<String, String>> data;
   // getter/setter
}

上面的实体类中，headers字段表示表头，类型为List。data字段表示数据，类型为List>。Map中的key表示列名，value表示对应数据。

通过配置@ExcelProperty注解，EasyExcel可以很方便地将Excel文件中的数据转换成Java对象，并自动忽略不存在的列。

存储Excel数据

EasyExcel还提供了将Java对象写入Excel文件的功能。当我们需要将数据保存为Excel文件时，同样可以使用EasyExcel。

首先声明一个用于存放数据的List，并设置数据的格式。然后通过EasyExcel的write方法将数据保存成Excel文件即可。

以下示例展示如何将一个List>中的数据写入Excel文件。

public void saveExcel(List<Map<String, String>> data, String fileName) {
   // 文件路径
   String filePath = fileName + ".xlsx";
   // 构造ExcelWriter实例
   ExcelWriter writer = EasyExcel.write(filePath).build();
   // 设置Sheet1的表头
   List<String> headers = Arrays.asList("姓名", "年龄", "性别");
   // 构造Sheet实例
   Sheet sheet = new Sheet(1, 0);
   // 设置表头
   sheet.setHead(Collections.singletonList(headers));
   // 写入数据
   writer.write(data, sheet);
   // 关闭资源
   writer.finish();
}

上面的代码中，我们构造了一个ExcelWriter实例并设置了文件路径。然后构造了一个Sheet实例，并在表头中设置了列名。最后通过调用write方法将数据写入Excel文件中。

示例

以下示例展示了如何读取一个Excel文件，并将数据保存为另一个Excel文件。

public void readExcelToSave(String inFilePath, String outFilePath) {
   // 构建ExcelReader实例
   ExcelReader reader = EasyExcel.read(inFilePath).build();
   // 构造解析监听器
   DynamicColumnListener listener = new DynamicColumnListener();
   // 解析Excel
   reader.read(new Sheet(1, 0), listener);
   // 关闭资源
   reader.finish();
   // 在控制台输出数据
   System.out.println(listener.getExcelFile());
   // 写入数据到Excel文件
   saveExcel(listener.getExcelFile().getData(), outFilePath);
}

在上面的代码中，我们首先构建了一个ExcelReader实例并设置了文件路径。然后构造了一个DynamicColumnListener实例，并在调用read方法时传入该实例，用于监听Excel文件解析过程。在解析完成之后，我们将数据通过saveExcel方法保存为另一个Excel文件。

对于DynamicColumnListener的实现，我们需要通过invokeHeadMap方法获取Excel中的列名，然后动态构造实体类。示例如下：

public class DynamicColumnListener extends AnalysisEventListener<Map<Integer, String>> {
   private final ExcelFile excelFile = new ExcelFile();
   private Integer index = 0;
   // 获取表头
   @Override
   public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
       excelFile.setHeaders(new ArrayList<>(headMap.values()));
   }
   // 处理数据
   @Override
   public void invoke(Map<Integer, String> data, AnalysisContext context) {
       // 判断是否是第一行
       if (index == 0) {
           // 动态构造实体类
           List<Field> fields = new ArrayList<>();
           for (String header : excelFile.getHeaders()) {
               Field declaredField = null;
               try {
                   declaredField = ExcelData.class.getDeclaredField(header);
               } catch (NoSuchFieldException e) {
                   // 不存在的列忽略
                   continue;
               }
               declaredField.setAccessible(true);
               fields.add(declaredField);
           }
           excelFile.getExcelData().setFields(fields);
       }
       // 构造数据
       Map<String, String> result = new HashMap<>();
       for (String header : excelFile.getHeaders()) {
           result.put(header, data.get(excelFile.getHeaders().indexOf(header)));
       }
       excelFile.getExcelData().getData().add(result);
       index++;
   }
   // 获取ExcelFile实例
   public ExcelFile getExcelFile() {
       return excelFile;
   }
   // 在解析完成后执行
   @Override
   public void doAfterAllAnalysed(AnalysisContext context) {}
}

在上面代码的invokeHeadMap方法中，我们获取到Excel文件的列名并将其存入到ExcelFile对象中。在invoke方法中，我们动态构造实体类，并将解析出来的数据存储到ExcelFile对象中。在解析完成之后，通过getExcelFile方法获取到ExcelFile对象。