AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

阿里开源的这个库，让Excel导出不再复杂（填充模板的使用指南）

2021-12-07 1704
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 前文 说了写操作，可以实现简单的列表导出，还能 定义样式。有时候，我们还需要导出的一个大表单，或者是表单+列表的形式，这个时候，我们就需要填充功能。

image.png

该图片由宅-KEN在Pixabay上发布


你好，我是看山。


前文 说了写操作，可以实现简单的列表导出，还能 定义样式。有时候，我们还需要导出的一个大表单，或者是表单+列表的形式，这个时候，我们就需要填充功能。


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


在 EasyExcel 中，写操作可以完成大部分工作，填充的优势在于，可以实现自定义样式的，只要在模板中设置好样式，填充的数据就能够带着样式。


先写个表单

既然是使用模板，写来定义一个模板。

image.png



在 EasyExcel 的模板填充定义中，使用{}来表示你要用的变量，如果本来就有"{","}“特殊字符，需要对其进行转义，用”{","}"代替。


写对象

既然是写对象，先定义一下对象结构。


@Data
public class Item {
    private String name;
    private double number;
}

然后开始填充：


private static void fillUseObject() {
    String fileName = defaultFileName("fillUseObject");
    String templateFile = getPath() + File.separator + "template_fill_sample.xlsx";
    Item item = new Item();
    item.setName("法外狂徒张三");
    item.setNumber(89757);
    EasyExcelFactory.write(fileName)
            .withTemplate(templateFile)
            .sheet()
            .doFill(item);
}

在写操作中我们也使用过模板写列表，这里填充模板，使用的是同样的方法：com.alibaba.excel.write.builder.ExcelWriterBuilder#withTemplate(java.lang.String)指定模板文件路径，这里再重复一遍。withTemplate 方法有几个重载实现：


指定模板文件路径ExcelWriterBuilder#withTemplate(java.lang.String)

指定模板文件对象ExcelWriterBuilder#withTemplate(java.io.File)

指定模板文件输入流ExcelWriterBuilder#withTemplate(java.io.InputStream)

指定模板文件和模板文件对象都是操作文件的，需要有文件信息。


指定模板文件输入流是只要文件流，这个可操作性空间就比较大了。比如，模板文件是可变的，我们可以基于一个带变量的模板文件，使用填充写入的方式初始化模板文件，然后再用模板写入的方式，写入列表。


结果为：

image.png


写 Map

我们也可以不用非得创建类，用 Map 也能实现相同的功能。


private static void fillUseMap() {
    String fileName = defaultFileName("fillUseMap");
    String templateFile = getPath() + File.separator + "template_fill_sample.xlsx";
    Map<String, Object> data = new HashMap<>();
    data.put("name", "法外狂徒张三");
    data.put("number", 89757);
    EasyExcelFactory.write(fileName)
            .withTemplate(templateFile)
            .sheet()
            .doFill(data);
}

虽然 Map 能够功能相同，不过还是建议定义具体的类。因为类是可校验的，Map 是弱检测机制，纯靠约定或者测试，不是很安全。


结果为：

image.png



从效果上看，结果是相同的。


再写个列表

先定义模板：

image.png



可以看到，填充列表的参数定义，与填充对象的有些差别，模板中{.}多了个点。


对于表格的场景，从大体上会分为少量数据和大量数据。对于少量数据，直接在内存中操作即可。对于大量数据，可以使用分批写入，借助文件缓存的方式节省内存。


少量写

上代码：


private static void fillListInMemory() {
    String fileName = defaultFileName("fillListInMemory");
    String templateFile = getPath() + File.separator + "template_fill_list.xlsx";
    EasyExcelFactory.write(fileName)
            .withTemplate(templateFile)
            .sheet()
            .doFill(sampleItems());
}

可以看到，填充列表与前文说到的写文件操作在代码实现上没有太大差异，这也是 EasyExcel 架构设计上的强悍。通过建造器模式的 fluent 写法，屏蔽啰嗦的写入，同时也屏蔽不同业务实现参数的差异，只在doFill的时候，根据不同参数实现不同逻辑。


结果为：

image.png



大量写

