EasyExcel进阶教程

EasyExcel进阶教程

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模式，在上层做了模型转换的封装，让使用者更加简单方便。

——引自EasyExcel官网

概述

EasyExcel官网对读和写（其中包括常规的导出和模板填充的导出）的基础操作已经很到位了。但也仅仅是基础操作。在实际应用中，对Excel的解析往往会有更加复杂的操作，比如动态表头、表头样式动态设置、单元格内容设置（如下拉框）等等。笔者结合自己的使用经验，对一些官网示范不是很明显的功能在此进行简单介绍，可能会不定时持续更新。

一、关于表头

1.1 多级表头

EasyExcel支持多级表头，其表现形式如下图：

以上例图中，用户数据汇总为一级表头；ID、用户名称为二级表头。多级表头在实际应用中也比较常见。其代码实现也很简单，只需要设置对应实体类中@ExcelProperties注解中的value字段值即可：

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class DemoData {
   
    @ExcelProperty(value = {
   "用户数据汇总", "ID"}, index = 0)
    private String id;
    @ExcelProperty(value = {
   "用户数据汇总", "用户名称"}, index = 1)
    private String userName;
}

@ExcelProperties注解中的value字段类型为一个字符串数组，该数组的长度即为Excel中表头级数。而index则为字段的排序，且为严格排序。

1.2 ExcelProperties注解的index字段和order字段的第一个区别

何谓严格排序？换句话说，就是index=0的字段一定会出现在A列，index=2的字段一定会出现在C列。再换句话说，如果你的实体类中的index的值不是连续的，那就意味着你导出的Excel中会有空白列。比如下面的实体类：

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class DemoData {
   
    @ExcelProperty(value = {
   "用户数据汇总", "ID"}, index = 0)
    private String id;
    @ExcelProperty(value = {
   "用户数据汇总", "用户名称"}, index = 1)
    private String userName;
    @ExcelProperty(value = {
   "用户数据汇总", "性别"}, index = 3)
    private String gender;
}

注意index的值没有2，这意味着导出的Excel的C列是空的，效果如下：

那么问题来了：如果我只是想用数字的大小表示字段的排列顺序，而不想空出一列怎么办呢？很简单，不要使用@ExcelProperties的index属性，改用其order属性就可以了：

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class DemoData {
   
    @ExcelProperty(value = {
   "用户数据汇总", "ID"}, order = 0)
    private String id;
    @ExcelProperty(value = {
   "用户数据汇总", "用户名称"}, order = 1)
    private String userName;
    @ExcelProperty(value = {
   "用户数据汇总", "性别"}, order = 3)
    private String gender;
}

这个实体类的@ExcelProperties注解的order字段的值从1直接跳到了3，效果如下图：

1.3 ExcelProperties注解的index字段和order字段的第二个区别

@ExcelProperties注解的order字段的值可以重复，但@ExcelProperties注解的index字段的值不可以重复，否则会报错：

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class DemoData {
   
    @ExcelProperty(value = {
   "用户数据汇总", "ID"}, index = 0)
    private String id;
    @ExcelProperty(value = {
   "用户数据汇总", "用户名称"}, index = 0)
    private String userName;
}

如上示例代码，id字段和userName字段的索引值都是0，在运行时会抛出com.alibaba.excel.exception.ExcelCommonException异常：

1.4 表头单元格的合并

另外还需要注意的一点是，@ExcelProperties注解的value字段是用来填充Excel文件的表头的。如果相邻索引的同级表头名称相同，则EasyExcel会自动将他们合并单元格，具体表现形式即为一级表头用户数据汇总那样。为便于直观理解，请看如下示例（Tips：示例代码中排序使用index字段或是order字段，不会影响本小节效果）：

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class DemoData {
   
    @ExcelProperty(value = {
   "用户数据汇总", "ID"}, index = 0)
    private String id;
    @ExcelProperty(value = {
   "用户数据汇总", "用户名称"}, index = 1)
    private String userName;
    @ExcelProperty(value = {
   "用户数据汇总", "性别"}, index = 2)
    private String gender;
    @ExcelProperty(value = {
   "用户数据汇总", "性别"}, index = 3)
    private String genderCn;
    @ExcelProperty(value = {
   "用户数据汇总", "生日"}, index = 4)
    private String birthDay;
    @ExcelProperty(value = {
   "用户数据汇总", "用户名称"}, index = 5)
    private String userNameCn;
}

在上面的实体类中，字段gender和genderCn的二级表头同为“性别”且索引值相邻；字段userName和userNameCn的二级表头同为“用户名称”，但索引值不相邻。其效果图如下：

可以看到，两个性别字段因为相邻且表头名相同，被自动合并单元格了；而两个同为用户名称的字段则因为不相邻，所以并未被合并。

关于表头的一些基础注意事项就写到这里。

二、动态表头

在实际业务中，我们需要导出的Excel表头可能是这样的：

其中一级表头的“XXXX”都是动态的。即2024年5月导出的一级表头是“2024年05月数据汇总”，而2024年4月份导出的一级表头就成了“2024年04月数据汇总”。EasyExcel可以处理这种场景，但是官网的示例展示的不是很明显。
处理这种业务场景，我们需要自己封装一个处理器，该处理器需要实现EasyExcel的CellWriteHandler处理器，并重写其afterCellDispose方法；同时在注解实体类时，要预留出动态值的填充位置：
实体类的注解如下：

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