原文：https://segmentfault.com/a/1190000009160184

一、需求说明：根据业务需要，需要在服务器端生成可动态配置的PDF文档，方便数据可视化查看。

二、解决方案：
iText+FreeMarker+JFreeChart生成可动态配置的PDF文档
iText有很强大的PDF处理能力，但是样式和排版不好控制，直接写PDF文档，数据的动态渲染很麻烦。
FreeMarker能配置动态的html模板，正好解决了样式、动态渲染和排版问题。
JFreeChart有这方便的画图API，能画出简单的折线、柱状和饼图，基本能满足需要。

三、实现功能：

  1.    1、能动态配置PDF文档内容
  2.    2、支持中文字体显示的动态配置
  3.    3、设置自定义的页眉页脚信息
  4.    4、能动态生成业务图片
  5.    5、完成PDF的分页和图片的嵌入

四、主要代码结构说明：

  1.    1、component包：PDF生成的组件 对外提供的是PDFKit工具类和HeaderFooterBuilder接口，其中PDFKit负责PDF的生成，HeaderFooterBuilder负责自定义页眉页脚信息。
  2.    2、builder包：负责PDF模板之外的额外信息填写，这里主要是页眉页脚的定制。
  3.    3、chart包：JFreeChart的画图工具包，目前只有一个线形图。
  4.    4、test包：测试工具类
  5.    5、util包：FreeMarker等工具类。

五、关键代码说明：

1、模板配置

  1.   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4.     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
  5.     <meta http-equiv="Content-Style-Type" content="text/css"/>
  6.     <title></title>
  7.     <style type="text/css">
  8.         body {
  9.             font-family: pingfang sc light;
  10.         }
  11.         .center{
  12.             text-align: center;
  13.             width: 100%;
  14.         }
  15.     </style>
  16. </head>
  17. <body>
  18. <!--第一页开始-->
  19. <div class="page" >
  20.     <div class="center"><p>${templateName}</p></div>
  21.     <div><p>iText官网:${ITEXTUrl}</p></div>
  22.     <div><p>FreeMarker官网:${freeMarkerUrl}</p></div>
  23.     <div><p>JFreeChart教程:${JFreeChartUrl}</p></div>
  24.     <div>列表值:</div>
  25.     <div>
  26.         <#list scores as item>
  27.             <div><p>${item}</p></div>
  28.         </#list>
  29.     </div>
  30. </div>
  31. <!--第一页结束-->
  32. <!---分页标记-->
  33. <span style="page-break-after:always;"></span>
  34. <!--第二页开始-->
  35. <div class="page">
  36.     <div>第二页开始了</div>
  37.     <!--外部链接-->
  38.     <p>百度图标</p>
  39.     <div>
  40.         <img src="${imageUrl}" alt="百度图标" width="270" height="129"/>
  41.     </div>
  42.     <!--动态生成的图片-->
  43.     <p>气温变化对比图</p>
  44.     <div>
  45.         <img src="${picUrl}" alt="我的图片" width="500" height="270"/>
  46.     </div>
  47. </div>
  49. <!--第二页结束-->
  50. </body>
  51. </html>

2、获取模板内容并填充数据

  1. /**
  2.  * @description 获取模板
  3.  */
  4. public static String getContent(String fileName,Object data){
  6.     String templatePath=getPDFTemplatePath(fileName);//根据PDF名称查找对应的模板名称
  7.     String templateFileName=getTemplateName(templatePath);
  8.     String templateFilePath=getTemplatePath(templatePath);
  9.     if(StringUtils.isEmpty(templatePath)){
  10.         throw new FreeMarkerException("templatePath can not be empty!");
  11.     }
  12.     try{
  13.         Configuration config = new Configuration(Configuration.VERSION_2_3_25);//FreeMarker配置
  14.         config.setDefaultEncoding("UTF-8");
  15.         config.setDirectoryForTemplateLoading(new File(templateFilePath));//注意这里是模板所在文件夹，不是文件
  16.         config.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
  17.         config.setLogTemplateExceptions(false);
  18.         Template template = config.getTemplate(templateFileName);//根据模板名称 获取对应模板
  19.         StringWriter writer = new StringWriter();
  20.         template.process(data, writer);//模板和数据的匹配
  21.         writer.flush();
  22.         String html = writer.toString();
  23.         return html;
  24.     }catch (Exception ex){
  25.         throw new FreeMarkerException("FreeMarkerUtil process fail",ex);
  26.     }
  27. }
  28.

