Java easyexcel使用教程之导出篇

简介

EasyExcel 是国内开源的一个 Excel 操作库，性能卓越，并且可以使用注解方式进行 Excel 文件读写操作。在本篇文章中，我们将会介绍 EasyExcel 的导出功能。

导出 Excel 文件

引入依赖

在 pom.xml 文件中添加以下依赖：

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

创建实体类

我们需要创建一个实体类，并为字段添加注解，用于指定 Excel 表头和列数据。

public class User {

    @ExcelProperty("ID")
    private Long id;

    @ExcelProperty("姓名")
    private String name;

    @ExcelProperty("年龄")
    private Integer age;

    // getters and setters
}

编写导出逻辑

我们可以使用 EasyExcel 提供的 ExcelWriter 类来进行导出 Excel 文件的操作。以下是导出 Excel 文件并写入数据的示例代码：

public static void writeExcel(List<User> userList, String fileName, HttpServletResponse response) throws IOException {
    response.setContentType("application/vnd.ms-excel");
    response.setCharacterEncoding("utf-8");
    response.setHeader("Content-Disposition", "attachment;filename=" + fileName);

    // 创建 ExcelWriter 对象
    ExcelWriter excelWriter = new ExcelWriter(response.getOutputStream(), ExcelTypeEnum.XLSX);

    // 创建 Sheet 对象
    Sheet sheet1 = new Sheet(1, 0, User.class);

    // 设置 Sheet 名称
    sheet1.setSheetName("用户信息");

    // 写入数据
    excelWriter.write(userList, sheet1);

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

以上示例代码中，我们使用了包含三个参数的 Sheet 构造函数来创建 sheet1 对象：

• 第一个参数 sheetNo 指定 Sheet 在 Excel 文件中的索引，从 1 开始计算；
• 第二个参数 headLineMun 指定表头行数，0 表示没有表头；
• 第三个参数 clazz 指定实体类类型，用于指定 Excel 表头和列数据。

最后，我们将 User 列表和 sheet1 对象传入 ExcelWriter 实例的 write 方法中即可。需要注意的是，最后要调用 finish 方法来完成 Excel 的写入。

示例一：导出列表数据

以下是一个导出用户列表的示例代码：

@GetMapping("/export")
public void export(HttpServletResponse response) throws Exception {
    // 查询用户列表
    List<User> userList = userService.list();

    // 导出 Excel 文件
    writeExcel(userList, "用户列表.xlsx", response);
}

示例二：导出查询结果

以下是一个导出查询结果的示例代码：

@GetMapping("/search/export")
public void exportSearchResult(HttpServletResponse response) throws Exception {
    // 获取查询结果
    List<User> searchResult = userService.search("张三", 18);

    // 导出 Excel 文件
    writeExcel(searchResult, "查询结果.xlsx", response);
}

总结

EasyExcel 的使用方式非常简单，我们只需要创建实体类、编写导出逻辑、调用导出方法即可。在实际开发中，我们可以根据不同的业务场景进行相应的开发，满足需求。