Java iText+FreeMarker生成PDF(HTML转PDF)
1.背景
在某些业务场景中,需要提供相关的电子凭证,比如网银/支付宝中转账的电子回单,签约的电子合同等。方便用户查看,下载,打印。目前常用的解决方案是,把相关数据信息,生成对应的pdf文件返回给用户。

本文源码:http://git.oschina.net/lujianing/java_pdf_demo
2.iText
iText是著名的开放源码的站点sourceforge一个项目,是用于生成PDF文档的一个java类库。通过iText不仅可以生成PDF或rtf的文档,而且可以将XML、Html文件转化为PDF文件。
iText 官网:http://itextpdf.com/
iText 开发文档: http://developers.itextpdf.com/developers-home
iText目前有两套版本iText5和iText7。iText5应该是网上用的比较多的一个版本。iText5因为是很多开发者参与贡献代码, 因此在一些规范和设计上存在不合理的地方。iText7是后来官方针对iText5的重构,两个版本差别还是挺大的。不过在实际使用中,一般用到的都比较 简单,所以不用特别拘泥于使用哪个版本。比如我们在http://mvnrepository.com/中搜索iText,出来的都是iText5的依赖。
来个最简单的例子:
添加依赖:

com.itextpdf itextpdf 5.5.11 测试代码:JavaToPdf package com.lujianing.test;

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Paragraph;
import com.itextpdf.text.pdf.PdfWriter;

import java.io.FileNotFoundException;
import java.io.FileOutputStream;

/**

  • Created by lujianing on 2017/5/7.
    */
    public class JavaToPdf {

    private static final String DEST = “target/HelloWorld.pdf”;

    public static void main(String[] args) throws FileNotFoundException, DocumentException {
    Document document = new Document();
    PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(DEST));
    document.open();
    document.add(new Paragraph(“hello world”));
    document.close();
    writer.close();
    }
    }
    运行结果:

3.iText-中文支持
iText默认是不支持中文的,因此需要添加对应的中文字体,比如黑体simhei.ttf
可参考文档:http://developers.itextpdf.com/examples/font-examples/using-fonts#1227-tengwarquenya1.java
测试代码:JavaToPdfCN
package com.lujianing.test;

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Font;
import com.itextpdf.text.FontFactory;
import com.itextpdf.text.Paragraph;
import com.itextpdf.text.pdf.BaseFont;
import com.itextpdf.text.pdf.PdfWriter;

import java.io.FileNotFoundException;
import java.io.FileOutputStream;

/**

  • Created by lujianing on 2017/5/7.
    */
    public class JavaToPdfCN {

    private static final String DEST = “target/HelloWorld_CN.pdf”;
    private static final String FONT = “simhei.ttf”;

    public static void main(String[] args) throws FileNotFoundException, DocumentException {
    Document document = new Document();
    PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(DEST));
    document.open();
    Font f1 = FontFactory.getFont(FONT, BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
    document.add(new Paragraph(“hello world,我是鲁家宁”, f1));
    document.close();
    writer.close();
    }
    }
    输出结果:

4.iText-Html渲染
在一些比较复杂的pdf布局中,我们可以通过html去生成pdf
可参考文档:http://developers.itextpdf.com/examples/xml-worker-itext5/xml-worker-examples
添加依赖:

com.itextpdf.tool xmlworker 5.5.11 添加模板:template.html
<br /> Title<br />

你好,鲁家宁

测试代码:JavaToPdfHtml package com.lujianing.test;

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.pdf.PdfWriter;
import com.itextpdf.tool.xml.XMLWorkerFontProvider;
import com.itextpdf.tool.xml.XMLWorkerHelper;
import com.lujianing.test.util.PathUtil;

import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.charset.Charset;

/**

  • Created by lujianing on 2017/5/7.
    */
    public class JavaToPdfHtml {

    private static final String DEST = “target/HelloWorld_CN_HTML.pdf”;
    private static final String HTML = PathUtil.getCurrentPath()+"/template.html";
    private static final String FONT = “simhei.ttf”;

    public static void main(String[] args) throws IOException, DocumentException {
    // step 1
    Document document = new Document();
    // step 2
    PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(DEST));
    // step 3
    document.open();
    // step 4
    XMLWorkerFontProvider fontImp = new XMLWorkerFontProvider(XMLWorkerFontProvider.DONTLOOKFORFONTS);
    fontImp.register(FONT);
    XMLWorkerHelper.getInstance().parseXHtml(writer, document,
    new FileInputStream(HTML), null, Charset.forName(“UTF-8”), fontImp);
    // step 5
    document.close();
    }
    }
    输出结果:

