动机
刚刚换新公司,最近有一个需求,就是,对客户按照业务数据生成自己专属的一个pdf计划书,由于,最后生成的pdf大体的结构都是一样的,只有客户自己专属的数据有区别,理所当然的采取了模板的形式,所有客户都使用同一个模板,然后按照自己的业务数据填充模板,就能生成最终的pdf计划书。但是这个生成pdf计划书,需要去找第三方厂商对接,而负责对接的人,就是我自己,当时,内心里面是有疑惑的,这个生成pdf应该有类似的库才对,不过,为了顺利的完成任务,还是按照公司的安排,去和厂商对接。
刚开始对接都还比较顺利,厂商那边只需要两个东西,一个就是pdf最终要生成什么样子(其实就是模板,只不过这个模板是有厂商来配置的,配置好之后会给我们一个模板号),另一个就是需要往模板中填充的数据。对应的,当我们需要生成pdf的时候只需要告诉厂商,模板号+填充数据,厂商就能给我们生成pdf。因为最开始的模板都很简单,只需要,填充模板数据就ok了,所以没有啥问题。后来我们的模板不止是简单的填充数据,而有可能是动态的,比如,某个客户的消费记录,可能是多条,但是具体几条是未知的,这就给厂商那边带来了苦恼,为了处理这个问题,厂商那边想其他的办法来处理这种特殊情况。这个时候,第二次产生疑惑,为啥不自己搞一套,非得依赖人家。于此同时,我也把工作重心放到了其他工作上面。
当厂商提供了解决方案的时候,对接依然是各种问题,遇到了问题,只给一个错误码,只能等厂商那边解决了再来联调,因为生成pdf的逻辑是在他们那边,断断续续的就这么搞了5天,此时,我决定去找一找有没有处理这种情况的开源库,毕竟Java大法好。
寻觅之路
google一下java pdf,第一条搜索结果就是Apache Pdfbox
,如下图,内心很躁动,有开源库,就是干
点进去之后看到的pdfbox有如下特性,其中的fill forms应该就是我需要用的。
不过用了这个fill forms之后,发现也只能实现简单的替换,还是不能解决动态模板的问题。可能有其他高级功能,但是没有过多的做深入研究。
此时,回想起和第三方厂商对接的时候,好像厂商并不是直接处理的pdf,而是处理的word,也就是docx文件,莫非,厂商是直接处理word,然后再用工具把word转成pdf?带着这个疑问,再次踏上了搜索之路。
再次搜索java docx,显示如下结果,从中提取了关键字docx4j
实现
小试
首先拉取了docx4j的源代码库,主要是为了看其中的samples模块
点我查看docx4j源码地址
配合docx4j的框架简要说明以及官方文档提取出了OpenDoPE
关键字以及ContentControlBindingExtensions
示例类。
简单粗暴,直接运行ContentControlBindingExtensions
类,发现果然生成了OUT_ContentControlsMergeXML.docx
文档,点击进去神奇的发现,文档中的表格已经多了两行,这难道不是动态生成么?
模板如下:
填充内容xml如下:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><invoice>
<date>2019-01-15</date>
<customer>
<name>Joe Bloggs</name>
</customer>
<items>
<item>
<name>apples</name>
<price>$20</price>
</item>
<item>
<name>bananas</name>
<price>$30</price>
</item>
<item>
<name>gas</name>
<price>$40</price>
</item>
</items>
<misc>
<includeBankDetails>true</includeBankDetails>
<wantspam>false</wantspam>
</misc>
</invoice>
填充后的文档如下:
这个时候,疑问来了,模板中没有任何占位符之类的,怎么就动态了生成了文档呢?但是,应该有对应的配置才对,不然,怎么能做到一一匹配呢?带着这些疑问,再次从官方文档中找到了答案。
其中docx4j文档中的这一章节Binding extensions for repeats and conditionals,有一个重要的提示,那就是OpenDoPE
,原文引用如下:
A content control is conditional if it (and its contents) are included/excluded from the document based on whether some condition is true or false.
A content control is a repeat if it designates that its contents are to be included more than once. For
example, a row of a table for each invoice/order item, or person.
docx4j contains a mechanism for processing conditional content controls and repeats. See
http://www.opendope.org/opendope_conventions_v2.3.html for an explanation.
See also the docx4j sample ContentControlBindingExtensions.
其中链接http://www.opendope.org/opendope_conventions_v2.3.html是在讲述数据绑定以及一些绑定的示例,而在Implementations这个链接中,找到了一个重要的word扩展工具,该工具适用于word2013,原文引用如下:
This tool uses the drag/drop approach Microsoft has introduced in Word 2013
当word中添加完成上面工具的时候,会多出一个工具栏如下:
其中的操作也很简单,点击Show XML后,如果关联了xml会在右侧展示xml结构,如下图所示:
如果没有关联xml,会提示我们可以导入自定义的xml数据,当xml数据和当前文档关联之后,就可以在右侧的XML Mapping和左侧的文档中添加一一对应的关系,比如添加Repeat就能实现我们的多条数据。到此,解决了我们的疑问。同时,按照自己的业务数据动态生成的docx的功能已完成。
遇到的问题
接下来就是把生成的docx转换成pdf,其中用了Docx4j.toPDF
方法,但是,中文乱码,中文全部转换成了#符号,搜索之后使用了csdn的一篇博客处理编码问题。
后话
完成上述生成pdf后,和我们和找三方对接的东西,还差一个电子公章,这个挺简单,不就是在word中插入预先生成的公章图片后,再转换成pdf,不就ok了么。的确,按照这个思路,实现了公章的插入,几乎和第三方对接生成的pdf文档一个样了,这个时候,愉快的找到了项目负责人,告诉他,我们可以不用找三方对接了,我找到了开源库,可以满足我们的业务场景。这样的话,好处是不用多说,先不说找三方对接的服务费怎么算,只是,我们不用依赖第三方服务。项目负责人给我的答案是,挺好的,但是,美中不足的是,这个公章不是随便一个图片就有法律效应的,需要专门的电子签章机构,签的公章,才有法律效应。虽然有一小点遗憾,但是,通过自己的最初想法,再去一点一点的实现,也是一件很快乐的事,所以记录于此。