接下来就是大量数据填充了。与上面的差异在于需要手动创建ExcelWriter和WriteSheet对象，然后使用com.alibaba.excel.ExcelWriter.fill方法多次写入数据。


fill方法支持直接写入列表和使用 lambda 函数方式，注意是fill，不是doFill。doFill会调用finish方法自动关闭流，fill方法只做数据填充，需要手动关闭流。


代码为：


private static void fillListSegment() {
    String fileName = defaultFileName("fillListSegment");
    String templateFile = getPath() + File.separator + "template_fill_list.xlsx";
    final ExcelWriter excelWriter = EasyExcelFactory.write(fileName).withTemplate(templateFile).build();
    try {
        final WriteSheet writeSheet = EasyExcelFactory.writerSheet().build();
        excelWriter.fill(BaseFill::sampleItems, writeSheet);
        excelWriter.fill(sampleItems(), writeSheet);
    } finally {
        if (excelWriter != null) {
            excelWriter.finish();
        }
    }
}

结果为：

image.png



最后写个表单+列表

最后来个表单与列表的形式。比如销售统计，表头需要填写参数信息，比如店铺信息、时间等，然后是销售记录，最后需要增加类似合计之类的信息。


这种的话，可以实现的方式也挺多，这里介绍固定列表的实现，在技巧篇中会再介绍一种动态列表的实现。


填充对象+列表

先定义模板：

image.png



从模板中可以看到，开头是时间信息，结尾有统计信息，中间是一个列表。


上代码：

/**
 * 填充对象+列表，因为列表之后还有一个字段，所以需要将{@link FillConfigBuilder#forceNewRow(Boolean)}设置为 TRUE 才行。
 * <p>
 * 这样会有一个副作用：所有数据会在内存中，即数据量大的时候特别耗内存。
 * <p>
 * 想要解决有两种方式：
 *
 * <ul>
 *     <li>list 之后没有数据了，{@link FillConfigBuilder#forceNewRow(Boolean)}设置为 FALSE</li>
 *     <li>list 写完之后，手动写后面的数据</li>
 * </ul>
 */
private static void fillObjectAndListInMemory() {
    String fileName = defaultFileName("fillObjectAndListInMemory");
    String templateFile = getPath() + File.separator + "template_fill_object_and_list.xlsx";
    final ExcelWriter excelWriter = EasyExcelFactory.write(fileName).withTemplate(templateFile).build();
    try {
        final WriteSheet writeSheet = EasyExcelFactory.writerSheet().build();
        Map<String, Object> map = new HashMap<>();
        map.put("date", DateTimeFormatter.ISO_LOCAL_DATE_TIME.format(LocalDateTime.now()));
        map.put("total", System.currentTimeMillis());
        excelWriter.fill(map, writeSheet);
        FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
        excelWriter.fill(BaseFill::sampleItems, fillConfig, writeSheet);
        excelWriter.fill(sampleItems(), fillConfig, writeSheet);
    } finally {
        if (excelWriter != null) {
            excelWriter.finish();
        }
    }
}

这里有一个新增的配置类：FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build()，这个是用来定义写入时的配置信息。配置为 true，代表在写入列表的时候，不管下面有没有空行，都会创建一行，然后下面的数据往后移动。如果不定义或者设置为 false，最后那行的统计信息会被覆盖。


但是只要设置为 true 了，整个填充操作将都在内存中操作，比较耗费内存。


结果为：

image.png



填充对象+列表（大数据量）

如果列表数据比较大，还在内存中操作就比较容易内存溢出了。所以需要特殊的操作：


列表之后没有表单填充了，这种最容易实现，一句话实现不了，改需求。

只能在列表之后手动写数据

代码如下：