需要注意:
1.html中必须使用标准的语法,标签一定需要闭合
2.html中如果有中文,需要在样式中添加对应字体的样式

5.iText-Html-Freemarker渲染
在实际使用中,html内容都是动态渲染的,因此我们需要加入模板引擎支持,可以使用FreeMarker/Velocity,这里使用FreeMarker举例
添加FreeMarke依赖:

org.freemarker freemarker 2.3.30 添加模板:template_freemarker.html
<br /> Title<br />

你好,${name}

测试代码:JavaToPdfHtmlFreeMarker package com.lujianing.test;

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.pdf.PdfWriter;
import com.itextpdf.tool.xml.XMLWorkerFontProvider;
import com.itextpdf.tool.xml.XMLWorkerHelper;
import com.lujianing.test.util.PathUtil;

import freemarker.template.Configuration;
import freemarker.template.Template;

import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.Map;

/**

  • Created by lujianing on 2017/5/7.
    */
    public class JavaToPdfHtmlFreeMarker {

    private static final String DEST = “target/HelloWorld_CN_HTML_FREEMARKER.pdf”;
    private static final String HTML = “template_freemarker.html”;
    private static final String FONT = “simhei.ttf”;

    private static Configuration freemarkerCfg = null;

    static {
    freemarkerCfg =new Configuration();
    //freemarker的模板目录
    try {
    freemarkerCfg.setDirectoryForTemplateLoading(new File(PathUtil.getCurrentPath()));
    } catch (IOException e) {
    e.printStackTrace();
    }
    }

    public static void main(String[] args) throws IOException, DocumentException {
    Map<String,Object> data = new HashMap();
    data.put(“name”,“鲁家宁”);
    String content = JavaToPdfHtmlFreeMarker.freeMarkerRender(data,HTML);
    JavaToPdfHtmlFreeMarker.createPdf(content,DEST);
    }

    public static void createPdf(String content,String dest) throws IOException, DocumentException {
    // step 1
    Document document = new Document();
    // step 2
    PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream(dest));
    // step 3
    document.open();
    // step 4
    XMLWorkerFontProvider fontImp = new XMLWorkerFontProvider(XMLWorkerFontProvider.DONTLOOKFORFONTS);
    fontImp.register(FONT);
    XMLWorkerHelper.getInstance().parseXHtml(writer, document,
    new ByteArrayInputStream(content.getBytes()), null, Charset.forName(“UTF-8”), fontImp);
    // step 5
    document.close();

    }

    /**

    • freemarker渲染html
      */
      public static String freeMarkerRender(Map<String, Object> data, String htmlTmp) {
      Writer out = new StringWriter();
      try {
      // 获取模板,并设置编码方式
      Template template = freemarkerCfg.getTemplate(htmlTmp);
      template.setEncoding(“UTF-8”);
      // 合并数据模型与模板
      template.process(data, out); //将合并后的数据和模板写入到流中,这里使用的字符流
      out.flush();
      return out.toString();
      } catch (Exception e) {
      e.printStackTrace();
      } finally {
      try {
      out.close();
      } catch (IOException ex) {
      ex.printStackTrace();
      }
      }
      return null;
      }
      }
      输出结果:

目前为止,我们已经实现了iText通过Html模板生成Pdf的功能,但是实际应用中,我们发现iText并不能对高级的CSS样式进行解析,比如CSS中的position属性等,因此我们要引入新的组件
若中文变量还是不显示,则在pom.xml里添加如下:

  
    
      src/main/resources
      true
    
  
  
  
    
      org.apache.maven.plugins
      maven-resources-plugin
      2.7
      
      UTF-8
        
        ttf
        
      
    
  

备注:工具类的方法 PathUtil.getCurrentPath() = “src/main/resources/”,(这个对新手有用)
6.Flying Saucer-CSS高级特性支持
Flying Saucer is a pure-Java library for rendering arbitrary well-formed XML (or XHTML) using CSS 2.1 for layout and formatting, output to Swing panels, PDF, and images.
Flying Saucer是基于iText的,支持对CSS高级特性的解析。
添加依赖:

org.xhtmlrenderer flying-saucer-pdf 9.1.5 org.xhtmlrenderer flying-saucer-pdf-itext5 9.1.5 添加模板:template_freemarker_fs.html
<br /> Title<br />

你好,${name}

测试代码:JavaToPdfHtmlFreeMarker package com.lujianing.test.flyingsaucer;

import com.itextpdf.text.DocumentException;
import com.itextpdf.text.pdf.BaseFont;
import com.lujianing.test.util.PathUtil;
import freemarker.template.Configuration;
import freemarker.template.Template;
import org.xhtmlrenderer.pdf.ITextFontResolver;
import org.xhtmlrenderer.pdf.ITextRenderer;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

