简单几个注解，分分钟搞定 Excel 数据导出

Answer 1

数据导出是日常开发的常见功能，及将数据导出为Excel并提供下载。 Java 生态存在大量的 Excel 操作类库，基于这些类库便可完成相关功能。这样，大量繁杂、无意义的代码耗费着宝贵的人力资源，大家距离 996 又近了几分，那有没有更优解呢？

1.1. 背景

刚刚接到产品需求，准备为众多“列表”功能增加下载支持，简单来说就是：新增一个“导出”按钮，点击时，将列表数据导入到 Excel 并进行下载。

需求很简单，功能也很明确，接到需求后，小伙伴们着手准备：

不知道你怎么想，面对这些枯燥的体力工作，我极为反感。

1.2. 目标

“懒” 是人类进步的“原动力”。手懒心不懒，让脑力解放体力！！！

设计目标如下：

为特殊场景提供定制能力，以满足个性化需求；

2. 快速入门

2.1. 引入 starter 以及相关依赖

首先，在 pom 文件中增加excelasbean starter 以及 poi 依赖。

2.2. 使用 ExcelAsBeanService 完成 excel 导出

其次，将ExcelAsBeanService 注入到自己的 Sevice 中，使用 write 等一系列方法完成 数据写入。

示例代码如下：

2.3. 在 JavaBean 上增加相关注解

最后，只要在 JavaBean 增加相关注解，便可以导出 Excel。

从简单到复杂，框架提供了多种定制能力，具体如下：

2.3.1. 简单导出

最简单的方式，只需增加@HSSFHeader 注解，并指定好 Header 的标题即可。

示例代码如下：

运行效果如下：

备注：@HSSFHeader 具有标记作用，JavaBean 中没有 @HSSFHeader 标记的字段或方法不会进行导出。

2.3.2. 自定义列顺序

默认情况下，Excel 中的列与 JavaBean 属性定义顺序相关；如有需要，可自定义列的顺序。

增加自定义列顺序，相关代码如下：

可以通过@HSSFHeader 的 order 指定顺序，也可以使用 @HSSFShowOrder 进行指定，具体效果如下：

见图，年龄 和 生日 的顺序发生变化。

2.3.3. 导出嵌入对象

当 JavaBean 属性为另一个对象时，我们需要将关联对象也一并导出。

首先，定义关联对象，示例如下：

关联对象只是在 Address 上增加了@HSSFHeader 注解。

其次，使用@HSSFEmbedded 对嵌入对象进行标记。示例如下：

运行效果如下：

如图，Address 内部属性已经完全展开并写入到 Excel。

2.3.4. 自定义格式化方法

当直接对属性进行展示不能满足需求时，可以通过自定义方法对输出内容进行格式化。

比如，需要对 Address 对象中的内容进行自定义展示，示例如下：

首先，将展示规则封装到方法中，如showAddress()然后，在方法上增加 @HSSFHeader 注解。

运行效果如下：

如图，Excel 中新增 “详细地址” 列。

2.3.5. 添加样式

如果觉得展示比较枯燥，可以自定义 Header 和 Data 的显示样式。

在类上指定全局 Header 样式，示例如下：

在 UserV5 类上增加@HSSFHeaderStyle("header")，指定表头使用 header 样式。

运行效果如下：

如图，表头的样式发生了变化。

备注：自定义样式，需要提供HSSFCellStyleFactory 实现，详见 “设计&扩展” 部分

3. 设计&扩展

3.1. 核心设计

3.1.1. 整体设计

整体设计如下：

按照层级结构，将核心组件拆分为：

其中，操作的核心逻辑基本在HSSFCellWriterChain 中，其他结构主要完成组件组装。

3.1.1. CellWriterChain 设计

CellWriterChain 是写入流程的核心，整体设计如下：

从写流程来看，包括：

从装配流程来看，包括：

3.2. 功能扩展

为了应对个性化需求，框架提供了众多扩展点，其中最重要的扩展点包括，HSSFValueSupplier、HSSFCellWriter 和 HSSFCellConfigurator。

三者协助组成HSSFCellWriterChain，完成数据写入操作。

3.2.1. HSSFValueSupplier

从 Bean 中提取数据。

HSSFValueSupplier 定义如下：

直接继承自 Function，输入为 JavaBean 对象，输出为待写入数据。

目前，系统实现如下：

备注：一般情况下无需进行扩展

3.2.2. HSSFCellConfigurator

在执行写入操作前，对 Cell 进行配置。

HSSFCellConfigurator 定义如下：

目前，系统中实现包括：

如需对样式进行定制，需实现HSSFCellStyleFactory 并根据 name 返回不同的样式。实例代码如下：

3.2.3. HSSFCellWriter

负责向 Cell 中写入数据，比如对数据进行格式化。

HSSFCellWriter 接口定义如下：

目前，系统中的实现包括：

备注：如需复杂的转换，可以通过扩展HSSFCellWriter 的方式实现。

4. 项目信息

项目仓库地址：

gitee.com/litao851025/l...

项目文档地址：

gitee.com/litao851025/l...数据导出 来源：geekhalo