阿里开源的这个库，让 Excel 导出不再复杂（简简单单的写）

2022-03-10 作者: 看山

你好，我是看山。

导出是中后台常见的功能，Excel文件是常见的导出格式。

在Java栈中，常用的是和。其中jxl最后的更新时间是2012，除了老系统中能看到影子，几乎见不到踪迹了。目前基本上是POI一统天下。

今天要说的EasyExcel阿里巴巴开源的Excel导出类库，是对POI的封装，实现了很多高级功能，并且留出扩展口，支持扩展定制化功能。打个比喻，POI相当于乐高积木，一个个的小积木可以自由组装，只能动手能力强，就可以随心所欲的组装。EasyExcel更像是把这些小积木提前组装好，想要搭建房子，就直接找组装好的屋顶、围墙就行。如果仅仅如此，那EasyExcel仅仅就是简单的工具包，其更加吸引人的地方是对于内存的控制，它通过压缩文件、分批读取、抛弃不重要数据、文件缓存等多种方式，降低内存消耗。

内容比较多，文内只会列出关键代码，想要完整源码，可以关注公号「看山的小屋」回复“easyexcel”获取。

最简单的写表格

开始之前，先定义一下基础类，这个类将贯穿全文，所有的功能都是在这个类的简单变形。

@Data
public class Item {
    @ExcelProperty("字符串标题")
    private String string;
    @ExcelProperty("日期标题")
    private Date date;
    @ExcelProperty("数字标题")
    private Double doubleData;
    @ExcelIgnore
    private String ignore;
}

根据头对象和列表向一个工作表中写一个表格

这是最简单的一种实现，只需要定义一个对象类，然后读取数据列表即可。

/**
 * 借助{@link com.alibaba.excel.write.builder.ExcelWriterSheetBuilder}自动创建{@link com.alibaba.excel.ExcelWriter}写入数据。
 * 
 * 提供列表和函数作为数据源
 */
public static void writeAutoWriter() {
    final String fileName = defaultFileName("writeAutoWriter");
    EasyExcelFactory.write(fileName)
            .head(Item.class)
            .sheet("模板")
            .doWrite(WriteSample::sampleItems);
}

EasyExcel提供了类，API方法也是fluent方式，可以如丝般顺滑的实现生成Excel文件。如果感觉太长，还可以直接写作，这是的子类，类似于别名。

不过，这种别名定义方式，在有些规范中属于，所以，根据自己或者公司规范选择吧。

方法的参数传的是导出文件的文件名，如果并不需要生成文件，只需要创建文件流，也可以传入一个输出流，这样就可以更加灵活的实现生成逻辑了。

方法是定义表头，只要传入一个类，就会读取这个类的所有字段作为表头。如果字段上注解，定义了，就会取的值作为表头。此处还有很多操作，比如，是数组，可以定义多个，如果是相邻字段定义了相同的表头，会合并单元格，表体内容会选择第一个单元格的内容。这个注解还可以定义、、等，后面会一一给出例子。

方法定义工作表，有多个重载方法，可以定义指明是第几个工作表，可以传入指明工作表名称。

方法就是写Excel文件了，传入全部的列表数据，或者使用Java8+的函数。还可以实现分页写入，后面会给出例子。这个方法会自动关闭文件流，真是很贴心。

结果为：

根据头对象和列表向多个工作表中写数据

上面是向一个工作表写数据，接下来我们向多个工作表写数据。

这个例子会涉及更多的内部对象，比如：ExcelWriter、WriteSheet。

/**
 * 手动创建{@link com.alibaba.excel.ExcelWriter}，指定sheet写入数据。
 * 
 * 提供列表和函数作为数据源
 */
public static void writeManualWither() {
    String fileName = defaultFileName("writeManualWriter");
    ExcelWriter excelWriter = null;
    try {
        excelWriter = EasyExcelFactory.write(fileName)
                .head(Item.class)
                .build();
        final WriteSheet writeSheet1 = EasyExcelFactory.writerSheet("模板1").build();
        excelWriter.write(WriteSample::sampleItems, writeSheet1);

        final WriteSheet writeSheet2 = EasyExcelFactory.writerSheet("模板2").build();
        excelWriter.write(sampleItems(), writeSheet2);
    } finally {
        // 千万别忘记finish 会帮忙关闭流
        if (excelWriter != null) {
            excelWriter.finish();
        }
    }
}

因为是想多个工作表中写数据，我们就不能直接使用方法了。

类是Excel写对象，用来创建Excel工作簿的。类是Sheet写对象，用来创建Sheet工作表的。通过方法，指定写入数据和写入的目标工作表，就可以实现向多个工作表中写数据的功能。

此处需要注意，我们在创建对象时，调用了方法定义了表头，这是整个Excel的定义，sheet会继承这个定义。这样，整个Excel文件中的所有工作表，表头都是相同的。不要停，后面会给出不同工作表定义不同表头的示例。

结果为：

按照定义指定导出列

在后台系统中，会有行列权限的控制。行权限，通过数据行实现，只导出有权限的行数据即可。列权限，可以通过只导出有权限的列，排除没有权限的列（通常是分等级的敏感数据）。

有时候需要定制化导出，导出所有列表格比较大，用户根据需要指定需要导出的列。

排除指定列

