如何优雅地生成那些花里胡哨的复杂样式 Excel 文件？

最新推荐文章于 2024-04-09 17:28:47 发布

犬小哈

最新推荐文章于 2024-04-09 17:28:47 发布

阅读量1k

点赞数

本文链接：https://blog.csdn.net/weiwosuoai/article/details/100032125

版权

点击蓝色“小哈学Java”关注我哟

加个“星标”，第一时间获取小哈推送的文章哦！

640?wx_fmt=jpeg

一、背景

小哈最近这段时间开始负责一个新的产品：下载中心。啥玩意这是？

产品的目的其实就是统一管控各业务组文件下载功能（包括一些海量数据的导出，文件合并上传等），项目组不用自己再去实现各式各样的文件（PDF, Word, Excel）生成, 统一对接下载中心，由下载中心统一完成文件的生成、合并、上传、下载流程。

问题来了，这里面包括一些复杂文件的生成，如带有复杂样式的 Excel 文件，比如下面这个样子的：

640?wx_fmt=png

这种复杂样式的 Excel, 如果说放到各个业务线去实现还是好办的，因为站在各个业务组的角度，场景变化不会太多，按照文件格式，代码写死即可。

但是站在下载中心的角度，因为需要对接各个业务中心，每个业务中心生成的样式都不一样，不可能每个业务组接进来，我都得定制的写一套生成代码吧！这显然也不合常理！

那么，有没有什么一劳永逸的办法呢？答案是肯定的！

二、实现思路

要说实现方式，你的脑海里可能第一会想到传统的 Apache poi，jxl ，亦或者是阿里出品 EasyExcel 等等。

PS: 关于阿里的 EasyExcel, 小哈之前有分享过，没看过的小伙伴们，可以看下《惊了！7 行代码优雅地实现 Excel 文件导出功能？》这篇文章。

640?wx_fmt=jpeg

对于这种复杂样式，要是用 Apache poi, jxl, 阿里 EasyExcel 去实现，不可避免的，代码肯定会非常繁琐。

有没有啥优雅（偷懒的）的方式呢？

其实我们可以通过视图引擎 Freemark、Velocity 来帮我们生成复杂样式 Excel 文件，无需关心花里胡哨的复杂样式，只关注于填充数据即可。接下来，我们以 Freemark 作为示例来讲解，如何生成这个复杂样式的 Excel 文件。

拓展阅读: 什么是 Freemark ?

FreeMarker 是一款模板引擎：即一种基于模板和要改变的数据，并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。

其实，对于Java 后端来说，它更常被用来服务端动态渲染 html 页面返回给浏览器。前些年还比较火热，近些年因为前后端分离的火热，也开始慢慢淡出视野了。

三、开始上手

3.1 添加依赖

&lt;dependency&gt;	
  &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;	
  &lt;artifactId&gt;spring-boot-starter-freemarker&lt;/artifactId&gt;	
&lt;/dependency&gt;

注意: 小哈这里基于 Spring Boot 写的测试代码，版本号可以无需指定，否则，你需要手动指定好版本号。

3.2 导出 xml 模板文件

首先，将复杂样式的 Excel 文件另存为 .xml 视图模板，如下图所示：

640?wx_fmt=png

打开 xml 模板文件，可以清晰的看到里面定义了各种节点，节点描述了整个 Excel 的样式结构, 如下图所示：

640?wx_fmt=png

3.3 填充占位符

再回过头来看下之前那个复杂 Excel 文件，观察一下哪些单元格的值需要动态设置：

640?wx_fmt=png

图中用红色特意标注出来了。

在刚刚另存为的 xml 模板文件中填写 freemark 表达式，考虑到这里只是个示例 Demo, 仅仅选取几个示例单元格来填写占位符，如下所示：

订单标题：

640?wx_fmt=png

其他需要动态填充的单元格：

640?wx_fmt=png

PS: xml 文件中， <Row> 节点代表一行， <Cell>代表一个单元格。

在需要动态填充数据的地方，加上相关 freemark 表达式，如 ${commodity.name!}，如下所示：

&lt;Row ss:AutoFitHeight="0" ss:Height="54"&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;1&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;${commodity.name!}&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"/&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;${commodity.num!}&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;${commodity.num1!}&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;22&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;44&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;55&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;盒&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;${commodity.price!}&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;${commodity.price2!}&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;${commodity.price3!}&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;${commodity.timestamp}&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"&gt;&lt;Data ss:Type="String"&gt;${commodity.createTime?string('yyyy-MM-dd HH:mm:ss')}&lt;/Data&gt;&lt;/Cell&gt;	
    &lt;Cell ss:StyleID="s18"/&gt;	
&lt;/Row&gt;

按照服务端数据模型的定义，填写好相应的字段名称，再对照下后台 Commodity 商品类的定义：

640?wx_fmt=png