3、导出模板到PDF文件

  1. /**
  2.      * @description     导出pdf到文件
  3.      * @param fileName  输出PDF文件名
  4.      * @param data      模板所需要的数据
  5.      *
  6.      */
  7. public String exportToFile(String fileName,Object data){
  8.      String htmlData= FreeMarkerUtil.getContent(fileName, data);//获取FreeMarker的模板数据
  9.     if(StringUtils.isEmpty(saveFilePath)){
  10.         saveFilePath=getDefaultSavePath(fileName);//设置PDF文件输出路径
  11.     }
  12.     File file=new File(saveFilePath);
  13.     if(!file.getParentFile().exists()){
  14.         file.getParentFile().mkdirs();
  15.     }
  16.     FileOutputStream outputStream=null;
  17.     try{
  18.         //设置输出路径
  19.         outputStream=new FileOutputStream(saveFilePath);
  20.         //设置文档大小
  21.         Document document = new Document(PageSize.A4);//IText新建PDF文档
  22.         PdfWriter writer = PdfWriter.getInstance(document, outputStream);//设置文档和输出流的关系
  24.         //设置页眉页脚
  25.         PDFBuilder builder = new PDFBuilder(headerFooterBuilder,data);
  26.         builder.setPresentFontSize(10);
  27.         writer.setPageEvent(builder);
  29.         //输出为PDF文件
  30.         convertToPDF(writer,document,htmlData);
  31.     }catch(Exception ex){
  32.         throw new PDFException("PDF export to File fail",ex);
  33.     }finally{
  34.         IOUtils.closeQuietly(outputStream);
  35.     }
  36.     return saveFilePath;
  38. }

