Java实现Excel导入和导出，看这一篇就够了(珍藏版)

前言

最近抽了两天时间，把Java实现表格的相关操作进行了封装，本次封装是基于 POI 的二次开发，最终使用只需要调用一个工具类中的方法，就能满足业务中绝大部门的导入和导出需求。

1. 功能测试

1.1 测试准备

在做测试前，我们需要將【2. 环境准备】中的四个文件拷贝在工程里（如：我这里均放在了com.zyq.util.excel 包下）。

链接:http://ljh520.vip/%E8%BD%AF%E4%BB%B6/excelUtil.zip

1.2 数据导入

1.2.1 导入解析为JSON

比如，我们有下面一个表格：

Controller 代码：

@PostMapping("/import")

public JSONArray importUser(@RequestPart("file")MultipartFile file) throws Exception {

JSONArray array = ExcelUtils.readMultipartFile(file);

System.out.println("导入数据为:" + array);

return array;

}

测试效果：

1.2.2 导入解析为对象（基础）

首先，你需要创建一个与导入表格对应的Java实体对象，并打上对应的Excel解析的导入注解，@ExcelImport注解的value则为表头名称。

Controller 代码：

@PostMapping("/import")

public void importUser(@RequestPart("file")MultipartFile file) throws Exception {

List users = ExcelUtils.readMultipartFile(file, User.class);

for (User user : users) {

System.out.println(user.toString());

}

}

测试效果：

1.2.3 导入解析为对象（字段自动映射）

对于有的枚举数据，通常我们导入的时候，表格中的数据是值，而在数据保存时，往往用的是键，比如：我们用sex=1可以表示为男，sex=2表示为女，那么我们通过配置也可以达到导入时，数据的自动映射。

那么，我们只需要将Java实体中的对象sex字段的类型改为对应的数字类型Integer，然后再注解中配置好 kv 属性（属性格式为：键1-值1;键2-值2;键3-值3;…）

Cotroller 代码略（和 1.2.2 完全一致）。

测试效果：可以看到已经自动映射成功了。

1.2.4 导入解析为对象（获取行号）

我们在做页面数据导入时，有时候可能需要获取行号，好追踪导入的数据。

那么，我们只需要在对应的实体中加入一个 int 类型的 rowNum 字段即可。

Cotroller 代码略（和 1.2.2 完全一致）。

测试效果：

1.2.5 导入解析为对象（获取原始数据）

在做页面数据导入的时候，如果某行存在错误，一般我们会将原始的数据拿出来分析，为什么会造成数据错误。那么，我们在实体类中，增加一个 String 类型的 rowData 字段即可。

Cotroller 代码略（和 1.2.2 完全一致）。

测试效果：

1.2.6 导入解析为对象（获取错误提示）

当我们在导入数据的时候，如果某行数据存在，字段类型不正确，长度超过最大限制（详见1.2.7），必填字段验证（1.2.8），数据唯一性验证（1.2.9）等一些错误时候，我们可以往对象中添加一个 String 类型的 rowTips 字段，则可以直接拿到对应的错误信息。

比如，我们将表格中赵子龙的性别改为F（F并不是映射数据），将大乔的性别改为二十八（不能转换为Integer类型数据）。

Cotroller 代码略（和 1.2.2 完全一致）。

测试效果：可以看到，我们可以通过 rowTips 直接拿到对应的错误数据提示。

1.2.7 导入解析为对象（限制字段长度）

比如，我们手机通常为11为长度，那么不妨限制电话的最大长度位数为11位。

对应的做法，就是在 @ExcelImport 注解中，设置 maxLength = 11 即可。

比如，我们将诸葛孔明的电话长度设置为超过11位数的一个字符串。

Cotroller 代码略（和 1.2.2 完全一致）。

测试效果：

1.2.8 导入解析为对象（必填字段验证）

我们在做数据导入的时候，往往还会有一些必填字段，比如用户的名称，电话。

那么，我们只需要在 @ExcelImport 注解属性中，加上 required = true 即可。

我们将诸葛孔明的电话，以及第4行的姓名去掉，进行测试。

Cotroller 代码略（和 1.2.2 完全一致）。

测试效果：

1.2.9 导入解析为对象（数据唯一性验证）

(1) 单字段唯一性验证

我们在导入数据的时候，某个字段是具有唯一性的，比如我们这里假设规定姓名不能重复，那么则可以在对应字段的 @ExcelImport 注解上加上 unique = true 属性。

这里我们构建2条姓名一样的数据进行测试。

Cotroller 代码略（和 1.2.2 完全一致）。

测试效果：

（2）多字段唯一性验证

如果你导入的数据存在多字段唯一性验证这种情况，只需要将每个对应字段的 @ExcelImport 注解属性中，都加上 unique = true 即可。

比如：我们将姓名和电话两个字段进行联合唯一性验证（即不能存在有名称和电话都一样的数据，单个字段属性重复允许）。

首先，我们将刚刚（1）的数据进行导入。

测试效果：可以看到，虽然名称有相同，但电话不相同，所以这里并没有提示唯一性验证错误。

现在，我们将最后一行的电话也改为和第1行一样的，于是，现在就存在了违背唯一性的两条数据。

测试效果：可以看到，我们的联合唯一性验证生效了。

1.2.10 导入多Sheet页

如果你的导入表格存在多个sheet页（如下图），并想解析每个sheet页的数据，那么也是可以的。

Controller 代码：

@PostMapping("/import")

public void upload(@RequestPart("file") MultipartFile file) throws Exception {

Map map = ExcelUtils.readFileManySheet(file);

map.forEach((key, value) -> {

System.out.println("Sheet名称：" + key);

System.out.println("Sheet数据：" + value);

System.out.println("----------------------");

});

}

代码截图：

测试效果：

1.3 数据导出

1.3.1 动态导出（基础）

这种方式十分灵活，表中的数据，完全自定义设置。

Controller 代码：

@GetMapping("/export")

public void export(HttpServletResponse response) {

// 表头数据

List