SpringBoot整合EasyExcel，Excel导入导出就靠它了

作者主页：Designer 小郑
作者简介：3年JAVA全栈开发经验，专注JAVA技术、系统定制、远程指导，致力于企业数字化转型，CSDN学院、蓝桥云课认证讲师。
主打方向：Vue、SpringBoot、微信小程序

本文讲解了如何在SpringBoot项目中整合EasyExcel，实现Excel快捷导入导出，解析Excel导入导出的实现过程，提供了相关源码。

---

一、什么是 EasyExcel

EasyExcel 是一款基于Java的开源Excel操作工具，它提供了简单且强大的 API，使开发人员可以轻松地读写、操作和生成Excel文件。

EasyExcel 支持 Excel 文件的导入和导出，可以处理大量数据，具有高性能和低内存占用。它可以读取 Excel 文件中的数据，并将数据转换为 Java 对象，也可以将Java对象写入Excel文件。

EasyExcel 还提供了丰富的格式化选项和功能，如设置单元格样式、合并单元格、设置公式等。同时，EasyExcel 还支持多线程操作，可以在处理大量数据时提高处理效率。由于其简单易用的特点，EasyExcel 被广泛应用于数据导入导出、报表生成、数据分析等领域。

---

二、EasyExcel常用注解

EasyExcel 提供了一些常用的注解，用于在Excel读写过程中标识和控制字段的行为。以下是EasyExcel的常用注解：

1. @ExcelProperty：用于标识Excel中的字段，可以指定字段在Excel中的列索引或列名。例如：@ExcelProperty("姓名")，@ExcelProperty(index = 0)。

2. @ExcelIgnore：用于标识不需要导入或导出的字段。

3. @ExcelIgnoreUnannotated：用于标识未被 @ExcelProperty 注解标识的字段是否被忽略。

4. @ExcelHead：用于标识 Excel 表头的样式。可以设置表头的高度、字体样式、背景颜色等。

5. @ExcelColumnWidth：用于设置 Excel 列的宽度。

6. @ExcelDateTimeFormat：用于设置日期时间字段的格式化规则。

7. @ExcelBooleanFormat：用于设置布尔类型字段在 Excel 中的显示文本。

8. @ExcelNumberFormat：用于设置数字字段的格式化规则。

这些注解可以根据实际需求进行组合使用，以便在 Excel 读写过程中更灵活地控制字段的行为和样式。

---

三、整合 EasyExcel

3.1 引入依赖

要引入 EasyExcel 依赖，你需要在你的项目的 pom.xml 文件中添加以下依赖项：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.3.0</version>
</dependency>
1
2
3
4
5

这将引入 EasyExcel 的最新版本（当前为 2.3.0）。请同学们确保 Maven 配置正确，并且能够从 Maven 仓库下载依赖项。

完成后，Maven 将自动下载并管理 EasyExcel 依赖项，如下图所示。

3.2 实体类定义

当使用 EasyExcel 时，实体类需要按照以下规则进行定义。

• 实体类需要添加 @ExcelIgnoreUnannotated 注解，以确保未被 @ExcelProperty 注解标记的字段被忽略。
• 使用 @ExcelProperty 注解标记需要在 Excel 中读写的字段，可以指定字段在 Excel 中的列索引或列名。
• 可以使用其他注解（如 @ExcelDateTimeFormat、@ExcelNumberFormat 等）来进一步定义字段的格式化规则。

下面是一个示例代码，展示了一个使用 EasyExcel 读写 Excel 文件的实体类定义：

@ExcelIgnoreUnannotated
public class Student {
    @ExcelProperty(index = 0)   // 列索引为0
    private String name;

    @ExcelProperty(index = 1)   // 列索引为1
    private int age;

    @ExcelProperty(index = 2)   // 列索引为2
    private String gender;

    @ExcelProperty(index = 3)   // 列索引为3
    private Date birthday;

    // Getters and Setters
    // ...
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

在上述代码中，Student 类定义了4个字段，分别对应 Excel 文件中的4列。通过使用 @ExcelProperty 注解并指定列索引，我们告诉EasyExcel 需要将这些字段映射到相应的列。

请注意，这只是一个示例，你可以根据自己的需求定义更多的字段和注解来满足 Excel 读写的需求。

3.3 自定义转换器

在 EasyExcel 中，可以通过实现 Converter 接口来定义自定义转换器。

Converter 接口有两个泛型参数，分别表示读取时的类型和写入时的类型。

下面是一个简单的示例，展示了如何实现 Converter 接口来定义一个将 Boolean 类型转换为 字符串 的转换器。

public class BooleanToStringConverter implements Converter<Boolean, String> {

    @Override
    public String convertToExcelData(Boolean value) {
        return value ? "是" : "否";
    }

