使用Docx4j库按照word模板和xml内容生成pdf

动机

刚刚换新公司,最近有一个需求,就是,对客户按照业务数据生成自己专属的一个pdf计划书,由于,最后生成的pdf大体的结构都是一样的,只有客户自己专属的数据有区别,理所当然的采取了模板的形式,所有客户都使用同一个模板,然后按照自己的业务数据填充模板,就能生成最终的pdf计划书。但是这个生成pdf计划书,需要去找第三方厂商对接,而负责对接的人,就是我自己,当时,内心里面是有疑惑的,这个生成pdf应该有类似的库才对,不过,为了顺利的完成任务,还是按照公司的安排,去和厂商对接。

刚开始对接都还比较顺利,厂商那边只需要两个东西,一个就是pdf最终要生成什么样子(其实就是模板,只不过这个模板是有厂商来配置的,配置好之后会给我们一个模板号),另一个就是需要往模板中填充的数据。对应的,当我们需要生成pdf的时候只需要告诉厂商,模板号+填充数据,厂商就能给我们生成pdf。因为最开始的模板都很简单,只需要,填充模板数据就ok了,所以没有啥问题。后来我们的模板不止是简单的填充数据,而有可能是动态的,比如,某个客户的消费记录,可能是多条,但是具体几条是未知的,这就给厂商那边带来了苦恼,为了处理这个问题,厂商那边想其他的办法来处理这种特殊情况。这个时候,第二次产生疑惑,为啥不自己搞一套,非得依赖人家。于此同时,我也把工作重心放到了其他工作上面。

当厂商提供了解决方案的时候,对接依然是各种问题,遇到了问题,只给一个错误码,只能等厂商那边解决了再来联调,因为生成pdf的逻辑是在他们那边,断断续续的就这么搞了5天,此时,我决定去找一找有没有处理这种情况的开源库,毕竟Java大法好。

寻觅之路

google一下java pdf,第一条搜索结果就是Apache Pdfbox,如下图,内心很躁动,有开源库,就是干

1.png

点进去之后看到的pdfbox有如下特性,其中的fill forms应该就是我需要用的。

2.png

不过用了这个fill forms之后,发现也只能实现简单的替换,还是不能解决动态模板的问题。可能有其他高级功能,但是没有过多的做深入研究。

此时,回想起和第三方厂商对接的时候,好像厂商并不是直接处理的pdf,而是处理的word,也就是docx文件,莫非,厂商是直接处理word,然后再用工具把word转成pdf?带着这个疑问,再次踏上了搜索之路。

再次搜索java docx,显示如下结果,从中提取了关键字docx4j

3.png

实现

小试

首先拉取了docx4j的源代码库,主要是为了看其中的samples模块
点我查看docx4j源码地址
配合docx4j的框架简要说明以及官方文档提取出了OpenDoPE关键字以及ContentControlBindingExtensions示例类。

简单粗暴,直接运行ContentControlBindingExtensions类,发现果然生成了OUT_ContentControlsMergeXML.docx文档,点击进去神奇的发现,文档中的表格已经多了两行,这难道不是动态生成么?
模板如下:

4.png

填充内容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>

填充后的文档如下:


5.png

这个时候,疑问来了,模板中没有任何占位符之类的,怎么就动态了生成了文档呢?但是,应该有对应的配置才对,不然,怎么能做到一一匹配呢?带着这些疑问,再次从官方文档中找到了答案。

其中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中添加完成上面工具的时候,会多出一个工具栏如下:

6.png

其中的操作也很简单,点击Show XML后,如果关联了xml会在右侧展示xml结构,如下图所示:
7.png

如果没有关联xml,会提示我们可以导入自定义的xml数据,当xml数据和当前文档关联之后,就可以在右侧的XML Mapping和左侧的文档中添加一一对应的关系,比如添加Repeat就能实现我们的多条数据。到此,解决了我们的疑问。同时,按照自己的业务数据动态生成的docx的功能已完成。

遇到的问题

接下来就是把生成的docx转换成pdf,其中用了Docx4j.toPDF方法,但是,中文乱码,中文全部转换成了#符号,搜索之后使用了csdn的一篇博客处理编码问题。

后话

完成上述生成pdf后,和我们和找三方对接的东西,还差一个电子公章,这个挺简单,不就是在word中插入预先生成的公章图片后,再转换成pdf,不就ok了么。的确,按照这个思路,实现了公章的插入,几乎和第三方对接生成的pdf文档一个样了,这个时候,愉快的找到了项目负责人,告诉他,我们可以不用找三方对接了,我找到了开源库,可以满足我们的业务场景。这样的话,好处是不用多说,先不说找三方对接的服务费怎么算,只是,我们不用依赖第三方服务。项目负责人给我的答案是,挺好的,但是,美中不足的是,这个公章不是随便一个图片就有法律效应的,需要专门的电子签章机构,签的公章,才有法律效应。虽然有一小点遗憾,但是,通过自己的最初想法,再去一点一点的实现,也是一件很快乐的事,所以记录于此。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355