使用 EasyExcel 提升 Excel 处理效率

news2025/1/18 10:21:25

前言

在日常开发中，Excel 文件的处理是不可避免的一项任务，特别是在需要批量导入和导出数据的场景中。传统的 Apache POI 虽然功能强大，但在大文件处理和使用便捷性上存在一定的不足。为了解决这些问题，阿里巴巴推出了 EasyExcel，一个专注于高性能和简洁性的 Excel 处理工具。本篇文章将带领大家深入了解 EasyExcel 的优点和功能，并结合实例讲解如何在项目中高效使用。
在这里插入图片描述

1. EasyExcel 的优点

1.1 快速

EasyExcel 在处理 Excel 文件时，通过采用流式读取和写入的方式，极大地减少了内存占用，尤其适合处理百万行数据的大文件场景。与 Apache POI 相比，它能够更快速地完成文件的读写操作。

1.2 简洁

EasyExcel 的 API 设计非常简洁，开发者只需掌握几个核心类和注解即可轻松实现复杂的 Excel 操作。这种设计降低了学习成本，同时提高了开发效率。

1.3 兼容 Apache POI

虽然 EasyExcel 是一个独立的工具，但它兼容 Apache POI 的部分操作。对于一些 EasyExcel 尚未支持的高级功能，可以通过 POI 补充实现，极大地提高了灵活性。

2. EasyExcel 的功能

2.1 读取 Excel 文件

EasyExcel 提供了简单的接口用于读取 Excel 数据，无需手动解析复杂的表格结构，只需定义对应的实体类即可轻松映射表格中的数据。

2.2 写入 Excel 文件

通过 EasyExcel，可以快速生成 Excel 文件，并支持自定义表头样式、列宽和单元格样式等。

2.3 填充 Excel 文件

EasyExcel 支持基于模板填充数据。这种方式非常适合生成格式复杂的报表，例如财务报表或统计报表，只需提供模板文件和填充数据即可完成生成。
在这里插入图片描述

3. 在项目中使用 EasyExcel

接下来，通过具体步骤讲解如何将 EasyExcel 集成到项目中，并实现 Excel 文件的读写和填充。

3.1 引入依赖

在使用 EasyExcel 之前，需要在项目的 pom.xml 文件中引入其依赖：

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

请确保版本号为最新稳定版，以获得最新特性和修复的 bug。

3.2 实体类的定义与注解

在使用 EasyExcel 时，实体类的定义非常重要。通过注解可以灵活地定义 Excel 的导入和导出规则。

以下是一个实体类的示例代码：

import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.alibaba.excel.annotation.write.style.HeadFontStyle;
import com.alibaba.excel.annotation.write.style.HeadRowHeight;

@ExcelIgnoreUnannotated // 忽略未标注的字段
@ColumnWidth(16) // 设置列宽
@HeadRowHeight(14) // 设置表头行高
@HeadFontStyle(fontHeightInPoints = 11) // 设置表头字体大小
public class Product {

    @ExcelProperty("商品名称") // 映射 Excel 表头
    private String name;

    @ExcelProperty("价格")
    private Double price;

    @ExcelProperty("库存")
    private Integer stock;

    // Getters 和 Setters
}

通过这些注解，EasyExcel 可以根据实体类自动生成表头，极大简化了开发工作。

3.3 工具类方法的实现

为了方便在项目中复用，可以封装一个工具类来处理 Excel 文件的读写操作。

以下是一个工具类示例：

import com.alibaba.excel.EasyExcel;
import java.util.List;

public class ExcelUtils {

    // 读取 Excel 文件
    public static <T> List<T> readExcel(String filePath, Class<T> clazz) {
        return EasyExcel.read(filePath).head(clazz).sheet().doReadSync();
    }

    // 写入 Excel 文件
    public static <T> void writeExcel(String filePath, List<T> data, Class<T> clazz) {
        EasyExcel.write(filePath, clazz).sheet("Sheet1").doWrite(data);
    }
}

3.4 在 Controller 中使用

在实际业务中，我们可以在 Controller 层调用上述工具类实现 Excel 的导入导出。

以下是一个示例代码：

import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.List;

@RestController
@RequestMapping("/excel")
public class ExcelController {

    // 导入 Excel
    @PostMapping("/import")
    public String importExcel(@RequestParam("file") MultipartFile file) throws IOException {
        List<Product> products = ExcelUtils.readExcel(file.getInputStream(), Product.class);
        // 处理业务逻辑
        return "导入成功，数据条数：" + products.size();
    }

    // 导出 Excel
    @GetMapping("/export")
    public void exportExcel(HttpServletResponse response) throws IOException {
        List<Product> products = fetchProducts(); // 从数据库获取数据
        response.setContentType("application/vnd.ms-excel");
        response.setHeader("Content-Disposition", "attachment;filename=products.xlsx");
        ExcelUtils.writeExcel(response.getOutputStream(), products, Product.class);
    }
}