/**

  • Created by lujianing on 2017/5/7.
    */
    public class JavaToPdfHtmlFreeMarker {

    private static final String DEST = “target/HelloWorld_CN_HTML_FREEMARKER_FS.pdf”;
    private static final String HTML = “template_freemarker_fs.html”;
    private static final String FONT = “simhei.ttf”;
    private static final String LOGO_PATH = “file://”+PathUtil.getCurrentPath()+"/logo.png";

    private static Configuration freemarkerCfg = null;

    static {
    freemarkerCfg =new Configuration();
    //freemarker的模板目录
    try {
    freemarkerCfg.setDirectoryForTemplateLoading(new File(PathUtil.getCurrentPath()));
    } catch (IOException e) {
    e.printStackTrace();
    }
    }

    public static void main(String[] args) throws IOException, DocumentException, com.lowagie.text.DocumentException {
    Map<String,Object> data = new HashMap();
    data.put(“name”,“鲁家宁”);
    String content = JavaToPdfHtmlFreeMarker.freeMarkerRender(data,HTML);
    JavaToPdfHtmlFreeMarker.createPdf(content,DEST);
    }

    /**

    • freemarker渲染html
      */
      public static String freeMarkerRender(Map<String, Object> data, String htmlTmp) {
      Writer out = new StringWriter();
      try {
      // 获取模板,并设置编码方式
      Template template = freemarkerCfg.getTemplate(htmlTmp);
      template.setEncoding(“UTF-8”);
      // 合并数据模型与模板
      template.process(data, out); //将合并后的数据和模板写入到流中,这里使用的字符流
      out.flush();
      return out.toString();
      } catch (Exception e) {
      e.printStackTrace();
      } finally {
      try {
      out.close();
      } catch (IOException ex) {
      ex.printStackTrace();
      }
      }
      return null;
      }

    public static void createPdf(String content,String dest) throws IOException, DocumentException, com.lowagie.text.DocumentException {
    ITextRenderer render = new ITextRenderer();
    ITextFontResolver fontResolver = render.getFontResolver();
    fontResolver.addFont(FONT, BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
    // 解析html生成pdf
    render.setDocumentFromString(content);
    //解决图片相对路径的问题
    render.getSharedContext().setBaseURL(LOGO_PATH);
    render.layout();
    render.createPDF(new FileOutputStream(dest));
    }
    }
    输出结果:

在某些场景下,html中的静态资源是在本地,我们可以使用render.getSharedContext().setBaseURL()加载文件资源,注意资源URL需要使用文件协议 “file://”。
对于生成的pdf页面大小,可以用css的@page属性设置。

7.PDF转图片
在某些场景中,我们可能只需要返回图片格式的电子凭证,我们可以使用Jpedal组件,把pdf转成图片
添加依赖:

org.jpedal jpedal-lgpl 4.74b27 测试代码:JavaToPdfImgHtmlFreeMarker package com.lujianing.test.flyingsaucer;

import com.itextpdf.text.DocumentException;
import com.itextpdf.text.pdf.BaseFont;
import com.lujianing.test.util.PathUtil;
import freemarker.template.Configuration;
import freemarker.template.Template;
import org.jpedal.PdfDecoder;
import org.jpedal.exception.PdfException;
import org.jpedal.fonts.FontMappings;
import org.xhtmlrenderer.pdf.ITextFontResolver;
import org.xhtmlrenderer.pdf.ITextRenderer;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import javax.imageio.ImageIO;

/**

  • Created by lujianing on 2017/5/7.
    */
    public class JavaToPdfImgHtmlFreeMarker {

    private static final String DEST = “target/HelloWorld_CN_HTML_FREEMARKER_FS_IMG.png”;
    private static final String HTML = “template_freemarker_fs.html”;
    private static final String FONT = “simhei.ttf”;
    private static final String LOGO_PATH = “file://”+PathUtil.getCurrentPath()+"/logo.png";
    private static final String IMG_EXT = “png”;

    private static Configuration freemarkerCfg = null;

    static {
    freemarkerCfg =new Configuration();
    //freemarker的模板目录
    try {
    freemarkerCfg.setDirectoryForTemplateLoading(new File(PathUtil.getCurrentPath()));
    } catch (IOException e) {
    e.printStackTrace();
    }
    }

    public static void main(String[] args) throws IOException, DocumentException, com.lowagie.text.DocumentException {
    Map<String,Object> data = new HashMap();
    data.put(“name”,“鲁家宁”);

     String content = JavaToPdfImgHtmlFreeMarker.freeMarkerRender(data,HTML);ByteArrayOutputStream pdfStream = JavaToPdfImgHtmlFreeMarker.createPdf(content);ByteArrayOutputStream imgSteam = JavaToPdfImgHtmlFreeMarker.pdfToImg(pdfStream.toByteArray(),2,1,IMG_EXT);FileOutputStream fileStream = new FileOutputStream(new File(DEST));fileStream.write(imgSteam.toByteArray());fileStream.close();
    

    }

    /**

    • freemarker渲染html
      */
      public static String freeMarkerRender(Map<String, Object> data, String htmlTmp) {
      Writer out = new StringWriter();
      try {
      // 获取模板,并设置编码方式
      Template template = freemarkerCfg.getTemplate(htmlTmp);
      template.setEncoding(“UTF-8”);
      // 合并数据模型与模板
      template.process(data, out); //将合并后的数据和模板写入到流中,这里使用的字符流
      out.flush();
      return out.toString();
      } catch (Exception e) {
      e.printStackTrace();
      } finally {
      try {
      out.close();
      } catch (IOException ex) {
      ex.printStackTrace();
      }
      }
      return null;
      }

    /**

    • 根据模板生成pdf文件流
      */
      public static ByteArrayOutputStream createPdf(String content) {
      ByteArrayOutputStream outStream = new ByteArrayOutputStream();
      ITextRenderer render = new ITextRenderer();
      ITextFontResolver fontResolver = render.getFontResolver();
      try {
      fontResolver.addFont(FONT, BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
      } catch (com.lowagie.text.DocumentException e) {
      e.printStackTrace();
      } catch (IOException e) {
      e.printStackTrace();
      }
      // 解析html生成pdf
      render.setDocumentFromString(content);
      //解决图片相对路径的问题
      render.getSharedContext().setBaseURL(LOGO_PATH);
      render.layout();
      try {
      render.createPDF(outStream);
      return outStream;
      } catch (com.lowagie.text.DocumentException e) {
      e.printStackTrace();
      } finally {
      try {
      outStream.close();
      } catch (IOException e) {
      e.printStackTrace();
      }
      }
      return null;
      }

    /**

    • 根据pdf二进制文件 生成图片文件

    • @param bytes pdf二进制

    • @param scaling 清晰度

    • @param pageNum 页数
      */
      public static ByteArrayOutputStream pdfToImg(byte[] bytes, float scaling, int pageNum,String formatName) {
      //推荐的方法打开PdfDecoder
      PdfDecoder pdfDecoder = new PdfDecoder(true);
      FontMappings.setFontReplacements();
      //修改图片的清晰度
      pdfDecoder.scaling = scaling;
      ByteArrayOutputStream out = new ByteArrayOutputStream();
      try {
      //打开pdf文件,生成PdfDecoder对象
      pdfDecoder.openPdfArray(bytes); //bytes is byte[] array with PDF
      //获取第pageNum页的pdf
      BufferedImage img = pdfDecoder.getPageAsImage(pageNum);

       ImageIO.write(img, formatName, out);
      

      } catch (PdfException e) {
      e.printStackTrace();
      } catch (IOException e){
      e.printStackTrace();
      }

      return out;
      }
      }
      输出结果:

Jpedal支持将指定页Pdf生成图片,pdfDecoder.scaling设置图片的分辨率(不同分辨率下文件大小不同) ,支持多种图片格式,具体更多可自行研究
8.总结
对于电子凭证的技术方案,总结如下:
1.html模板+model数据,通过freemarker进行渲染,便于维护和修改
2.渲染后的html流,可通过Flying Saucer组件生成pdf文件流,或者生成pdf后再转成jpg文件流
3.在Web项目中,对应的文件流,可以通过ContentType设置,在线查看/下载,不需通过附件服务

9.纯前端解决方案
还有一种解决方案是使用PhantomJS
git地址: https://github.com/ariya/phantomjs
PhantomJS 是一个基于 WebKit 的服务器端 JavaScript API。它全面支持web而不需浏览器支持,其快速,原生支持各种Web标准: DOM 处理, CSS 选择器, JSON, Canvas, 和 SVG。 PhantomJS 可以用于 页面自动化 , 网络监测 , 网页截屏 ,以及 无界面测试 等。
具体方法可自行查询。

10:个人使用注意事项:freewarker中不支持span标签的使用

HTML生成PDF模板(Java iText+FreeMarker生成PDF(HTML转PDF))相关推荐

  1. iText+freemarker 生成PDF 使用ftl模板

    iText+freemarker 生成PDF 生成样式图片 模板地址 maven PDF生成工具类 PDF生成辅助类 base64编码工具类 service方法调用 总结 生成样式图片 模板地址 ma ...

  2. Java使用freemarker生成word文档并转pdf文档

    Java使用freemarker生成word文档后转pdf 先来看看效果图 进入正题 项目需求: 为订单后生成对应的pdf文档,文档内包含图片. 方案一:使用freemarker和itext把html ...

  3. Java读取pdf模板,并动态生成pdf文件,如动态生成准考证

    Java读取pdf模板,并动态生成pdf文件,如动态生成准考证 ​ 前几天遇到了一个生成准考证的需求,并提供用户下载,然后百度了一圈还是觉得使用itextpdf这个框架好用点.但是还需要找到一个能创建 ...

  4. Java 用 Freemarker 生成 Word 时内容换行

    一.原因 试过各种换行符 '\r' '\n' '\r\n' '(char)11' 全部都不行!!! 原因是:Java 用 Freemarker 生成 Word 时的换行符被自动解析忽略掉 二.解决方法 ...

  5. PHP+Laravel+Fpdi+Fpdf 在PDF模板上编辑自定义文字并输出新PDF文件示例

    PHP+Laravel+Fpdi+Fpdf 在PDF模板上编辑自定义文字并输出新PDF文件示例 效果图展示 情景说明: 开发环境与准备 开发 相关文献: End 效果图展示 情景说明: 现在有个PDF ...

  6. Itext生成pdf文件,itext+Freemarker生成pdf,(中文空白解决)

    来源:https://my.oschina.net/lujianing/blog/894365 1.背景 在某些业务场景中,需要提供相关的电子凭证,比如网银/支付宝中转账的电子回单,签约的电子合同等. ...

  7. Java通过freemarker生成pdf文件并盖章

    Java代码生成pdf回执文件,直接上代码: package com.pdf;import java.io.BufferedWriter; import java.io.File; import ja ...

  8. Java iText PDF:用 iText 包生成简单的 pdf 文件

    有点兴趣想要看看 Java 怎么生成 PDF 文件,搜索了一下,据说 iText 包比较好,到 这里下载 iText.jar 包,顺便把源代码.文档都一起下载了吧.但是,仅仅有这么一些材料想要写代码生 ...

  9. Java实现freemarker生成word模板

    博主在做的是将word源文件中的内容读取出来,然后按照固定的格式输出,当然,源文件有大量,所以编写了程序来批量自动生成目标文件. 本文要介绍的就是如何生成模板,并将从源文件截取的内容填充到模板文件(即 ...

最新文章

  1. 探测参考信号(Sounding Reference Signal)
  2. 用Quartus II Timequest Timing Analyzer进行时序分析 :实例讲解 (一)
  3. 沉痛悼念 pip search 一路走好
  4. 【第41题】【062题库】2019年OCP认证062考试新题
  5. 机器学习基础 --- pandas的基本使用
  6. linux脚本实现scp命令自动输入密码和yes/no等确认信息
  7. 厉害了,自己手写一个Java热加载!
  8. 程序员都该知道这5个定律,有朋友使用后,现在已经是软件工程师!
  9. phpcmsV9 邮箱配置(含图文教程) - 案例篇
  10. 笔记本电脑风扇声音大怎么办_车子才开几年发动机就发出哒哒哒的声音怎么办?不一定是大问题_搜狐汽车...
  11. Python文件读写基本操作
  12. Java基础---数组
  13. Linux指令:top
  14. android 5.0 ble demo,Android BLE蓝牙例子(包括android版Lightblue)实例源码
  15. 【Scratch】进阶篇-《Scratch游戏开发》FlappyTurtle
  16. RGB与YIQ的转换
  17. 《程序员》杂志 · 2017 精华本
  18. 无忧看片,Python黑科技神奇去除马赛克
  19. 微信扫码下载APP(带有蒙层)
  20. PHP代码审计系统—RIPS

热门文章

  1. java产生随机数的方法_JAVA: java产生随机数的几种方式
  2. Web页面获取元素方法-selenium3 UI自动化
  3. 电子制造业管理软件如何解决产品质量管控难题?
  4. 学生请销假管理系统java_学生请假管理系统方案.doc
  5. 公交云推出公交数据大脑,智能公共出行时代风起云涌
  6. 学ruby用什么软件实现编程?Ruby的最佳IDE或文本编辑器
  7. python绘制太阳系_用OpenGL制作太阳系
  8. 海岛奇兵游戏设计分析
  9. 华为手机内置存储android可以删除吗,手机内置储存怎么清理 手机缓存清理教程...
  10. Unreal Open Day 2017整理