1. 概览

在平常开发中，想必都遇到过批处理的需求，简单来讲就是要求上传一个 Excel 文件，从 Excel 中读取数据，然落后行业务处理。对此，你怎样做呢？

使用 poi 一行行的读取数据，然落后行类型转换，最后调用业务方法。非常不错，恭喜你完成了这项工作。但，到此为止了吗，我们将继续深入。

1.1. 背景

常常会遇到这类情况，上线了一个需求，业务觉得不错，只是一条条录入效力太低，随后提出能不能弄一个 Excel 批量处理？固然，我们可以直接撸码，顺便加个小班，一气呵成。

简单回想一下，你有多久不处理手工的类型转换？

比如 Spring MVC 框架中，我们直接使用 JavaBean 来接收 request 要求的数据，那有无一种方式可以从 Excel 中读取出 JavaBean 呢？

Excel 数据转换

1.2. 目标

依照标准操作流程，框架需要支持：

1. 从 Class 中读取信息生成 Excel 模板，该模板需要对部份数据进行保护，不允许用户修改；
2. 用户获得 Excel 模板后，按要求完成相干信息填写，然后将 Excel 转换为 JavaBean 对象，快捷完成业务操作；
3. 前面两步需要支持嵌套 Bean，无需将关联对象的属性进行展开；

2. 快捷入门

2.1. 添加 starter 及相干依赖

在 Spring boot 项目的 pom 中增加以下依赖：

<dependency>
    <groupId>com.geekhalo.lego</groupId>
    <artifactId>lego-starter-excelasbean</artifactId>
    <version>0.1.1</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
</dependency>

2.2. 注入 ExcelAsBeanService 服务

在代码中直接注入 ExcelAsBeanService 对象，具体以下：

// 注入 excelAsBeanService
// 由 ExcelAsBeanAutoConfiguration 完成 ExcelAsBeanService 的注册
@Autowired
private ExcelAsBeanService excelAsBeanService;

2.3. 创建 Excel 模板

关键代码以下：

/**
 * 创建 Excel 模板
 * @param workbook
 * @param sheetName
 * @param dataCls
 * @param <D>
 */
default <D> void writTemplateToSheet(HSSFWorkbook workbook, String sheetName, Class<D> dataCls){
    writTemplateToSheet(workbook.createSheet(sheetName), dataCls);
}
/**
 * 创建 Excel 模板
 * @param sheet 待写入的 sheet
 * @param dataCls 待写入数据
 * @param <D>
 */
<D> void writTemplateToSheet(HSSFSheet sheet, Class<D> dataCls);

该方法，从 class 中读取信息，并将其写入到 Excel 模板。

2.4. 从 Excel 中读取并转换为 JavaBean

关键代码以下

/**
 * 从 Sheet 中读取数据
 * @param sheet 待读取数据的 Sheet
 * @param dataCls 待读取数据的类型
 * @param <D>
 */
default <D> List<D> readFromSheet(HSSFSheet sheet, Class<D> dataCls){
    List<D> result = Lists.newArrayList();
    readFromSheet(sheet, dataCls, d -> result.add(d));
    return result;
}
/**
 * 从 Sheet 中读取数据
 * @param sheet 待读取数据的 Sheet
 * @param dataCls 待读取数据的类型
 * @param consumer 回调器，完成数据解析后，直接调用回调器
 * @param <D>
 */
<D> void readFromSheet(HSSFSheet sheet, Class<D> dataCls, Consumer<D> consumer);

该方法，从 Sheet 中读取信息，并将其转换为 JavaBean；

2.5. 普通 bean 示例

首先，我们创建 JavaBean，并添加相干注解，具体以下：

@Data
public class CreateUserFromV1 implements CreateUserFrom{
    @HSSFTemplateHeader(title = "姓名")
    private String name;
    @HSSFTemplateHeader(title = "诞生日期")
    private Date birthAt;
    @HSSFTemplateHeader(title = "年龄")
    private Integer age;
}

其中，@HSSFTemplateHeader 中的 title 为展现信息。

调用 writTemplateToSheet 方法，获得 Excel 以下：

简单Bean模板

如图可见，Excel 中有 姓名(name)，诞生日期(birthAt) 和 年龄(age) 3列，当试图对 Header 进行修改时，弹出提示信息“受保护区域，不允许操作”。

拿到模板后，在Excel中填入信息以下：

简单Bean输入数据

将该 Excel 上传服务器，调用 readFromSheet 方法，获得终究 Bean 以下：

简单Bean解析结果

2.6. 嵌套 bean 示例

首先，创建一个关联类，以下：

@Data
public class AddressForm {
    @HSSFTemplateHeader(title = "省")
    private String l1;
    @HSSFTemplateHeader(title = "市")
    private String l2;
    @HSSFTemplateHeader(title = "区")
    private String l3;
    @HSSFTemplateHeader(title = "详细地址")
    private String l4;
}

关联对象没有甚么特别的地方，只是增加了 @HSSFTemplateHeader 注解。

新建 Bean 以下：

@Data
public class CreateUserFromV2 implements CreateUserFrom{
    @HSSFTemplateHeader(title = "姓名")
    private String name;
    @HSSFTemplateHeader(title = "诞生日期")
    private Date birthAt;
    @HSSFTemplateHeader(title = "年龄")
    private Integer age;
    @HSSFEmbedded
    private AddressForm addressForm;
}

也没有特殊的地方，只是在 关联对象上增加了 @HSSFEmbedded 注解。

导出模板，查看效果：

嵌套Bean模板

如图所示，Excel 中新增 省、市、区、详细地址几列，用于数据输入。

一样，再拿到模板后，在Excel中填入信息以下：

嵌套Bean数据

将该 Excel 上传服务器进行处理，获得终究 Bean 以下：

嵌套Bean结果

3. 设计&扩大

3.1. 关键设计

整体设计以下：

整体结构

1. Class 经过解析后取得一个 HSSFSheetReader，用于负责所有的读操作；
2. 每一个 HSSFSheetReader 提供 write template 和 read data 两组关键功能；
3. HSSFRowToBeanWriter 经过 ColumnToBeanPropertyWriter 完成每列到Bean属性的映照；
4. write 模板关键流程以下：
5. 为 Header Row 设置默许样式；
6. 从 HSSFRowToBeanWriter 获得解析后的 title 信息，并写入 Cell
7. 设置Header样式为保护模式，不允许任意修改；
8. reader data 流程以下：
9. 从 Header 中获得 path 和 Index 的映照；
10. 基于 ColumnToBeanPropertyWriter，从 Cell 中读取数据，并写入到 Bean 的属性；
11. 回调消费函数，处理转换好的 Bean 对象；

3.2. 功能扩大

读取链设计

关键履行流程以下：

1. HSSFCellReader 从 Cell 中读取数据；
2. BeanPropertyWriter 将数据写入到 JavaBean 的属性；

装配流程以下：

1. String 以托管 bean 的方式，提供 CellReaderFactory 和 BeanPropertyWriterFactory 实现；
2. 这些实现会注入到 HSSFCellReaderFactories 和 BeanPropertyWriterFactories，由 Factories 对其进行一致管理；
3. DefaultBeanPropertyWriterChainFactory 从 Factories 中获得适合的 HSSFCellReader 和 BeanPropertyWriter，将其封装为 BeanPropertyWriterChain；

4. 项目信息

项目仓库地址：https://gitee.com/litao851025/lego

项目文档地址：https://gitee.com/litao851025/lego/wikis/support/ExcelAsBean--%E6%95%B0%E6%8D%AE%E5%AF%BC%E5%85%A5