产品需求

产品经理需要导出一个页面的所有的信息到 EXCEL 文件。

需求分析

对于 excel 导出，是一个很常见的需求。

最常见的解决方案就是使用 poi 直接同步导出一个 excel 文件。

客户体验 & 服务性能

  • 客户体验

如果导出的文件比较大，比如几十万条数据，同步导出页面就会卡主，用户无法进行其他操作。

  • 服务性能

导出的时候，任务比较耗时就会阻塞主线程。

如果导出的服务是暴露给外部（前后端分离），这种大量的数据传输十分消耗性能。

解决方案

使用异常处理导出请求，后台 MQ 通知自己进行处理。

MQ 消费之后，多线程处理 excel 文件导出，生成文件后上传到 FTP 等文件服务器。

前端直接查询并且展现对应的任务执行列表，去 FTP 等文件服务器下载文件即可。

EXCEL 导出需要考虑的问题

OOM

正常的 poi 在处理比较大的 excel 的时候，会出现内存溢出。

网上的解决方案也比较多。

比如官方的 SXSSF (Since POI 3.8 beta3) 解决方式。

或者使用封装好的包

  1. easypoi ExcelBatchExportServer

  2. hutool BigExcelWriter

原理都是强制使用 xssf 版本的Excel。

你也可以使用 easyexcel，当然这个注释文档有些欠缺，而且设计的比较复杂，不是很推荐。

我这里使用的是 hutool BigExcelWriter，
懒得自己再写一遍。

FULL GC

如果一次查询 100W 条数据库，然后把这些信息全部加载到内存中，是不可取的。

建议有2个：

  1. 限制每一次分页的数量。比如一次最多查询 1w 条。分成 100 次查询。(必须)

  2. 限制查询得总条数。比如限制为最多 10W 条。（根据实际情况选择）

虽然使用者提出要导出类似于 3 个月的所有信息，但是数量太多，毫无意义。(提出者自己可能体会不到)

尽量避免 FULL-GC 的情况发生，因为目前的所有方式对于 excel 的输出流都会占用内存，100W 条很容易导致 FULL-GC。

数据库的压力

去数据库读取的时候一定要记得分页，免得给数据库太大的压力。

一次读取太多，也会导致内存直线上升。

比如 100W 条数据，则分成 100 次去数据库读取。

网络传输

传统的 excel 导出，都是前端一个请求，直接 HTTP 同步返回。导出 100W 条，就在那里傻等。

这客户体验不友好，而且网络传输，系统占用多种问题。

建议使用异步处理的方式，将文件上传到文件服务器。前端直接去文件服务器读取。

编程的便利性

对于上面提到的工具，比如 Hutool，在表头的处理方面没法很方便的统一。

你可以自己定义类似于 easypoi/easyexcel 中的注解，自己反射解析。

然后统一处理表头即可。

IExcel 方便优雅的 excel 框架

特性

  • OO 的方式操作 excel，编程更加方便优雅。

  • sax 模式读取，SXSS 模式写入。避免 excel 大文件 OOM。

  • 基于注解，编程更加灵活。

  • 写入可以基于对象列表，也可以基于 Map，实际使用更加方便。

  • 设计简单，注释完整。方便大家学习改造。

后期特性

  • 读取跳过空白行

  • excel 样式相关的注解开发

创作缘由

实际工作和学习中，apache poi 操作 excel 过于复杂。

近期也看了一些其他的工具框架：

  • easypoi

  • easyexcel

  • hutool-poi

都或多或少难以满足自己的实际需要，于是就自己写了一个操作 excel 导出的工具。

快速开始

引入 Jar

使用 maven 管理。


     com.github.houbb
     iexcel
     0.0.2

定义对象

你可以直接参考 ExcelUtilTest.java

定义一个需要写入/读取的 excel 对象。

  • ExcelFieldModel.java

只有声明了 @ExcelField 的属性才会被处理，使用说明：@ExcelField

public class ExcelFieldModel {

    @ExcelField
    private String name;

    @ExcelField(headName = "年龄")
    private String age;

    @ExcelField(mapKey = "EMAIL", writeRequire = false, readRequire = false)
    private String email;

    @ExcelField(mapKey = "ADDRESS", headName = "地址", writeRequire = true)
    private String address;

    //getter and setter
}

写入例子

IExcelWriter 的实现

IExcelWriter 有几个实现类，你可以直接 new 或者借助 ExcelUtil 类去创建。

IExcelWriter 实现类 ExcelUtil 如何创建 说明
HSSFExcelWriter ExcelUtil.get03ExcelWriter() 2003 版本的 excel
XSSFExcelWriter ExcelUtil.get07ExcelWriter() 2007 版本的 excel
SXSSFExcelWriter ExcelUtil.getBigExcelWriter() 大文件 excel，避免 OOM

IExcelWriter 接口说明

写入到 2003

  • excelWriter03Test()

一个将对象列表写入 2003 excel 文件的例子。

/**
 * 写入到 03 excel 文件
 */
