JAVA：探索 EasyExcel 的技术指南

1、简述

在 Java 开发中，Excel 文件的读写操作是一项常见的需求。阿里巴巴开源的 EasyExcel 提供了一种高效、简洁的解决方案，特别是在处理大规模数据时表现尤为突出。本文将详细介绍 EasyExcel 的优缺点、应用场景，并通过实例展示其基本用法。

EasyExcel 官方文档
GitHub - EasyExcel

官网已停止维护

2、需求

JAVA 解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存，poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题，但POI还是有一些缺陷，比如07版Excel解压缩以及解压后存储都是在内存中完成的，内存消耗依然很大。
EasyExcel 重写了poi对07版Excel的解析，一个3M的excel用POI sax解析依然需要100M左右内存，改用 EasyExcel 可以降低到几M，并且再大的excel也不会出现内存溢出；03版依赖POI的sax模式，在上层做了模型转换的封装，让使用者更加简单方便。

3、应用

EasyExcel 是一个用于读写 Excel 文件的开源 Java 库。与传统的 Apache POI 相比，EasyExcel 通过减少内存消耗、简化代码结构，使得处理 Excel 文件变得更加轻松，特别是在处理大文件时优势明显。

3.1 Maven 依赖

首先，在项目的 pom.xml 中添加 EasyExcel 的 Maven 依赖：

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

3.2 写入 Excel 文件

以下代码展示了如何使用 EasyExcel 将数据写入到一个 Excel 文件中：

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.annotation.ExcelProperty;

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

public class EasyExcelWriteExample {
    public static void main(String[] args) {
        String fileName = "simpleWrite.xlsx";

        // 数据准备
        List<UserData> data = new ArrayList<>();
        data.add(new UserData(1, "Alice", "alice@example.com"));
        data.add(new UserData(2, "Bob", "bob@example.com"));

        // 写入数据到 Excel 文件
        EasyExcel.write(fileName, UserData.class).sheet("用户信息").doWrite(data);
    }
}

// 定义数据类
class UserData {
    @ExcelProperty("用户ID")
    private Integer id;

    @ExcelProperty("用户名")
    private String name;

    @ExcelProperty("邮箱")
    private String email;

    public UserData(Integer id, String name, String email) {
        this.id = id;
        this.name = name;
        this.email = email;
    }

    // Getters and Setters
}

代码解释:

• UserData 类通过注解 @ExcelProperty 指定了 Excel 列名和属性的映射关系。
• 使用 EasyExcel.write() 方法指定写入的文件名和数据类，然后通过 sheet() 方法指定工作表名称，最后调用 doWrite() 将数据写入 Excel 文件。

3.3 读取 Excel 文件

下面的代码展示了如何使用 EasyExcel 从 Excel 文件中读取数据：

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;

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

public class EasyExcelReadExample {
    public static void main(String[] args) {
        String fileName = "simpleWrite.xlsx";

        // 读取数据
        EasyExcel.read(fileName, UserData.class, new UserDataListener()).sheet().doRead();
    }
}

// 定义数据类（与写入时相同）
class UserData {
    @ExcelProperty("用户ID")
    private Integer id;

    @ExcelProperty("用户名")
    private String name;

    @ExcelProperty("邮箱")
    private String email;

    // Getters and Setters
}

// 定义读取时的监听器
class UserDataListener extends AnalysisEventListener<UserData> {
    private List<UserData> list = new ArrayList<>();

    @Override
    public void invoke(UserData data, AnalysisContext context) {
        System.out.println("读取到数据: " + data);
        list.add(data);
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        System.out.println("所有数据读取完成！");
    }
}

代码解释:

• 读取操作使用 EasyExcel.read() 方法，指定要读取的文件名、数据类以及处理读取数据的监听器。
• AnalysisEventListener 用于处理每一行读取到的数据，通过 invoke() 方法逐行处理数据，doAfterAllAnalysed() 方法在所有数据读取完成后执行。

4、场景

4.1 优点

• 内存消耗低: EasyExcel 使用流式写入和 SAX 方式解析 Excel 文件，极大减少了内存使用，适合处理大数据量的 Excel 文件。
• 代码简洁: EasyExcel 提供了简洁的 API，可以在几行代码内完成复杂的 Excel 操作，降低了开发和维护的成本。
• 支持多种 Excel 格式: 支持 .xls 和 .xlsx 格式的读写操作。
• 支持复杂的 Excel 模板: 可以处理带有图片、表格、合并单元格等复杂模板的 Excel 文件。
• 社区活跃: 作为阿里巴巴的开源项目，EasyExcel 有着良好的社区支持和持续更新。

4.2 缺点

• 功能覆盖面有限: 相比于 Apache POI，EasyExcel 主要聚焦于数据读写，缺乏对 Excel 文件内部结构的全面操作支持。
• 较少的定制化支持: 在某些高级功能上，EasyExcel 的定制化能力较弱，例如复杂样式的设置。
• 学习曲线: 对于熟悉 Apache POI 的开发者来说，EasyExcel 的 API 可能需要一定的适应时间。

4.3 应用场景

• 大规模数据导出: 由于其低内存消耗的特点，EasyExcel 特别适合用于导出包含大量数据的 Excel 文件，如报表生成、数据备份等。
• 轻量级 Excel 操作: 对于简单的数据导入导出任务，EasyExcel 提供了极简的 API，使得开发者可以快速实现功能。
• 实时数据导出: 在需要实时生成并导出 Excel 的场景下，EasyExcel 可以在占用最小内存的情况下，高效完成任务。

5、 总结

EasyExcel 作为一种高效的 Excel 读写工具，在处理大规模数据时表现突出。其低内存消耗和简洁的 API 设计，使得开发者能够快速实现 Excel 文件的读写操作。然而，EasyExcel 也存在一些功能上的局限性，尤其是在需要复杂 Excel 操作时。因此，开发者应根据具体需求选择合适的工具。

通过这篇博客，希望你对 EasyExcel 的使用有了更清晰的理解，并能够在实际项目中有效应用。如果你有任何疑问或建议，欢迎在评论区交流讨论。