4、测试工具类

  1.  public  String createPDF(Object data, String fileName){
  2.             //pdf保存路径
  3.             try {
  4.                 //设置自定义PDF页眉页脚工具类
  5.                 PDFHeaderFooter headerFooter=new PDFHeaderFooter();
  6.                 PDFKit kit=new PDFKit();
  7.                 kit.setHeaderFooterBuilder(headerFooter);
  8.                 //设置输出路径
  9.                 kit.setSaveFilePath("/Users/fgm/Desktop/pdf/hello.pdf”);//设置出书路径
  10.                 String saveFilePath=kit.exportToFile(fileName,data);
  11.                 return  saveFilePath;
  12.             } catch (Exception e) {
  13.                 log.error("PDF生成失败{}", ExceptionUtils.getFullStackTrace(e));
  14.                 return null;
  15.             }
  17.         }
  1.   public static void main(String[] args) {
  2.          ReportKit360 kit=new ReportKit360();
  3.                 TemplateBO templateBO=new TemplateBO();//配置模板数据
  4.                 templateBO.setTemplateName("Hello iText! Hello freemarker! Hello jFreeChart!");
  5.                 templateBO.setFreeMarkerUrl("http://www.zheng-hang.com/chm/freemarker2_3_24/ref_directive_if.html");
  6.                 templateBO.setITEXTUrl("http://developers.itextpdf.com/examples-itext5");
  8.     templateBO.setJFreeChartUrl("http://www.yiibai.com/jfreechart/jfreechart_referenced_apis.html");
  9.         templateBO.setImageUrl("https://ss0.bdstatic.com/5aV1bjqh_Q23odCf/static/superman/img/logo/bd_logo1_31bdc765.png");
  11.              List<String> scores=new ArrayList<String>();
  12.                 scores.add("90");
  13.                 scores.add("95");
  14.                 scores.add("98");
  15.                 templateBO.setScores(scores);
  16.                 List<Line> lineList=getTemperatureLineList();
  17.                 TemperatureLineChart lineChart=new TemperatureLineChart();
  18.                 String picUrl=lineChart.draw(lineList,0);//自定义的数据画图
  19.                 templateBO.setPicUrl(picUrl);
  20.                 String path= kit.createPDF(templateBO,"hello.pdf");
  21.             System.out.println(path);
  23.         }

六、生成效果图：

七、项目完整代码

  1. 1、github地址：https://github.com/superad/pdf-kit
  2. 2、项目git地址：git@github.com:superad/pdf-kit.git

八、遇到的坑：

1、FreeMarker配置模板文件样式，在实际PDF生成过程中，可能会出现一些不一致的情形，目前解决方法，就是换种方式调整样式。

2、字体文件放在resource下，在打包时会报错，运行mvn -X compile 会看到详细错误：
这是字体文件是二进制的，而maven项目中配置了资源文件的过滤，不能识别二进制文件导致的，
plugins中增加下面这个配置就好了：

  1. <build>
  2.     <resources>
  3.         <resource>
  4.             <directory>src/main/resources</directory>
  5.             <filtering>true</filtering>
  6.         </resource>
  7.     </resources>
  8.     <!--增加的配置,过滤ttf文件的匹配-->
  9.     <plugins>
  10.         <plugin>
  11.             <groupId>org.apache.maven.plugins</groupId>
  12.             <artifactId>maven-resources-plugin</artifactId>
  13.             <version>2.7</version>
  14.             <configuration>
  15.                 <encoding>UTF-8</encoding>
  16.                 <nonFilteredFileExtensions>
  17.                     <nonFilteredFileExtension>ttf</nonFilteredFileExtension>
  18.                 </nonFilteredFileExtensions>
  19.             </configuration>
  20.         </plugin>
  21.     </plugins>
  22. </build>

3、PDF分页配置：

  1.   在ftl文件中，增加分页标签： <span style="page-break-after:always;"></span>

九、 完整maven配置：

 
  1. <!--pdf生成 itext-->
  3.  <dependency>
  4.         <groupId>com.itextpdf</groupId>
  5.         <artifactId>itextpdf</artifactId>
  6.         <version>5.4.2</version>
  7.      </dependency>
  8.  <dependency>
  9.     <groupId>com.itextpdf.tool</groupId>
  10.     <artifactId>xmlworker</artifactId>
  11.     <version>5.4.1</version>
  12. </dependency>
  13. <dependency>
  14.     <groupId>com.itextpdf</groupId>
  15.     <artifactId>itext-asian</artifactId>
  16.     <version>5.2.0</version>
  17. </dependency>
  18. <dependency>
  19.     <groupId>org.xhtmlrenderer</groupId>
  20.     <artifactId>flying-saucer-pdf</artifactId>
  21.     <version>9.0.3</version>
  22. </dependency>
  23. <!--freemarker-->
  24. <dependency>
  25.     <groupId>org.freemarker</groupId>
  26.     <artifactId>freemarker</artifactId>
  27.     <version>2.3.26-incubating</version>
  28. </dependency>
  29. <!--jfreechart-->
  30. <dependency>
  31.     <groupId>jfreechart</groupId>
  32.     <artifactId>jfreechart</artifactId>
  33.     <version>1.0.0</version>
  34. </dependency>
  35. <!--log-->
  36. <dependency>
  37.     <groupId>ch.qos.logback</groupId>
  38.     <artifactId>logback-core</artifactId>
  39.     <version>1.0.13</version>
  40. </dependency>
  41. <dependency>
  42.     <groupId>ch.qos.logback</groupId>
  43.     <artifactId>logback-classic</artifactId>
  44.     <version>1.0.13</version>
  45. </dependency>
  46. <dependency>
  47.     <groupId>ch.qos.logback</groupId>
  48.     <artifactId>logback-access</artifactId>
  49.     <version>1.0.13</version>
  50. </dependency>
  51. <dependency>
  52.     <groupId>org.slf4j</groupId>
  53.     <artifactId>slf4j-api</artifactId>
  54.     <version>1.7.5</version>
  55. </dependency>
  56. <dependency>
  57.     <groupId>org.slf4j</groupId>
  58.     <artifactId>log4j-over-slf4j</artifactId>
  59.     <version>1.7.21</version>
  60. </dependency>
  61. <!--util-->
  62. <dependency>
  63.     <groupId>com.google.guava</groupId>
  64.     <artifactId>guava</artifactId>
  65.     <version>20.0</version>
  66. </dependency>
  67. <dependency>
  68.     <groupId>org.projectlombok</groupId>
  69.     <artifactId>lombok</artifactId>
  70.     <version>1.14.8</version>
  71. </dependency>
  72. <dependency>
  73.     <groupId>org.apache.commons</groupId>
  74.     <artifactId>commons-io</artifactId>
  75.     <version>1.3.2</version>
  76. </dependency>
  77. <dependency>
  78.     <groupId>commons-lang</groupId>
  79.     <artifactId>commons-lang</artifactId>
  80.     <version>2.6</version>
  81. </dependency>
  82. <!--servlet-->
  83. <dependency>
  84.     <groupId>javax.servlet</groupId>
  85.     <artifactId>servlet-api</artifactId>
  86.     <version>2.5</version>
  87. </dependency>

java根据模板HTML动态生成PDF的更多相关文章

  1. 利用Java动态生成 PDF 文档

    利用Java动态生成 PDF 文档,则需要开源的API.首先我们先想象需求,在企业应用中,客户会提出一些复杂的需求,比如会针对具体的业务,构建比较典型的具备文档性质的内容,一般会导出PDF进行存档.那 ...

  2. Java 动态生成 PDF 文件

    每片文章前来首小诗:   今日夕阳伴薄雾,印着雪墙笑开颜.我心仿佛出窗前,浮在半腰望西天.  --泥沙砖瓦浆木匠 需求: 项目里面有需要java动态生成 PDF 文件,提供下载.今天我找了下有关了,系 ...

  3. java根据pdf模版动态生成pdf

    java根据pdf模版动态生成pdf package com.utils; import java.io.ByteArrayOutputStream; import java.io.File; imp ...

  4. django 动态生成PDF文件

    可以通过开源的Python PDF库ReportLab来实现PDF文件的动态生成. 一.安装ReportLab ReportLab库在PyPI上提供,可以使用pip来安装: $ pip install ...

  5. 第二章：视图层 - 10：动态生成PDF文件

    可以通过开源的Python PDF库ReportLab来实现PDF文件的动态生成. 一.安装ReportLab ReportLab库在PyPI上提供,可以使用pip来安装: $ pip install ...

  6. 在Java代码中使用iTextPDF生成PDF

    1. 生成PDF 载入字体 static { FontFactory.register("/fonts/msyh.ttf"); FontFactory.register(" ...

  7. 使用VTemplate模板引擎动态生成订单流程图

    1.VTemplate模板引擎的简介 VTemplate模板引擎也简称为VT,是基于.NET的模板引擎,它允许任何人使用简单的类似HTML语法的模板语言来引用.NET里定义的对象.当VTemplate ...

  8. java应用maven插件动态生成webservice代码

    pom.xml如下 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www ...

  9. freemarker动态生成word并将生成的word转为PDF,openoffice转换word乱码

    之前项目有个需求,需要先动态生成word内容,然后再预览生成word的内容(不能修改).整理一下,方便以后使用. 网上参考了好多大神的博客.具体也忘了参考谁的了,如有侵权,请告知修改. 思路一: 将目 ...

随机推荐

  1. Bogus URL svn: is not properly URI-encoded

    问题描述: 从浏览器地址栏复制出来的url   放到eclipse 的svn插件里,新建资源库位置 总是报错 Bogus URL svn: **********************  is not ...

  2. MySQL root密码忘记后更优雅的解决方法

    MySQL root密码忘记后更优雅的解决方法 https://www.jb51.net/article/143453.htm /usr/bin/mysqld_safe --defaults-file ...

  3. 一个查看Access数据库密码的工具

    一个可以查看Access数据库密码的工具AccessCracker.需要.net2.0环境支持. 网盘地址:https://pan.baidu.com/s/1btbsFcsKO0Enj-rjkTlz6 ...

  4. MySQL Replication Report

    很多人都会MySQL主从框架的搭建,但很多人没有真正理解同步基本用途.同步的基本原理,还有当Master和Slave同步断开后的处理以及导致Master和slave不同步的原因等等,当你对这些都了如指 ...

  5. final修饰的地址不能被修改

    package final0; /* * 顾客 */public class Customer { // 属性 String name; int age; // 父类object的方法 public ...

  6. 002_JavaSE笔记：单例模式

    一.应用杨景 在计算机系统中,线程池.缓存.日志对象.对话框.打印机.显卡的驱动程序对象常被设计成单例.这些应用都或多或少具有资源管理器的功能.每台计算机可以有若干个打印机,但只能有一个Printer ...

  7. http://blog.csdn.net/five3/article/details/7181521

    首先来了解什么是multipart/form-data请求: 根据http/1.1 rfc 2616的协议规定,我们的请求方式只有OPTIONS.GET.HEAD.POST.PUT.DELETE.TR ...

  8. 038 spark中使用sparksql对日志进行分析（属于小案例）

    一:使用sparksql开发 1.sparksql开发的两种方式 HQL:SQL语句开发 eq : sqlContext.sql("xxxx") DSL : sparkSql中Da ...

  9. 028.Zabbix常见故障

    一 中文乱码处理 1.1 现象 1.2 解决方法 将任意一中文字体上传至/usr/share/zabbix/fonts,如微软雅黑. vi /usr/share/zabbix/include/defi ...

  10. 关于Sql Server的一些知识点的定义总结

    数据库完整性:是指数据库中数据在逻辑上的一致性.正确性.有效性和相容性 实体完整性(Entity Integrity  行完整性):实体完整性指表中行的完整性.主要用于保证操作的数据(记录)非空.唯一 ...