private static void writeExcludeColumn() {
    String fileName = defaultFileName("writeExcludeColumn");
    Set excludeColumnFiledNames = new HashSet<>();
    excludeColumnFiledNames.add("date");

    EasyExcelFactory.write(fileName)
            .head(Item.class)
            .excludeColumnFiledNames(excludeColumnFiledNames)
            .sheet("模板")
            .doWrite(WriteSample::sampleItems);
}

这个需求，需要借助方法。这个方法是在、、的父类中定义，也就是说，可以是整个Excel工作簿都排除指定字段，也可以是某个sheet工作表排除指定字段，还可以是table表格排除指定字段。

除了通过字段名排除字段，还可以使用指定字段下标排除列，如果需要控制下标，需要在字段上定义指明index属性，这样也能够更好的固定字段下标。

结果为：

只导出指定列

private static void writeIncludeColumn() {
    String fileName = defaultFileName("writeIncludeColumn");
    Set includeColumnFiledNames = new HashSet<>();
    includeColumnFiledNames.add("date");
    EasyExcelFactory.write(fileName)
            .head(Item.class)
            .includeColumnFiledNames(includeColumnFiledNames)
            .sheet("模板")
            .doWrite(WriteSample::sampleItems);
}

这个需求，需要借助方法。与是相似，都是可以分级定义，用起来也是一样的，只不过功能相反而已。

同样的，也可以使用方法，通过指定字段下标指定列。

结果为：

表头

表头的定义是比较关键的，会直接影响Excel文件的质量。所以，EasyExcel提供了比较丰富的表头定义方法。

原始表头

这里定义了一个新的基础类：，与的区别是移除了的定义。

@Data
public class EmptyItem {
    private String string;
    private Date date;
    private Double doubleData;
}

在这种情况下，会直接使用对象的字段作为表头名称。

private static void writeNoAnnotation() {
    final String fileName = defaultFileName("writeNoAnnotation");
    EasyExcelFactory.write(fileName)
            .head(EmptyItem.class)
            .sheet("模板")
            .doWrite(WriteSample::sampleItems);
}

这里可以看到，EasyExcel对于表头对象、表体列表对象，没有强制要求必须是相同的对象，只要字段一致，就能够正常组装数据。

结果为：

自定义表头

使用字段作为表头显然不是我们想要的，EasyExcel提供了注解，可以定义表头的名称。这个注解还提供了、两个属性，可以定义列的位置和顺序。

@Data
public class IndexItem {
    @ExcelProperty(value = "字符串标题", index = 1)
    private String string;
    @ExcelProperty(value = "日期标题", index = 3)
    private Date date;
    @ExcelProperty(value = "数字标题", index = 5)
    private Double doubleData;
}

使用起来也很简单：

private static void writeWithIndex() {
    final String fileName = defaultFileName("writeWithIndex");
    EasyExcelFactory.write(fileName)
            .head(IndexItem.class)
            .sheet("模板")
            .doWrite(WriteSample::sampleItems);
}

结果为：

这里需要注意一下，在使用注解时，index表示字段放置第几列，order表示顺序。

根据index和order的不同语义，对两者的控制不同。如果index相同，直接会抛出异常，因为程序无法判断这个列放那个字段。如果index值中间有空的数字，就会出现空列。如果order和index同时使用，index优先占据位置，order做排序。index=-1的话，使用java默认排序，order值越小，列越靠前。

的value属性是字符串数组，相当于一个字段可以定义多个头，这样就可以实现多级表头。同时，如果位置相邻的列定义列明相同，还会合并列。比如：

@Data
public class ComplexHeadItem {
    @ExcelProperty({"大标题", "字符串标题"})
    private String string;
    @ExcelProperty("日期标题")
    private Date date;
    @ExcelProperty({"大标题", "数字标题0"})
    private Double doubleData;
    @ExcelProperty({"数字标题"})
    private Double doubleData1;
    @ExcelProperty({"数字标题"})
    private Double doubleData2 = 0.0;
}

结果为：

动态表头、表体

前面的例子中，表头定义都是传入一个对象，通过解析对象的属性字段，抽取表头定义。有的时候，我们没有办法提前定义表头对象，或者说，表头是根据条件、权限等因素动态变化的，这个时候，就可以使用EasyExcel提供的动态表头功能了。

/**
 * 动态表头，传入的是{@code List>}格式数据。
 * 
 * 可以实现多层表头。
 */
private static void writeDynamicHead() {
    String fileName = defaultFileName("writeDynamicHead");
    EasyExcelFactory.write(fileName)
            .head(dynamicHead())
            .sheet()
            .doWrite(sampleItems());
}

private static List> dynamicHead() {
    List> heads = new ArrayList<>();
    final List head0 = new ArrayList<>(Arrays.asList("头0", "字符串标题【动态】"));
    heads.add(head0);
    final List head1 = new ArrayList<>(Arrays.asList("头0", "日期标题【动态】"));
    heads.add(head1);
    final List head2 = new ArrayList<>(Collections.singletonList("数字标题【动态】"));
    heads.add(head2);
    return heads;
}

使用方法，传入类型的数据即可。

结果为：

当然，这样做还不是彻底的动态。我们可以使用实现动态表体。代码如下：

private static void writeDynamicData() {
    String fileName = defaultFileName("writeDynamicData");
    EasyExcelFactory.write(fileName)
            .head(dynamicHead())
            .sheet()
            .doWrite(dynamicData());
}

private static List> dynamicData() {
    List> list = new ArrayList<>();
    for (int i = 0; i < 10; i++) {
        List