private static void fillObjectAndListManual() {
    String fileName = defaultFileName("fillObjectAndListManual");
    String templateFile = getPath() + File.separator + "template_fill_object_and_list_manual.xlsx";
    final ExcelWriter excelWriter = EasyExcelFactory.write(fileName).withTemplate(templateFile).build();
    try {
        final WriteSheet writeSheet = EasyExcelFactory.writerSheet().build();
        Map<String, Object> map = new HashMap<>();
        map.put("date", DateTimeFormatter.ISO_LOCAL_DATE_TIME.format(LocalDateTime.now()));
        excelWriter.fill(map, writeSheet);
        FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
        excelWriter.fill(BaseFill::sampleItems, fillConfig, writeSheet);
        excelWriter.fill(sampleItems(), fillConfig, writeSheet);
        // 下面是纯手工写数据
        List<List<String>> totalListList = new ArrayList<>();
        List<String> totalList = new ArrayList<>();
        totalListList.add(totalList);
        totalList.add(null);
        totalList.add("统计：1000");
        excelWriter.write(totalListList, writeSheet);
    } finally {
        if (excelWriter != null) {
            excelWriter.finish();
        }
    }
}

结果为：

image.png



横向填充数据

先定义模板：

image.png



private static void fillObjectAndListHorizontal() {
    String fileName = defaultFileName("fillObjectAndListHorizontal");
    String templateFile = getPath() + File.separator + "template_fill_list_horizontal.xlsx";
    final ExcelWriter excelWriter = EasyExcelFactory.write(fileName).withTemplate(templateFile).build();
    try {
        final WriteSheet writeSheet = EasyExcelFactory.writerSheet().build();
        Map<String, Object> map = new HashMap<>();
        map.put("date", DateTimeFormatter.ISO_LOCAL_DATE_TIME.format(LocalDateTime.now()));
        excelWriter.fill(map, writeSheet);
        FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
        excelWriter.fill(BaseFill::sampleItems, fillConfig, writeSheet);
        excelWriter.fill(sampleItems(), fillConfig, writeSheet);
    } finally {
        if (excelWriter != null) {
            excelWriter.finish();
        }
    }
}

这里配置FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build()，用于定义写入方向。


结果为：

image.png



填充多个表格

与写操作相同，填充操作也可以实现多表格的写入。

image.png



对于多表格写入，定义模板时，必须有{前缀。}。


private static void fillMultiList() {
    String fileName = defaultFileName("fillMultiList");
    String templateFile = getPath() + File.separator + "template_fill_multi_list.xlsx";
    final ExcelWriter excelWriter = EasyExcelFactory.write(fileName).withTemplate(templateFile).build();
    try {
        final WriteSheet writeSheet = EasyExcelFactory.writerSheet().build();
        Map<String, Object> map = new HashMap<>();
        map.put("date", DateTimeFormatter.ISO_LOCAL_DATE_TIME.format(LocalDateTime.now()));
        excelWriter.fill(map, writeSheet);
        FillConfig fillConfig = FillConfig.builder().direction(WriteDirectionEnum.HORIZONTAL).build();
        excelWriter.fill(new FillWrapper("data1", sampleItems()), fillConfig, writeSheet);
        // data2 分批写入
        excelWriter.fill(new FillWrapper("data2", sampleItems()), writeSheet);
        excelWriter.fill(new FillWrapper("data3", sampleItems()), writeSheet);
    } finally {
        if (excelWriter != null) {
            excelWriter.finish();
        }
    }
}

这里用到了FillWrapper，用来包装前缀。


结果为：

image.png



至此，写操作和填充操作全部介绍完成。


文末总结

本文从实战角度说了一下 EasyExcel 如果实现填充模板导出表格，有了模板填充逻辑，再加上写逻辑，我们会有更多的玩法，接下来就会说一下这些好玩的骚操作。


推荐阅读

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

阿里开源的这个库，让 Excel 导出不再复杂（既要能写，还要写的好看）

阿里开源的这个库，让 Excel 导出不再复杂（填充模板的使用指南）


