Java 根据模板导出PDF

目录

• 前言
  
• 思路一：直接导出pdf
  
  
  
  • 使用itext模板导出pdf
    
  
  
• 思路二：先导出word再转成pdf
  
  
  
  • 1）导出word
    
  • 2）word转pdf
    
  
  
• 最终方案
  
  
  
  • docx4j  spire.doc.free + freemarker
    
  
  

前言

本文为我搜集的根据模板导出PDF的方法整理而来，所以贴了好多帖子的链接。有的方法仅适合特殊的业务场景，可以根据业务需求选择合适的方法。写的不好请轻喷。
思路一：直接导出pdf

使用itext模板导出pdf

• 适用范围
  业务生成的 pdf 是具有固定格式或者模板的文字及其图片等内容，使用模板，只需要将不一致的地方改成文本域，然后进行文字填充就可以了；如果涉及的业务不能有模块化可以提取出来东西，从开头一步一步去绘画。
  
• 参考链接
  JAVA 使用Itext模板生成pdf，解决图片插入，文本域超出字体缩放，半自动换行
  java根据模板生成pdf文件并导出
  
• 缺点
  超出文本域的部分的文字（若不设置自动调整文字大小）则会不显示，无法自动分页。（暂未找到解决方案）
  

思路二：先导出word再转成pdf

1）导出word

• Freemarker
  官方参考手册：http://freemarker.foofun.cn/toc.html
  
  
  
  • Freemarker 将数据填入 .ftl 模板导出 word（.doc/.docx）
    
    
    
    • 参考链接：
      SpringBoot整合Freemarker导出word文档表格
      freemarker导出Word，文本，可循环表格，合并单元格，可循环图片，目录更新（一）
      
    • 缺点：
      导出的 .doc / .docx 实际上是 xml 文件,用办公软件能正常打开使用。但是转 PDF 的时候发现转不成功。转过之后的 PDF 显示的不是 word 的格式字符，而是像 xml 文件的标签及字符。
      
    
    
  • Freemarker 结合 .docx 格式的本质将数据填入 .docx 里面的 document.xml 文件导出 .docx
    
    
    
    • 参考链接：
      freemarker动态生成word并将生成的word转为PDF
      
    • 优点：
      可转换为 pdf
      
    • 相关错误：
      A. Date 格式的数据传输报错！
      解决方案：
      1. ${(initialTime?string("yyyy-MM-dd HH:mm:ss"))!}

      复制代码
    • 附：
      a. 循环行及表单行是否显示功能参考链接：
      SpringBoot整合Freemarker导出word文档表格
      freemarker合并单元格，if、else标签的使用，null、空字符串处理
      如：
      
      导出结果如下：
      
      也可向参考链接2一样，在 xml 上定义插入对应的合并代码（如下图）。
      
      
    
    
  
  
• docx4j
  结合 .docx 格式的本质将数据填入 .docx 里面的 document.xml 文件导出 .docx
  docx4j 中模板的使用
  docx4j 实现动态表格（模板式）
  docx4j 中图片的使用（模板式）
  docx4j 实现动态表格（模板式）单元格合并（含多列并列合并）
  
• POI
  Poi的导出word和转pdf --已试过，可行
  Java文件操作之word转pdf并导出（liunx和windows）
  
• Aspose.word（需要license）（未尝试）
  使用Aspose.word (Java) 填充word文档数据（包含图片填充）
  

2）word转pdf

• docx4j 将 .docx 转 pdf
  官方下载地址
  
  
  
  • 方法一：使用 docx4j2.8.1在 docx 模板填入数据并且转 pdf
    参考链接：docx4j Word文档转换pdf- 解决中文问题和变量替换
    
  • 方法二：将 docx 转 pdf
    参考链接：freemarker动态生成word并将生成的word转为PDF
    
  • 相关错误：
    A.导出的 PDF 乱码（检查 word 文件中的字体是否在字体库中）
    使用docx4j实现docx转pdf（解决linux环境下中文乱码问题）
    
    B.注意：存在样式 bug！！！
    暂未找到解决方案。
    
  
  
• Spire.Doc 实现 word （.doc / .docx）转 pdf（尝试了免费版，可行）
  有付费版和免费版，免费版仅支持三页内的 word 转 pdf
  
• aspose.word 将 word 转 pdf （未尝试）
  需要license，破解方法1，破解方法2
  

最终方案

docx4j  spire.doc.free + freemarker

<ol>模板准备
将占位变量名写在模板 testTemplate.docx的对应位置上，用 ${}包起来。

把复制一份副本，将副本 .docx 的后缀名重命名为 .zip。解压后找到 /word/document.xml，编译器打开文件，代码格式化后，对比例如 ${repliedUserId} 的占位参数是否被拆开（如果拆开需手动修改），修改名字为 testDocument.xml。
将源模板 testTemplate.docx 和 testDocument.xml 放到相应位置。
maven依赖