@Test
public void excelWriter03Test() {
    // 待生成的 excel 文件路径
    final String filePath = "excelWriter03.xls";

    // 对象列表
    List models = buildModelList();

    try(IExcelWriter excelWriter = ExcelUtil.get03ExcelWriter();
        OutputStream outputStream = new FileOutputStream(filePath)) {
        // 可根据实际需要，多次写入列表
        excelWriter.write(models);

        // 将列表内容真正的输出到 excel 文件
        excelWriter.flush(outputStream);
    } catch (IOException e) {
        throw new ExcelRuntimeException(e);
    }
}
  • buildModelList()
/**
 * 构建测试的对象列表
 * @return 对象列表
 */
private List buildModelList() {
    List models = new ArrayList<>();
    ExcelFieldModel model = new ExcelFieldModel();
    model.setName("测试1号");
    model.setAge("25");
    model.setEmail("[email protected]");
    model.setAddress("贝克街23号");

    ExcelFieldModel modelTwo = new ExcelFieldModel();
    modelTwo.setName("测试2号");
    modelTwo.setAge("30");
    modelTwo.setEmail("[email protected]");
    modelTwo.setAddress("贝克街26号");

    models.add(model);
    models.add(modelTwo);
    return models;
}

一次性写入到 2007 excel

有时候列表只写入一次很常见，所有就简单的封装了下：

/**
 * 只写入一次列表
 * 其实是对原来方法的简单封装
 */
@Test
public void onceWriterAndFlush07Test() {
    // 待生成的 excel 文件路径
    final String filePath = "onceWriterAndFlush07.xlsx";

    // 对象列表
    List models = buildModelList();

    // 对应的 excel 写入对象
    IExcelWriter excelWriter = ExcelUtil.get07ExcelWriter();

    // 只写入一次列表
    ExcelUtil.onceWriteAndFlush(excelWriter, models, filePath);
}

读取例子

excel 读取时会根据文件名称判断是哪个版本的 excel。

IExcelReader 的实现

IExcelReader 有几个实现类，你可以直接 new 或者借助 ExcelUtil 类去创建。

IExcelReader 实现类 ExcelUtil 如何创建 说明
ExcelReader ExcelUtil.getExcelReader() 小文件的 excel 读取实现
Sax03ExcelReader ExcelUtil.getBigExcelReader() 大文件的 2003 excel 读取实现
Sax07ExcelReader ExcelUtil.getBigExcelReader() 大文件的 2007 excel 读取实现

IExcelReader 接口说明

excel 读取的例子

/**
 * 读取测试
 */
@Test
public void readWriterTest() {
    File file = new File("excelWriter03.xls");
    IExcelReader excelReader = ExcelUtil.getExcelReader(file);
    List models = excelReader.readAll(ExcelFieldModel.class);
    System.out.println(models);
}

ExcelField 注解说明

@ExcelField 的属性说明如下：

属性 类型 默认值 说明
mapKey String "" 仅用于生成的入参为 map 时,会将 map.key 对应的值映射到 bean 上。如果不传：默认使用当前字段名称
headName String "" excel 表头字段名称，如果不传：默认使用当前字段名称
writeRequire boolean true excel 文件是否需要写入此字段
readRequire boolean true excel 文件是否读取此字段

IExcelWriter 接口说明

/**
 * 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件

 * 

 * data中元素支持的类型有：
 *  
 * 1. Bean，既元素为一个Bean，第一个Bean的字段名列表会作为首行，剩下的行为Bean的字段值列表，data表示多行 

 * 

 * @param data 数据
 * @return this
 */
IExcelWriter write(Collection data);

/**
 * 写出数据，本方法只是将数据写入Workbook中的Sheet，并不写出到文件

 *  将 map 按照 targetClass 转换为对象列表
 *  应用场景: 直接 mybatis mapper 查询出的 map 结果，或者其他的构造结果。
 * @param mapList map 集合
 * @param targetClass 目标类型
 * @return this
 */
IExcelWriter write(Collection> mapList, final Class targetClass);

/**
 * 将Excel Workbook刷出到输出流
 *
 * @param outputStream 输出流
 * @return this
 */
IExcelWriter flush(OutputStream outputStream);

指定 sheet

创建 IExcelWriter 的时候，可以指定 sheet 的下标或者名称。来指定写入的 sheet。

是否包含表头

创建 IExcelWriter 的后，可以调用 excelWriter.containsHead(bool) 指定是否生成 excel 表头。

IExcelReader 接口说明

/**
 * 读取当前 sheet 的所有信息
 * @param tClass 对应的 javabean 类型
 * @return 对象列表
 */
List readAll(Class tClass);

/**
 * 读取指定范围内的
 * @param tClass 泛型
 * @param startIndex 开始的行信息(从0开始)
 * @param endIndex 结束的行信息
 * @return 读取的对象列表
 */
List read(Class tClass, final int startIndex, final int endIndex);

指定 sheet

创建 IExcelReader 的时候，可以指定 sheet 的下标或者名称。来指定读取的 sheet。

注意：大文件 sax 读取模式，只支持指定 sheet 的下标。

是否包含表头

创建 IExcelReader 的后，可以调用 excelReader.containsHead(bool) 指定是否读取 excel 表头。

拓展阅读

excel 导出最佳实践

iexcel 框架