使用 eazyExcel 工具类二次封装实现根据实体类下载模板、导入数据和下载数据功能

本文链接：https://blog.youkuaiyun.com/qq_51443603/article/details/130922372

文章介绍了如何利用EasyExcel工具库创建ExcelUtil工具类，实现根据实体类创建模板、导入和导出数据的功能。通过引入EasyExcel依赖，封装createExcelTemplate、importExcel和exportExcel方法，简化了Excel文件的处理。示例代码展示了生成模板、导入数据和导出数据的具体步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

使用 eazyExcel 工具类二次封装实现根据实体类下载模板、导入数据和下载数据功能

在日常开发中，我们经常需要处理 Excel 文件，例如生成 Excel 模板、导入数据到 Excel 表格或者将数据从 Excel 表格中导出。为了简化这些操作，我们可以使用 EasyExcel 工具库进行封装，以提高开发效率。本文将介绍如何使用 EasyExcel 工具类进行二次封装，实现根据实体类下载模板、导入数据和下载数据的功能。

1. 引入依赖

首先，我们需要在项目中引入 EasyExcel 的依赖。可以在 Maven 项目的 pom.xml 文件中添加以下依赖项：

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

2. 封装 ExcelUtil 工具类

我们创建一个名为 ExcelUtil 的工具类，用于封装根据实体类下载模板、导入数据和下载数据的功能。下面是完整的 ExcelUtil 类代码：

import com.alibaba.excel.EasyExcelFactory;
import com.alibaba.excel.ExcelReader;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.metadata.Sheet;

import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;

public class ExcelUtil {

    /**
     * 根据实体类生成 Excel 模板
     * @param clazz 实体类
     * @param sheetName sheet 名称
     * @param outputStream 输出流
     * @param <T> 实体类类型
     */
    public static <T> void createExcelTemplate(Class<T> clazz, String sheetName, OutputStream outputStream) {
        ExcelWriter writer = EasyExcelFactory.getWriter(outputStream);
        Sheet sheet = new Sheet(1, 0, clazz);
        sheet.setSheetName(sheetName);
        writer.write(new ArrayList<>(), sheet);
        writer.finish();
    }

    /**
     * 导入 Excel 数据
     * @param inputStream 输入流
     * @param clazz 实体类
     * @param <T> 实体类类型
     * @return 导入的数据列表
     */
    public static <T> List<T> importExcel(InputStream inputStream, Class<T> clazz) {
        ExcelReader reader = EasyExcelFactory.getReader(inputStream);
        List<T> dataList = new ArrayList<>();
        reader.read(new Sheet(1, 1, clazz)).forEach(dataList::add);
        reader.finish();
        return dataList;
    }

    /**
     * 导出 Excel 数据
     * @param dataList 数据列表
     * @param clazz 实体类
     * @param sheetName sheet 名称
     * @param outputStream 输出流
     * @param <T> 实体类类型
     */
    public static <T> void exportExcel(List<T> dataList, Class<T> clazz, String sheetName, OutputStream outputStream) {
        ExcelWriter writer = EasyExcelFactory.getWriter(outputStream);
        Sheet sheet = new Sheet(1, 0, clazz);
        sheet.setSheetName(sheetName);
        writer.write(dataList, sheet);
        writer.finish();
    }
}

3. 使用示例

3.1 根据实体类生成 Excel 模板

要生成一个 Excel 模板，我们可以使用 createExcelTemplate 方法。以下是示例代码：

OutputStream outputStream = new FileOutputStream("template.xlsx");
ExcelUtil.createExcelTemplate(User.class, "用户信息", outputStream);
outputStream.close();

上述代码将根据 User 类的定义，生成一个名为 用户信息 的 Excel 模板，并保存为 template.xlsx 文件。

3.2 导入 Excel 数据

要导入 Excel 数据，我们可以使用 importExcel 方法。以下是示例代码：

InputStream inputStream = new FileInputStream("data.xlsx");
List<User> userList = ExcelUtil.importExcel(inputStream, User.class);
inputStream.close();

上述代码将从名为 data.xlsx 的 Excel 文件中读取数据，并将其转换为 User 对象的列表。

3.3 导出 Excel 数据

要导出 Excel 数据，我们可以使用 exportExcel 方法。以下是示例代码：

List<User> userList = getUsersFromDatabase();
OutputStream outputStream = new FileOutputStream("data.xlsx");
ExcelUtil.exportExcel(userList, User.class, "用户数据", outputStream);
outputStream.close();