1.     <dependencies>
2.         
3.         <dependency>
4.             <groupId>org.freemarker</groupId>
5.             <artifactId>freemarker</artifactId>
6.             <version>2.3.22</version>
7.         </dependency>
9.         
10.         <dependency>
11.             <groupId>org.docx4j</groupId>
12.             <artifactId>docx4j-JAXB-Internal</artifactId>
13.             <version>8.2.4</version>
14.         </dependency>
15.         <dependency>
16.             <groupId>org.docx4j</groupId>
17.             <artifactId>docx4j-export-fo</artifactId>
18.             <version>8.2.4</version>
19.         </dependency>
21.         
22.         
23.         <dependency>
24.             <groupId>e-iceblue</groupId>
25.             <artifactId>spire.doc.free</artifactId>
26.             <version>5.2.0</version>
27.         </dependency>
28.     </dependencies>
30.     <repositories>
31.         <repository>
32.             <id>com.e-iceblue</id>
33.             <name>e-iceblue</name>
34.             <url>https://repo.e-iceblue.cn/repository/maven-public/</url>
35.         </repository>
36.     </repositories>

复制代码

Controller

1. @PostMapping("/pdfExport")
2. public ResponseEntity exportPdf(@RequestParam Map<String, Object> params) {
3.     try {
4.         // 查找业务数据
5.         TestEntity testEntity = testService.querySheet(params);
6.         // 格式转换时的暂存文件名
7.         String fileUuid = UUID.randomUUID().toString().replaceAll("-", "");
8.         String toDocxPath = "E://project//test//ToPDF//word//" + fileUuid + ".docx";
9.         String toPdfPath = "E://project//test//ToPDF//pdf//" + fileUuid + ".pdf";
10.         String toXmlPath = "E://project//test//ToPDF//xml//" + fileUuid + ".xml";
11.         String docxTemplate = "E://project//test//ToPDF//template//testTemplate.docx";
13.         // .xml转.docx（testDocument.xml表示在项目的相对路径下）
14.         XmlToDocx.toDocx("testDocument.xml",docxTemplate, toXmlPath, toDocxPath, testEntity);
15.         // .docx转.pdf
16.         WordToPdf.docxToPdf(toDocxPath, toPdfPath);
18.         // 下载pdf并删除本地pdf
19.         ResponseEntity response = WordToPdf.downloadPdf("这是PDF的名字啊", toPdfPath);
20.         return response;
21.     } catch (Exception e) {
22.         throw new BusinessException("下载PDF失败！" + e.getMessage());
23.     }
24. }

复制代码

XmlToDocx类
[code]import java.io.*;import java.util.Enumeration;import java.util.Map;import java.util.zip.ZipEntry;import java.util.zip.ZipException;import java.util.zip.ZipFile;import java.util.zip.ZipOutputStream;/** * 其实docx属于zip的一种，这里只需要操作word/document.xml中的数据，其他的数据不用动 * * @author * */public class XmlToDocx {    /**     *     * @param xmlTemplate xml的文件名     * @param docxTemplate docx的路径和文件名（.docx模板）     * @param xmlTemp  填充完数据的临时xml     * @param toFilePath  目标文件名     * @param object  需要动态传入的数据     */    public static void toDocx(String xmlTemplate, String docxTemplate, String xmlTemp, String toFilePath, Object object)  {        try {            // 1.object是动态传入的数据            // 这个地方不能使用FileWriter因为需要指定编码类型否则生成的Word文档会因为有无法识别的编码而无法打开//            Writer w1 = new OutputStreamWriter(new FileOutputStream(xmlTemp), "gb2312");            Writer w1 = new OutputStreamWriter(new FileOutputStream(xmlTemp), "utf-8");            // 2.把object中的数据动态由freemarker传给xml            XmlTplUtil.process(xmlTemplate, object, w1);            // 3.把填充完成的xml写入到docx中            XmlToDocx xtd = new XmlToDocx();            File xmlTempFile = new File(xmlTemp);            xtd.outDocx(xmlTempFile, docxTemplate, toFilePath);            // 删除临时xml文件            xmlTempFile.delete();        }catch (Exception e) {            e.printStackTrace();        }    }    /**     *     * @param documentFile 动态生成数据的docunment.xml文件     * @param docxTemplate docx的模板     * @param toFilePath  需要导出的文件路径     * @throws ZipException     * @throws IOException     */    public void outDocx(File documentFile, String docxTemplate, String toFilePath) throws ZipException, IOException {        try {            File docxFile = new File(docxTemplate);            ZipFile zipFile = new ZipFile(docxFile);            Enumeration