这个商品类中，我们定义了不同类型的字段，如 String、int、Integer、Double、Float、金额类型 BigDecimal、日期类型 Date 等，用以测试对不同数据类型的兼容性。

确认相关属性字段名无误后，再来看下 freemark 生成 Excel 的核心代码：

640?wx_fmt=png

可以看到生成复杂样式的 Excel 的代码非常简洁。关于每一行代码什么意思，注释已经说得很清楚了，这里就不加以说明了。

运行单元测试，看下效果：

640?wx_fmt=png

完美，在需要填充内容的地方都已经动态设置上了内容。

640?wx_fmt=jpeg

四、多行数据如何生成？

如何做到动态生成多行呢？其实也很简单，重新打开刚刚修改的 xml 模板文件，在需要动态生成多行的地方，添加 freemark 循环表达式即可：

640?wx_fmt=png

PS: 关于 Freemark 更多表达式的使用，小伙伴们可以自行在各大搜索引擎中搜索，因为如何使用 Freemark 不是本文关注的重点~

上图中，我们对后台的 commodities 字段做了循环，所以对应的，后台代码也需要做相关修改：

640?wx_fmt=png

我们在 commodities 中添加了两个商品对象。赶快代码跑起来，看看效果！

别急，还有个地方需要做下修改，不然会报错！！

640?wx_fmt=png

找到 <Table> 节点，有个属性叫 ExpandedRowCount, 它定义了表格行的总数，如果数值与实际的行数对应不上的话，会出问题。

640?wx_fmt=png

这里我们添加 Freemark 表达式，总行数为商品 commodites 集合的大小加上 16, 注意：16 为除了动态生成的行数外，固定不变的行数大小，小伙伴们如果使用的是不同的 xml 模板，需要自行确认好这个数值的大小。

修改完了以后，再次运行单元测试，效果如下：

640?wx_fmt=png

OK! 大功告成！

640?wx_fmt=jpeg

五、局限性

通过视图解析器来生成 Excel 的确很优雅（偷懒），同时兼具灵活性。但是它同样存在一些局限性！小伙伴们在技术选型时，需要结合实际的业务场景审视它是否适合。

版本问题；

目前个人测试结果是，在 MAC 系统上仅支持生成 03 版本 Excel, 07 版本存在打不开的情况；

无法写入大批量数据；

视图引擎生成文件无法往 Excel 里面追加数据，所以仅仅适用于数据量不大的个性化 Excel 生成，否则写入大批量数据时，存在内存溢出(OOM)的情况发生；

MAC 系统存在生成的 Excel 文件无法编辑保存的情况：

小哈在测试中发现，生成 excel 在 MAC 系统上存在编辑后，无法保存的情况；而 Windows 系统 Microsoft Excel 和 WPS 均能够正常编辑保存；

六、总结

本文中，小哈给大家介绍了如何通过视图引擎优雅的生成 Excel 文件，演示了相关示例代码，以及它的相关局限性，希望大家看完本文后能够有所收获，下期见哟~

免费无套路分享 | 面试&学习福利资源

最近在网上发现一个不错的 PDF 资源《Java 核心知识&面试.pdf》，内容覆盖很广，Java 核心基础、Java 多线程、高并发、Spring、微服务、Netty 与 RPC、Zookeeper、Kafka、RabbitMQ、Habase、设计模式、负载均衡、分布式缓存、Hadoop、Spark、Storm、云计算等

获取方式: 关注本公众号: 小哈学Java, 后台回复资源，既可免费无套路获取资源链接哦！

640?

更多推荐内容

↓↓↓

这可能是将String.format格式化讲解的最清楚的一篇文章

为什么阿里巴巴代码规约要求避免使用 Apache BeanUtils 进行属性复制

记一次中台数据传输同步Elasticsearch失败的车祸现场

一文教您通过 Docker 快速搭建各种测试环境(Mysql, Redis, ES, MongoDB) | 建议收藏

阿里云OSS被盗链？上个月图床流量耗费50G+，请求次数10W+,什么鬼？

一台Java服务器跑多少个线程，性能最佳呢？

干货 | 关于 Mybatis 缓存，面试官都未必知道的这么详细

惊了！7 行代码优雅地实现 Excel 文件导出功能？

如果你喜欢本文

请长按二维码，关注小哈学Java

640?wx_fmt=jpeg

转发朋友圈，是对我最大的支持哟

如果你喜欢这篇文章，在看，转发吧。

相信明天更加美好 (*^__^*)

犬小哈

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
如何优雅地生成那些花里胡哨的复杂样式 Excel 文件？

点击蓝色“小哈学Java”关注我哟加个“星标”，第一时间获取小哈推送的文章哦！目录一、背景二、实现思路三、快速上手四、多行数据如何生成？五、局限性六、总结一、背景小哈最近...
复制链接

扫一扫