springboot下生成复杂word文档方案在Word软件里面制作模板

最新推荐文章于 2024-05-23 15:26:16 发布

wangxudongx

最新推荐文章于 2024-05-23 15:26:16 发布

阅读量3.5k

点赞数 1

本文链接：https://blog.csdn.net/wangxudongx/article/details/120686684

版权

系列文章目录

第二章：根据模板导出word，复合格式表格生成、可变列表格生成
第三章：doc和docx插入多图
第四章：web环境下word文档预览

为什么不用POI或者easypoi来做呢？
1.POI需要用太多代码来实现格式，如果在用户给定一个word模板，开发人员需要观察每个部分的格式、布局等来写代码，在复杂场景下效率太低。
2.easypoi无法实现细致的格式控制。如：一个表格第一行（标题行）宽边框，从第二行（内容行第一行）细边框，最后一行粗边框；这个应用场景比较多，但是easypoi无法实现。另外就是缺失了图片功能。

使用模板引擎来做生成word文档的优势在于：
1：可视化编辑模板，可以让产品经理或者具体的业务人员制作模板。
2：降低了代码量和调试难度，因为不用写代码来控制格式。
缺点：
1：每一次word样式调整都需要重新再次转换为模板引擎的模板。
这个Demo覆盖了动态带格式的文字、图片、表格。

在实际的复杂格式word文档场景下，使用模板引擎是比POI、easypoi更优的解决方案。如果是比较简单的word文档区别不大。

代码仓库

https://gitee.com/whatitis/springboot_freemarker_word

1. 制作word模板

1.1 制作一个word文档，设置好样式、排版

直接在word文档里面写freemarker占位符是没有用的，因为${}字符会被转换。
在这里插入图片描述

1.2 正常保存为word docx/doc文档留底

1.3 另存为一份Word XML 文档(*.xml)

在这里插入图片描述
这个是用于作为freemarker模板。

2. 准备一个springboot项目，引入freemarker-starter依赖

gradle

implementation 'org.springframework.boot:spring-boot-starter-freemarker:2.5.5'

TODO：贴上项目仓库地址

3. 调整配置文件

spring:
  freemarker:
    template-loader-path: classpath:/templates/word/
wordDemo:
  outDirectory: D:/temp # word文件输出目录
  basePackagePath: /templates/word/ # 自定义模板目录

4. 编辑模板文件

通过word另存为xml格式的文档，我们只需要在此基础上调整、增加一点代码就可以使用了。

4.1 将第1步的word xml 文档放到指定的模板目录

在这里插入图片描述

4.2 格式化模板文件

在这里插入图片描述

4.2.3 修改文件后缀名为.ftl

在这里插入图片描述

4.3 将word文件中要动态替换的内容用freemarker占位符替换

4.3.1 艺术字文字内容

我们按照关键字搜索到指定位置
在这里插入图片描述
这个艺术字有两处需要去替换，因为带有阴影效果。

将内容改为：${articleTitle}

4.3.2 图片

找到图片位置
在这里插入图片描述
可以看出来它是用base64来存储图片的，所以我们相对应的也用base64替换。

把原来的base64内容替换成占位符
在这里插入图片描述

4.3.3 表格处理

按照关键字搜索

user.name替换为：

在这里插入图片描述

user.gender段多了一些没用的代码，应该是一些多余的样式，删掉和user.name保持一致即可。
在这里插入图片描述
写循环代码

通过观察word xml代码，我们分析得知
user.name 所处的 <w:tr 标签段为表格中的一行，我们在其上写循环代码，这个就像JSP。

<#list> </#list>要包住 <w:tr></w:tr>

在这里插入图片描述

全部替换完毕之后保存。

5. 写代码

请看代码仓库里的内容。

https://gitee.com/whatitis/springboot_freemarker_word

运行测试

cn.gitee.worddemo.WorddemoApplicationTests#testProc

在这里插入图片描述

6.结果

在这里插入图片描述

1.艺术字替换完成
2.表格内容填充完成，样式保持OK。
3.页码自动生成。

测试通过。

FreeMarker官方在线手册中文版

http://freemarker.foofun.cn/dgui_template_directives.html

最佳实践

为了减少每一次word样式调整转换为模板引擎的模板时的工作量，可以视具体情况用最小部分替换法去做，这个方式需要你去识别word的xml标签，来决定替换的范围，比如某一页的内容格式修改了之后，就用这一页的xml替换ftl对应那一页的标签然后再去重新写freemarker标签。

word兼容性问题

如果需要在office word 2007 以及之前的版本上使用生成的结果，需要使用word xml 2003 格式来做模板。不然会出现生成的结果没法在老版word上打开的问题。

2次格式化可能会出现的问题

在这里插入图片描述

在制作word 2003 xml模板过程中，导入word xml格式到IDEA中，格式化一次，重命名文件为ftl之后再格式化一次，使用此模板生成的word doc 文档会出现图片不显示或者文档打开失败的情况。

这种情况下，只在导入word xml 到IDEA中格式化一次，然后手动格式化具体标签就不会出现问题。

在做word 2007模板时没有出现问题。

分页符处理

段落分页的处理；
1.如果分页符是段落前面需要判断是否第一页，不然会多出一个空白页。
2.如果分页符位于段落后面需要判断是否最后一页，不然会多出一个空白页。

分页符是需要依附于某个元素的，比如一段文字，如下：

                    <w:p wsp:rsidR="00230078" wsp:rsidRDefault="00415FB0">
                        <w:pPr>
                            <w:jc w:val="center"/>
                            <w:rPr>
                                <w:b/>
                                <w:sz w:val="24"/>
                                <w:sz-cs w:val="24"/>
                            </w:rPr>
                            
<#--                            判断是否第一页-->
                            <#if ttable_index != 0>
                                <w:br w:type="page"/>
                            </#if>

                        </w:pPr>
                        <w:r>
                            <w:rPr>
                                <w:rFonts w:hint="fareast"/>
                                <wx:font wx:val="宋体"/>
                                <w:b/>
                                <w:sz w:val="24"/>
                                <w:sz-cs
                                        w:val="24"/>
                            </w:rPr>
                            <w:t>我是一段文字，啦啦啦啦啦</w:t>
                        </w:r>
                    </w:p>