阿里出品Excel工具EasyExcel使用小结

本文介绍了阿里出品的Excel处理工具EasyExcel的使用经验,包括如何引入依赖、API简介、实用技巧,如多线程读取、多Sheet写入、分页查询和批量写入,以及Excel上传与下载的实现方法。通过示例代码展示了EasyExcel在处理大数据量Excel时的优化策略。

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

前提#

笔者做小数据和零号提数工具人已经有一段时间,服务的对象是运营和商务的大佬,一般要求导出的数据是Excel文件,考虑到初创团队机器资源十分有限的前提下,选用了阿里出品的Excel工具EasyExcel。这里简单分享一下EasyExcel的使用心得。EasyExcel从其依赖树来看是对apache-poi的封装,笔者从开始接触Excel处理就选用了EasyExcel,避免了广泛流传的apache-poi导致的内存泄漏问题。

引入EasyExcel依赖#

引入EasyExcel的Maven如下:

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>${easyexcel.version}</version>
</dependency>

API简介#

Excel文件主要围绕读和写操作进行处理,EasyExcel的API也是围绕这两个方面进行设计。先看读操作的相关API:

// 新建一个ExcelReaderBuilder实例
ExcelReaderBuilder readerBuilder = EasyExcel.read();
// 读取的文件对象,可以是File、路径(字符串)或者InputStream实例
readerBuilder.file("");
// 文件的密码
readerBuilder.password("");
// 指定sheet,可以是数字序号sheetNo或者字符串sheetName,若不指定则会读取所有的sheet
readerBuilder.sheet("");
// 是否自动关闭输入流
readerBuilder.autoCloseStream(true);
// Excel文件格式,包括ExcelTypeEnum.XLSX和ExcelTypeEnum.XLS
readerBuilder.excelType(ExcelTypeEnum.XLSX);
// 指定文件的标题行,可以是Class对象(结合@ExcelProperty注解使用),或者List<List<String>>实例
readerBuilder.head(Collections.singletonList(Collections.singletonList("head")));
// 注册读取事件的监听器,默认的数据类型为Map<Integer,String>,第一列的元素的下标从0开始
readerBuilder.registerReadListener(new AnalysisEventListener() {

    @Override
    public void invokeHeadMap(Map headMap, AnalysisContext context) {
        // 这里会回调标题行,文件内容的首行会认为是标题行
    }

    @Override
    public void invoke(Object o, AnalysisContext analysisContext) {
        // 这里会回调每行的数据
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {

    }
});
// 构建读取器
ExcelReader excelReader = readerBuilder.build();
// 读取数据
excelReader.readAll();
excelReader.finish();

可以看到,读操作主要使用Builder模式和事件监听(或者可以理解为观察者模式)的设计。一般情况下,上面的代码可以简化如下:

Map<Integer, String> head = new HashMap<>();
List<Map<Integer, String>> data = new LinkedList<>();
EasyExcel.read("文件的绝对路径").sheet()
        .registerReadListener(new AnalysisEventListener<Map<Integer, String>>() {

            @Override
            public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
                head.putAll(headMap);
            }

            @Override
            public void invoke(Map<Integer, String> row, AnalysisContext analysisContext) {
                data.add(row);
            }

            @Override
            public void doAfterAllAnalysed(AnalysisContext analysisContext) {
                    // 这里可以打印日志告知所有行读取完毕
            }
        }).doRead();

如果需要读取数据并且转换为对应的对象列表,则需要指定标题行的Class,结合注

### 使用阿里巴巴 EasyExcel 实现模板导出 Excel 文件 要通过阿里巴巴的 EasyExcel 库实现模板导出功能,可以按照以下方式操作。EasyExcel 提供了一种灵活的方式来读取和写入 Excel 数据,并支持基于模板的方式生成复杂的 Excel 文档。 以下是具体的代码示例以及说明: #### Maven 依赖配置 首先,在项目的 `pom.xml` 中引入 EasyExcel 的依赖项[^1]: ```xml <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>3.3.2</version> </dependency> ``` #### 创建模板类 为了使用模板导出功能,需要定义一个 Java 类作为数据模型。假设我们要导出员工信息表,则可以创建如下实体类: ```java public class EmployeeData { private String name; private Integer age; private String department; // Getters and Setters } ``` #### 编写模板导出逻辑 下面是一个完整的代码片段,展示如何利用 EasyExcel 进行模板填充并导出 Excel 文件: ```java import com.alibaba.excel.EasyExcel; import java.util.ArrayList; import java.util.List; public class TemplateExportExample { public static void main(String[] args) { // 设置模板路径 (确保该路径下存在对应的 Excel 模板文件) String templateFilePath = "path/to/your/template.xlsx"; // 导出的目标文件路径 String exportFilePath = "path/to/exported/file.xlsx"; // 准备数据列表 List<EmployeeData> data = new ArrayList<>(); data.add(new EmployeeData("Alice", 28, "HR")); data.add(new EmployeeData("Bob", 30, "Engineering")); // 调用 EasyExcel 方法完成模板填充与导出 EasyExcel.write(exportFilePath).withTemplate(templateFilePath).sheet().doFill(data); } } // 定义数据对象 class EmployeeData { private String name; private Integer age; private String department; // 构造函数、Getters 和 Setters public EmployeeData() {} public EmployeeData(String name, Integer age, String department) { this.name = name; this.age = age; this.department = department; } public String getName() { return name; } public void setName(String name) { this.name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } public String getDepartment() { return department; } public void setDepartment(String department) { this.department = department; } } ``` 上述代码实现了以下几个核心步骤: 1. **指定模板文件路径**:提供一个预设好的 Excel 模板文件。 2. **准备数据源**:构建待填入的数据集合。 3. **调用 API 填充模板**:借助 `EasyExcel.write(...).withTemplate(...)...doFill()` 方法完成模板替换与保存。 此方法充分利用了 EasyExcel 的强大特性——即无需手动解析单元格位置即可快速完成复杂文档的自动化生成功能[^2]。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值