    @Override
    public Boolean convertToJavaData(String value) {
        return "是".equals(value);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

在上述示例中，BooleanToStringConverter 实现了 Converter 接口，并实现了 convertToExcelData() 和 convertToJavaData() 方法。convertToExcelData() 方法将 Boolean 类型的值转换为 字符串，convertToJavaData() 方法将字符串转换为 Boolean 类型的值。

要在读取或写入 Excel 时使用该转换器，可以通过 @ExcelConverter 注解将转换器与相应的字段关联起来，代码如下。

@ExcelProperty(index = 0)
@ExcelConverter(BooleanToStringConverter.class)
private Boolean married;
1
2
3

在上述代码中，通过 @ExcelConverter 注解指定了 BooleanToStringConverter 作为该字段的转换器，EasyExcel 在读取或写入 Excel 时将使用该转换器进行数据转换。

通过实现 Converter 接口，你可以定义各种自定义转换器，以满足不同类型的数据转换需求。

3.4 编写导出 Excel 接口

EasyExcel 是一个 Java 的开源库，它支持导出 Excel 文件，通过EasyExcel，同学们可以方便地将Java对象的数据导出到Excel文件中。

EasyExcel 提供了丰富的 API，可以配置导出的 Excel 的样式、格式以及数据内容，非常灵活易用，同学们可以使用 EasyExcel 导出各种类型的数据，包括基本类型、集合、自定义对象等，同时，EasyExcel 还支持大数据量的导出，可以有效地处理大批量数据的导出操作。

总之，EasyExcel 是一个功能强大且易于使用的导出Excel的工具。

下面是一个示例代码，展示了如何使用 EasyExcel 导出Excel的接口，请同学们参考学习。

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.write.metadata.WriteSheet;

import java.util.ArrayList;
import java.util.List;

public class ExcelExportService {

    public void exportExcel(String filePath) {
        // 准备数据
        List<Student> studentList = prepareData();

        // 创建ExcelWriter对象
        ExcelWriter excelWriter = EasyExcel.write(filePath, Student.class).build();

        // 创建WriteSheet对象
        WriteSheet writeSheet = EasyExcel.writerSheet("学生信息").build();

        // 将数据写入Excel
        excelWriter.write(studentList, writeSheet);

        // 关闭ExcelWriter对象
        excelWriter.finish();
    }

    private List<Student> prepareData() {
        // 创建测试数据
        List<Student> studentList = new ArrayList<>();
        studentList.add(new Student("张三", 18, "男"));
        studentList.add(new Student("李四", 20, "女"));
        studentList.add(new Student("王五", 19, "男"));
        return studentList;
    }

    public static void main(String[] args) {
        ExcelExportService excelExportService = new ExcelExportService();
        excelExportService.exportExcel("student.xlsx");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

在上述代码中，ExcelExportService 类封装了导出Excel的接口。在 exportExcel 方法中，首先准备数据，然后创建 ExcelWriter 对象，该对象用于写入 Excel 文件。接下来创建 WriteSheet 对象，用于指定写入的 Sheet 名称。最后，通过 excelWriter.write 方法将数据写入 Excel，并通过 excelWriter.finish 方法完成写入操作。

在 prepareData 方法中，创建了一个包含学生信息的测试数据列表。

在 main 方法中，创建了 ExcelExportService 对象，并调用 exportExcel 方法导出Excel文件。导出的 Excel 文件名为 student.xlsx。

同学们可以根据实际需求，修改数据和文件路径，以实现自己的导出功能。

3.5 编写导入 Excel 接口

EasyExcel 支持导入 Excel 文件。通过 EasyExcel，你可以方便地将 Excel 文件中的数据读取到 Java 对象中。EasyExcel 提供了丰富的 API ，可以配置读取 Excel 的方式、读取的 Sheet、读取的行数等。你可以使用 EasyExcel 读取各种类型的数据，包括基本类型、集合、自定义对象等。

同时，EasyExcel 还支持大数据量的导入，可以高效地处理大批量数据的导入操作。EasyExcel 还提供了监听器的机制，同学们可以通过监听器来对读取到的数据进行处理和验证。总之，EasyExcel 是一个功能强大且易于使用的导入 Excel 的工具。

下面是一个示例代码，展示了如何使用 EasyExcel 导入Excel的接口。

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.read.metadata.ReadSheet;
import java.util.List;

public class ExcelImportService {

    public void importExcel(String filePath) {
        // 创建Excel读取监听器
        ReadListener<Student> listener = new ExcelReadListener();
        // 创建读取Sheet配置
        ReadSheet readSheet = EasyExcel.readSheet(0).registerReadListener(listener).build();
        // 执行读取操作
        EasyExcel.read(filePath, Student.class).build().read(readSheet);
        // 获取读取的数据
        List<Student> studentList = ((ExcelReadListener) listener).getStudentList();
        // 处理读取的数据
        processImportedData(studentList);
    }

    private void processImportedData(List<Student> studentList) {
        // 处理导入的数据
    }

    public static void main(String[] args) {
        ExcelImportService excelImportService = new ExcelImportService();
        excelImportService.importExcel("student.xlsx");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

在上述代码中，ExcelImportService 类封装了导入 Excel 的接口。在 importExcel 方法中，首先创建 Excel 读取监听器 ExcelReadListener，用于处理读取到的数据。然后创建读取 Sheet 配置 ReadSheet，并通过 registerReadListener 方法将监听器注册到读取配置中。接下来，使用 EasyExcel 进行读取操作，将读取到的数据交给监听器进行处理。最后，通过 `processImportedData 方法处理导入的数据。

在 main 方法中，创建了 ExcelImportService 对象，并调用 importExcel 方法导入 Excel 文件。导入的 Excel 文件名为 student.xlsx。

同学们可以根据实际需求，修改文件路径和处理数据的逻辑，以实现自己的导入功能。

---

四、总结

本文讲解了如何在SpringBoot项目中整合EasyExcel，实现Excel快捷导入导出，解析Excel导入导出的实现过程，提供了相关源码。