Java easyexcel使用教程之导出篇

Java easyexcel使用教程之导出篇攻略

背景介绍

在实际开发中，经常会涉及到将数据导出为Excel文件的需求。而 EasyExcel 是一款由阿里巴巴开源的Java Excel解析/生成工具包，使用简单，支持大量数据导出，广受开发者喜欢。

本篇攻略主要针对EasyExcel的导出功能进行详细讲解，包括使用方法、参数配置和示例说明等内容。

使用方法

EasyExcel支持通过注解的方式配置Excel的表头和内容格式，对于导出功能，主要包括以下几个步骤：

引入依赖

在项目的 pom.xml 文件中添加 EasyExcel 的依赖：

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

定义数据模型

首先需要定义一个数据模型，即需要导出的数据所对应的 Java 类。可以通过在类上添加注解的方式来定义表头信息和数据格式。示例如下：

@Data
public class ExportData {
    @ExcelProperty(value = "姓名", index = 0)
    private String name;

    @ExcelProperty(value = "年龄", index = 1)
    private Integer age;
}

创建导出对象

EasyExcel 提供了 EasyExcelFactory 类来创建导出对象，可以通过 EasyExcelFactory.getWriter() 方法来获取一个 ExcelWriter 对象，代码示例如下：

OutputStream out = new FileOutputStream("demo.xlsx"); // 导出文件的输出流
ExcelWriter writer = EasyExcelFactory.getWriter(out);

配置导出参数

在创建导出对象之后，需要对导出参数进行配置。EasyExcel 提供了全局配置和局部配置两种方式，具体可以参考 EasyExcel 官方文档。这里简要介绍一下全局配置的使用方法，示例如下：

ExcelWriter writer = EasyExcelFactory.getWriter(out,new Sheet(1,0, ExportData.class.getSimpleName()));
writer.write(data(), new Sheet(1, 1, ExportData.class)); // 将数据写入到Excel中
// 导出完成之后需要关闭 ExcelWriter
writer.finish();

以上代码中的参数含义分别为：导出文件的输出流、表格的 sheet 序号、表头信息、数据列表。

执行导出操作

导出操作可以通过 ExcelWriter.write() 方法来实现，示例如下：

writer.write(data(), new Sheet(1, 1, ExportData.class)); // 将数据写入到Excel中

以上代码中的参数含义分别为：数据列表、表格的 sheet 序号、表头信息。

关闭导出流

导出操作完成后，需要调用 ExcelWriter.finish() 方法来关闭导出的流和创建的对象，示例如下：

writer.finish(); // 关闭资源

示例说明

下面通过两个示例来说明 EasyExcel 的导出功能。

示例一

假设有如下的用户表数据需要导出到 Excel 文件中：

用户名	年龄	性别
张三	23	男
李四	30	女
王五	27	男

可以定义一个数据模型 UserExcelDto 如下：

@Data
public class UserExcelDto {
    @ExcelProperty(value = "用户名", index = 0)
    private String name;

    @ExcelProperty(value = "年龄", index = 1)
    private Integer age;

    @ExcelProperty(value = "性别", index = 2)
    private String sex;
}

然后可以通过如下代码实现导出操作：

public void export() throws IOException {
    // 准备数据
    List<UserExcelDto> userList = new ArrayList<>();
    userList.add(new UserExcelDto("张三", 23, "男"));
    userList.add(new UserExcelDto("李四", 30, "女"));
    userList.add(new UserExcelDto("王五", 27, "男"));

    // 创建导出对象
    OutputStream out = new FileOutputStream("user.xlsx"); // 导出文件的输出流
    ExcelWriter writer = EasyExcelFactory.getWriter(out);

    // 导出参数配置
    Sheet sheet = new Sheet(1, 0, UserExcelDto.class, "用户信息");
    writer.write(userList, sheet);

    // 关闭流
    writer.finish();
    out.close();
}

以上代码中，首先创建了 UserExcelDto 作为数据模型，并定义了相应的表头信息。然后准备好用户表数据之后，创建了一个导出对象，并配置了导出参数。最后执行导出操作并关闭流。

示例二

假设有如下的销售数据需要导出到 Excel 文件中：

品牌	产品名称	销售数量	单价	总价
Nike	Air Max 270	1000	899.00	899000.00
Adidas	Ultra Boost 3.0	500	799.00	399500.00
New Balance	990v4	300	1099.00	329700.00

可以定义一个数据模型 SaleExcelDto 如下：

@Data
public class SaleExcelDto {
    @ExcelProperty(value = "品牌", index = 0)
    private String brand;

    @ExcelProperty(value = "产品名称", index = 1)
    private String productName;

    @ExcelProperty(value = "销售数量", index = 2)
    private Integer saleNum;

    @ExcelProperty(value = "单价", index = 3)
    private Double price;

    @ExcelProperty(value = "总价", index = 4)
    private Double total;
}

然后可以通过如下代码实现导出操作：

public void export() throws IOException {
    // 准备数据
    List<SaleExcelDto> saleList = new ArrayList<>();
    saleList.add(new SaleExcelDto("Nike", "Air Max 270", 1000, 899.00, 899000.00));
    saleList.add(new SaleExcelDto("Adidas", "Ultra Boost 3.0", 500, 799.00, 399500.00));
    saleList.add(new SaleExcelDto("New Balance", "990v4", 300, 1099.00, 329700.00));

    // 创建导出对象
    OutputStream out = new FileOutputStream("sale.xlsx"); // 导出文件的输出流
    ExcelWriter writer = EasyExcelFactory.getWriter(out);

    // 导出参数配置
    Sheet sheet = new Sheet(1, 0, SaleExcelDto.class, "销售数据");
    writer.write(saleList, sheet);

    // 关闭流
    writer.finish();
    out.close();
}

以上代码中，首先创建了 SaleExcelDto 作为数据模型，并定义了相应的表头信息。然后准备好销售数据之后，创建了一个导出对象，并配置了导出参数。最后执行导出操作并关闭流。

总结

EasyExcel 提供了非常简单易用的数据导入导出功能，可以大大简化开发者的工作。在使用过程中，需要注意合理设置参数，防止数据过大导致导出失败。同时需要注意在导出完成后及时关闭导出流，避免资源浪费。