文章标签：
easyexcel
安全
缓存
关键词：
excel填充
开源excel
库excel
excel导出
excel库
看山灬
目录
相关文章
bruce_xiaowei
|
24天前
|
Python
使用OpenPyXL库实现Excel单元格其他对齐方式设置
本文介绍了如何使用Python的`openpyxl`库设置Excel单元格中的文本对齐方式，包括文本旋转、换行、自动调整大小和缩进等，通过具体示例代码展示了每种对齐方式的应用方法，适合需要频繁操作Excel文件的用户学习参考。
bruce_xiaowei
154 85
使用OpenPyXL库实现Excel单元格其他对齐方式设置
洛秋_
|
3天前
|
数据处理
Excel VBA 自动填充空白并合并相同值的解决方案
在Excel中，常需将一列数据中的空白单元格用上方最近的非空值填充，并合并连续相同值。本VBA宏方案自动完成此操作，包含代码实现、使用方法及注意事项。通过简单步骤添加宏，一键处理数据，提升效率，确保准确性。适用于频繁处理类似数据的用户。
洛秋_
16 7
小宋1021
|
2月前
|
前端开发
实现Excel文件和其他文件导出为压缩包，并导入
实现Excel文件和其他文件导出为压缩包，并导入
小宋1021
32 1
小王老师呀
|
2月前
|
数据格式 UED
记录一次NPOI库导出Excel遇到的小问题解决方案
【11月更文挑战第16天】本文记录了使用 NPOI 库导出 Excel 过程中遇到的三个主要问题及其解决方案：单元格数据格式错误、日期格式不正确以及合并单元格边框缺失。通过自定义单元格样式、设置数据格式和手动添加边框，有效解决了这些问题，提升了导出文件的质量和用户体验。
小王老师呀
210 3
最好zzz
|
2月前
|
Java BI API
Java Excel报表生成：JXLS库的高效应用
在Java应用开发中，经常需要将数据导出到Excel文件中，以便于数据的分析和共享。JXLS库是一个强大的工具，它基于Apache POI，提供了一种简单而高效的方式来生成Excel报表。本文将详细介绍JXLS库的使用方法和技巧，帮助你快速掌握Java中的Excel导出功能。
最好zzz
73 6
最好zzz
|
2月前
|
Java API Apache
Java中Excel导出的高效解决方案：探索JXLS库
【10月更文挑战第29天】
最好zzz
272 2
无糖可乐嘟嘟
|
1月前
|
数据采集 数据可视化 数据挖掘
利用Python自动化处理Excel数据：从基础到进阶####
本文旨在为读者提供一个全面的指南，通过Python编程语言实现Excel数据的自动化处理。无论你是初学者还是有经验的开发者，本文都将帮助你掌握Pandas和openpyxl这两个强大的库，从而提升数据处理的效率和准确性。我们将从环境设置开始，逐步深入到数据读取、清洗、分析和可视化等各个环节，最终实现一个实际的自动化项目案例。 ####
无糖可乐嘟嘟
97 10
奔跑的数据
|
3月前
|
数据采集 存储 JavaScript
自动化数据处理：使用Selenium与Excel打造的数据爬取管道
本文介绍了一种使用Selenium和Excel结合代理IP技术从WIPO品牌数据库（branddb.wipo.int）自动化爬取专利信息的方法。通过Selenium模拟用户操作，处理JavaScript动态加载页面，利用代理IP避免IP封禁，确保数据爬取稳定性和隐私性。爬取的数据将存储在Excel中，便于后续分析。此外，文章还详细介绍了Selenium的基本设置、代理IP配置及使用技巧，并探讨了未来可能采用的更多防反爬策略，以提升爬虫效率和稳定性。
奔跑的数据
174 4
技术自由圈/原疯狂创客圈
|
7天前
|
存储 Java easyexcel
招行面试：100万级别数据的Excel，如何秒级导入到数据库？
本文由40岁老架构师尼恩撰写，分享了应对招商银行Java后端面试绝命12题的经验。文章详细介绍了如何通过系统化准备，在面试中展示强大的技术实力。针对百万级数据的Excel导入难题，尼恩推荐使用阿里巴巴开源的EasyExcel框架，并结合高性能分片读取、Disruptor队列缓冲和高并发批量写入的架构方案，实现高效的数据处理。此外，文章还提供了完整的代码示例和配置说明，帮助读者快速掌握相关技能。建议读者参考《尼恩Java面试宝典PDF》进行系统化刷题，提升面试竞争力。关注公众号【技术自由圈】可获取更多技术资源和指导。
技术自由圈/原疯狂创客圈
40 3
pbeskoyq7ffm4
|
5月前
|
关系型数据库 MySQL Shell
不通过navicat工具怎么把查询数据导出到excel表中
不通过navicat工具怎么把查询数据导出到excel表中
pbeskoyq7ffm4
56 0