基于freemarker生成pdf

已于 2023-08-09 09:19:58 修改
阅读量4.6k 收藏 27
点赞数
分类专栏： 开发笔记 文章标签： java freemarker
于 2021-11-17 11:31:03 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_32434535/article/details/121374226
版权

环境准备

开发环境


java8,SpringBoot 2.1.4，字符集GBK

字体


宋体–simsun.ttf

pom依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>kernel</artifactId>
    <version>7.0.3</version>
</dependency>
<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>io</artifactId>
    <version>7.0.3</version>
</dependency>
<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>forms</artifactId>
    <version>7.0.3</version>
</dependency>
<!-- 解决中文字体问题 -->
<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>font-asian</artifactId>
    <version>7.0.3</version>
</dependency>
<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>itextpdf</artifactId>
    <version>5.5.13</version>
</dependency>
<dependency>
    <groupId>com.itextpdf.tool</groupId>
    <artifactId>xmlworker</artifactId>
    <version>5.5.13</version>
</dependency>
 <dependency>
  <groupId>org.xhtmlrenderer</groupId>
  <artifactId>flying-saucer-pdf</artifactId>
  <version>9.1.5</version>
</dependency>
<dependency>
  <groupId>org.xhtmlrenderer</groupId>
  <artifactId>flying-saucer-pdf-itext5</artifactId>
  <version>9.1.5</version>
</dependency>

模板生成PDF

将模板转换为html

从文件读取模板

/**
  * 初始化freemarker配置
  * templateRoot：模板文件根目录
  */
Configuration freemarkerCfg = initFreemarkerCfg(templateRoot);
/**
  * 将模板转换为HTML字符串
  */
String content = freeMarkerRender(data, freemarkerCfg, htmlTemplate, charSet);

private static Configuration initFreemarkerCfg(String templateRoot) {
   Configuration freemarkerCfg = new Configuration();
   try {
      freemarkerCfg.setDirectoryForTemplateLoading(new File(templateRoot));
   } catch (IOException e) {
      log.error("模板根路径获取失败!" + templateRoot, e);
      throw new RuntimeException("模板根路径获取失败!" + templateRoot,e);
   }
   return freemarkerCfg;
}

/**
  * data 需要注入模板的数据
  * freemarkerCfg freemarker配置
  * htmlTmp 模板名称
  * charSet 字符集 linux下使用UTF-8,windows下使用GBK，否则会出现中文乱码，模板文件的文件编码和声明编码同样需要保持一致
  */
private static String freeMarkerRender(Map<String, Object> data, Configuration freemarkerCfg, String htmlTmp,String charSet) {
   try (Writer out = new StringWriter();) {
      Template template = freemarkerCfg.getTemplate(htmlTmp);
      template.setEncoding(charSet);
      template.process(data, out);
      out.flush();
      return out.toString();
   } catch (Exception e) {
      log.error("HTML加载数据失败!", e);
      throw new RuntimeException("HTML加载数据失败!", e);
   }
}

从流读取模板

/**
  * data 需要注入模板的数据
  * fileName 文件名称
  * inputStream 模板文件流
  * charSet 字符集 linux下使用UTF-8,windows下使用GBK，否则会出现中文乱码，模板文件的文件编码和声明编码同样需要保持一致
  */
private static String freeMarkerRender(Map<String, Object> data, String fileName, InputStream inputStream,
      String charSet) {
   try (Writer out = new StringWriter();
         InputStreamReader inputStreamReader = new InputStreamReader(inputStream);) {
      Configuration configuration = new Configuration();
      Template template = new Template(fileName, inputStreamReader, configuration);
      template.setEncoding(charSet);
      template.process(data, out);
      out.flush();
      return out.toString();
   } catch (Exception e) {
      log.debug("HTML加载数据失败!", e);
      throw new RuleException(ErrCodeFile.CO_HTML_TEMPLATE_CONVERT_ERROR);
   }
}

生成PDF

/**
  * htmlContent 通过freemarker生成的html
  * fontPath 字体文件路径
  * ByteArrayOutputStream pdf文件流
  */
private static ByteArrayOutputStream htmlToPdf(String htmlContent, String fontPath) {
   try {
      ByteArrayOutputStream output = new ByteArrayOutputStream();
      ITextRenderer render = new ITextRenderer();
      ITextFontResolver fontResolver = render.getFontResolver();
      fontResolver.addFont(fontPath, BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
      render.setDocumentFromString(htmlContent);
      render.getSharedContext().setBaseURL(BASE_URL);
      render.layout();
      render.createPDF(output);
      return output;
   } catch (Exception e) {
      log.debug("html转换pdf失败!", e);
      throw new RuntimeException("html转换pdf失败!", e);
   }
}

添加水印和页码

从文件获取水印

/**
  * outputStream 生成的pdf流
  * waterMarkPath 水印文件路径
  * fontPath 字体路径
  * OutputStream pdf文件流
  */
private static OutputStream addWaterImage(ByteArrayOutputStream outputStream, String waterMarkPath,
      String fontPath) {
   BaseFont baseFont = createFont(fontPath);
   try (InputStream input = new ByteArrayInputStream(outputStream.toByteArray());) {
      ByteArrayOutputStream output = new ByteArrayOutputStream();
      PdfReader reader = new PdfReader(input);
      PdfStamper stamp = new PdfStamper(reader, output);
      PdfContentByte contentByte = null;
      int n = reader.getNumberOfPages();
      Image logo = null;
      if(StringUtils.isNotBlank(waterMarkPath)){
          logo = Image.getInstance(waterMarkPath);
      }
      for (int i = 1; i <= n; i++) {
         contentByte = stamp.getUnderContent(i);
         Rectangle rectangle = reader.getPageSize(i);
         float width = rectangle.getWidth();
         float height = rectangle.getHeight();
         if(logo != null){
         	logo.setAbsolutePosition(width / 2 - logo.getWidth() / 2, height / 2);
         	contentByte.addImage(logo);
         	contentByte.saveState();
         }
         String text = "第 " + i + " 页 /共 " + n + " 页";
         contentByte.beginText();
         contentByte.setFontAndSize(baseFont, 12);
         contentByte.showTextAligned(Element.ALIGN_CENTER, text, (width / 2) - 6, 15, 0);
         contentByte.endText();
      }
      reader.close();
      stamp.close();
      return output;
   } catch (Exception e) {
      log.debug("添加水印和页码失败," + waterMarkPath, e);
      throw new RuntimeException("添加水印和页码失败," + waterMarkPath, e);
   }
}

private static BaseFont createFont(String fontPath) {
   try {
      return BaseFont.createFont(fontPath, BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
   } catch (Exception e) {
      log.debug("字体读取失败," + fontPath, e);
      throw new RuntimeException("字体读取失败," + fontPath, e);
   }
}

从流获取水印

/**
  * outputStream 生成的pdf流
  * waterMarkPath 水印流
  * fontPath 字体路径
  * OutputStream pdf文件流
  */
private static OutputStream addWaterImage(ByteArrayOutputStream outputStream, InputStream waterMarkPath,
      String fontPath) {
   BaseFont baseFont = createFont(fontPath);
   try (InputStream input = new ByteArrayInputStream(outputStream.toByteArray());) {
      	ByteArrayOutputStream output = new ByteArrayOutputStream();
      	PdfReader reader = new PdfReader(input);
      	PdfStamper stamp = new PdfStamper(reader, output);
      	PdfContentByte contentByte = null;
      	int n = reader.getNumberOfPages();
       	Image logo = null;
       	if(waterMarkPath != null){
       		byte[] waterMarkBytes = IOUtils.toByteArray(inputStream);
            logo = Image.getInstance(waterMarkBytes);
        }
      	for (int i = 1; i <= n; i++) {
         	contentByte = stamp.getUnderContent(i);
         	Rectangle rectangle = reader.getPageSize(i);
         	float width = rectangle.getWidth();
         	float height = rectangle.getHeight();
         	if(logo != null){
         		logo.setAbsolutePosition(width / 2 - logo.getWidth() / 2, height / 2);
         		contentByte.addImage(logo);
         		contentByte.saveState();
         	}
         	String text = "第 " + i + " 页 /共 " + n + " 页";
         	contentByte.beginText();
        	contentByte.setFontAndSize(baseFont, 12);
         	contentByte.showTextAligned(Element.ALIGN_CENTER, text, (width / 2) - 6, 15, 0);
         	contentByte.endText();
      	}
     	 reader.close();
     	 stamp.close();
      	return output;
   	} catch (Exception e) {
      log.debug("添加水印和页码失败," + waterMarkPath, e);
      throw new RuntimeException("添加水印和页码失败," + waterMarkPath, e);
   	}
}

pdf加密码及权限设置

权限说明

权限说明
ALLOW_PRINTING文档允许打印
ALLOW_DEGRADED_PRINTING允许用户打印文档，但不提供allow_printing质量（128位加密）
ALLOW_MODIFY_CONTENTS允许用户修改内容，例如 更改页面内容，或插入或删除页
ALLOW_ASSEMBLY允许用户插入、删除和旋转页面和添加书签。页面的内容不能更改，除非也授予allow_modify_contents权限，（128位加密）
ALLOW_COPY允许用户复制或以其他方式从文档中提取文本和图形，包括使用辅助技术。例如屏幕阅读器或其他可访问设备
ALLOW_SCREENREADERS允许用户提取文本和图形以供易访问性设备使用，（128位加密）
ALLOW_MODIFY_ANNOTATIONS允许用户添加或修改文本注释和交互式表单字段
ALLOW_FILL_IN允许用户填写表单字段，（128位加密）


需要多个权限时，用|*（或符号）拼接即可

无水印页码


在生成PDF时添加权限及密码

private static ByteArrayOutputStream htmlToPdf(String htmlContent, String fontPath, String password, String adminPassword) {
   try {
      ByteArrayOutputStream output = new ByteArrayOutputStream();
      ITextRenderer render = new ITextRenderer();
      ITextFontResolver fontResolver = render.getFontResolver();
      setPDFEncryption(password, adminPassword, render);
      fontResolver.addFont(fontPath, BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
      render.setDocumentFromString(htmlContent);
      render.getSharedContext().setBaseURL(BASE_URL);
      render.layout();
      render.createPDF(output);
      return output;
   } catch (Exception e) {
      log.debug("html转换pdf失败!", e);
      throw new RuleException(ErrCodeFile.CO_HTML_TO_PDF_FAILED);
   }
}

/** 用户权限,根据需求自己设置*/
private static final int PERMIT = PdfWriter.ALLOW_PRINTING;
/** pdf加密类型*/
private static final int ENCRYPTION_TYPE = PdfWriter.STANDARD_ENCRYPTION_128;
private static void setPDFEncryption(String password, String adminPassword,ITextRenderer render) {
    PDFEncryption pdfEncryption = new PDFEncryption();
    // 用户密码
    pdfEncryption.setUserPassword(password.getBytes());
    // 管理员密码
    pdfEncryption.setOwnerPassword(adminPassword.getBytes());
    // 用户权限
    pdfEncryption.setAllowedPrivileges(PERMIT);
    // 加密类型
    pdfEncryption.setEncryptionType(ENCRYPTION_TYPE);
    render.setPDFEncryption(pdfEncryption);
}

有水印页码


在生成PDF时无需添加权限及密码，在添加水印及页码时添加

private static OutputStream addWaterImage(ByteArrayOutputStream outputStream, InputStream waterMarkPath,
      String fontPath, String password, String adminPassword) {
   BaseFont baseFont = createFont(fontPath);
   try (InputStream input = new ByteArrayInputStream(outputStream.toByteArray());) {
      	ByteArrayOutputStream output = new ByteArrayOutputStream();
      	PdfReader reader = new PdfReader(input);
      	PdfStamper stamp = new PdfStamper(reader, output);
       	// 用户密码，管理员密码，权限，加密类型
        stamp.setEncryption(password.getBytes(), adminPassword.getBytes(), PERMIT, ENCRYPTION_TYPE);
      	PdfContentByte contentByte = null;
      	int n = reader.getNumberOfPages();
       	Image logo = null;
       	if(waterMarkPath != null){
       		byte[] waterMarkBytes = IOUtils.toByteArray(inputStream);
            logo = Image.getInstance(waterMarkBytes);
        }
      	for (int i = 1; i <= n; i++) {
         	contentByte = stamp.getUnderContent(i);
         	Rectangle rectangle = reader.getPageSize(i);
         	float width = rectangle.getWidth();
         	float height = rectangle.getHeight();
         	if(logo != null){
         		logo.setAbsolutePosition(width / 2 - logo.getWidth() / 2, height / 2);
         		contentByte.addImage(logo);
         		contentByte.saveState();
         	}
         	String text = "第 " + i + " 页 /共 " + n + " 页";
         	contentByte.beginText();
        	contentByte.setFontAndSize(baseFont, 12);
         	contentByte.showTextAligned(Element.ALIGN_CENTER, text, (width / 2) - 6, 15, 0);
         	contentByte.endText();
      	}
     	 reader.close();
     	 stamp.close();
      	return output;
   	} catch (Exception e) {
      log.debug("添加水印和页码失败," + waterMarkPath, e);
      throw new RuntimeException("添加水印和页码失败," + waterMarkPath, e);
   	}
}

模板记录

1、字符集导致的乱码问题

<meta http-equiv="Content-Type" content="text/html; charset=GBK"/>


（历史原因导致开发使用GBK字符集，UTF-8的情况暂时未知）在windows上开发时，项目字符集，ftl文件，header的charset 均为GBK
部署在linux服务器时，ftl文件，header的charset均为UTF-8，否则生成PDF乱码

2、img标签

<img src="${logoImage}" width="204"/>


img标签支持base64格式data:image/png;base64,

data:,文本数据
data:text/plain,文本数据
data:text/html,HTML代码
data:text/html;base64,base64编码的HTML代码
data:text/css,CSS代码
data:text/css;base64,base64编码的CSS代码
data:text/javascript,Javascript代码
data:text/javascript;base64,base64编码的Javascript代码
data:image/gif;base64,base64编码的gif图片数据
data:image/png;base64,base64编码的png图片数据
data:image/jpeg;base64,base64编码的jpeg图片数据
data:image/x-icon;base64,base64编码的icon图片数据

3、强制分页

<p style="margin: 0pt">
    <div style="page-break-before: always; clear: both"/>
</p>

4、head记录

<head>
    <meta http-equiv="Content-Type" content="text/html; charset=GBK"/>
    <meta http-equiv="Content-Style-Type" content="text/css"/>
    <title>xxxx</title>
    <style type='text/css'>
        body {
            font-family: SimSun;
            padding-top: 50px;
        }

        @page {
            size: a4;
            @top-center {
                content: element(header);
            }
            @bottom-center {
                content: element(footer);
            }

        }

        div.header {
            display: block;
            /*text-align: center;*/
            position: running(header);
            width: 100%;
        }

        div.footer {
            display: block;
            text-align: center;
            position: running(footer);
            width: 100%;
        }

        .custom-page-start {
            margin-top: 50px;
        }

        table {
            border-collapse: collapse;
            margin: 0 auto;
            width: 100%;
        }

        td {
            border: #000000 solid 0.75pt;
            vertical-align: top;
            padding: 5pt;
        }

        p {
            line-height: 18pt;
            margin: 0pt 0pt 4pt;
        }

        span {
            font-size: 10pt;
        }

        @media print {
            table {
                page-break-after: auto
            }

            tr {
                page-break-inside: avoid;
                page-break-after: auto
            }

            td {
                page-break-inside: avoid;
                page-break-after: auto
            }

            thead {
                display: table-header-group
            }

            tfoot {
                display: table-footer-group
            }
        }       
    </style>
</head>

字体损坏

原因：maven打包时对字体文件进行编译，导致字体文件损坏

在pom.xml的build标签中添加如下插件，使相关文件不被编译

<plugin>
     <groupId>org.apache.maven.plugins</groupId>
     <artifactId>maven-resources-plugin</artifactId>
     <version>2.7</version>
         <configuration>
             <nonFilteredFileExtensions>
                 <nonFilteredFileExtension>ttf</nonFilteredFileExtension>
                 <nonFilteredFileExtension>ftl</nonFilteredFileExtension>
                 <nonFilteredFileExtension>html</nonFilteredFileExtension>
             </nonFilteredFileExtensions>
         </configuration>
         <dependencies>
             <dependency>
                 <groupId>org.apache.maven.shared</groupId>
                 <artifactId>maven-filtering</artifactId>
                 <version>1.3</version>
             </dependency>
         </dependencies>
</plugin>
杨小胖要减肥
关注
  • 0
    点赞
  • 踩
  • 27
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Freemarker模板生成pdf+java
06-06
Freemarker模板生成pdf+javaFreemarker模板生成pdf+javaFreemarker模板生成pdf+javaFreemarker模板生成pdf+javaFreemarker模板生成pdf+java
基于itext7+freemarker模板导出pdf
12-27
基于itext7+freemarker模板导出pdf，先生成html字符串再转成pdf，已解决中文问题，图片能正常显示
Java通过Html(ftl模板)生成PDF实战, 可支持商用
最新发布
Janche的博客
05-27 1494
springboot + freemarker + [pdfbox] + flying-saucer-pdf PS:网上很多文章使用 itext5/7来生成PDF的，用于个人学习或者开源项目确实没问题，但是不方便用于公司商业项目，因为itext是基于AGPL 的开源协议，商用是需要收费的，当然贵司愿意付费也是okay的。 包含页眉页脚页码等的处理，解决中文字体无法渲染等问题
使用freemarker模板生成pdf
JAVA_HIGHNESS的专栏
02-23 7377
使用freemarker编写html模板
freemark生成pdf
qq_34936628的博客
07-06 1113
字体库 simsun.ttc 解决中文问题。freemark生成pdf。
SpringBoot+Freemark根据html模板动态导出PDF
张刚的博客
08-01 1044
SpringBoot+Freemark根据html模板导出PDF。java导出PDF，动态导出PDF，FreeMark遍历，按条件是否显示列表
freemarker+html生成pdf.zip
03-26
freemarker html生成pdf 通过freemarker 和html模板生成对应的pdf或者图片 参考使用，欢迎下载
使用Freemarker来生成pdf文件
Jackbillzsc的博客
09-09 9929
使用Freemarker来生成pdf文件
java中freemarker使用ftl模版生成PDF文件
热门推荐
u010696176的博客
12-16 1万+
从jar中读取字体和ftl模版，如果你不想从jar中读取，可以自己改造一下，就是不管你是从其他地方读文件或者从数据库中字符串，总之你要把他转换成字符串
freemarker导出pdf
庭前云落的博客
09-17 1855
freemarker导出pdf
java使用 FreeMarker 生成 PDF文档
RookieDiaryX的博客
03-19 1135
文件地址：测试放本地（String path = this.getclass.getResource("/").getPath+"freemarker/ test/"）4:html生成pdf :htmlFile html路径；3.：生成html文件 String freeWordtest =“free_wordtest.ftl”;（名称记得替换为业务的名称最好保证唯一）: String htmlName = “测试”+".html";：需要传参，已经生成数据的html文件，生成的pdf地址。
JAVA项目代码绘制PDF和通过freemarker动态生成PDF
05-26
# 本项目主要介绍 1. itextpdf（CreatePdf） 不太推荐需要在代码内部编写PDF格式，如果要使用，建议写个基类，将同一版本 或者同一类型的公共方法写入，差异化的抽象，一个模板一个子类，子类使用@Component命名，使用反射的方式获取模板子类。 2. xhtmlrenderer（PdfUtil） 对于大部分PDF场景都还是非常方便简单的，可以模板可以让前端先使用**HTML**制作，调整好格式和样式后，再改名为ftl后缀。 3. freemarker（FreemarkerUtils） 对于没有使用宏、函数等word、excel,需要按模板动态生成word、excel、html，只需要一个freemarker，先将word、excel、html等另存为**xml**,即可使用模板动态生成文件，目前xlsx是不支持的 4. PdfTemplate 对于不会HTML的制作，熟悉**itextpdf**的，完全可以使用PdfTemplate，该方法其实就是将itextpdf中PDF的元素逆解析 5. xdocreport 复杂word动态生成上功能很强大
Java中使用 FreeMarker 生成pdf盖章合同文件
08-28
Java中使用FreeMarker生成PDF合同文件的过程主要包括配置FreeMarker环境、创建数据模型、解析模板、生成PDF以及添加图片盖章。通过结合FreeMarker的灵活性和Flying Saucer的转换能力，我们可以方便地将动态生成的...
通过freemarker模板 生成PDF
03-29
以下是一般的步骤来通过Freemarker和wkhtmltox生成PDF： 1. **创建Freemarker模板**：编写一个`.ftl`文件，包含HTML和Freemarker指令。 2. **准备数据模型**：在Java代码中，创建一个对象或Map，包含将要填充到模板...
freemarker+itext生成PDF
06-01
这篇博客 "freemarker+itext生成PDF" 可能详细介绍了如何结合这两者来生成PDF文件，这在报表生成、发票打印或任何需要静态化输出的场景中非常有用。 首先，让我们了解FreeMarker。FreeMarker是一个基于模板的语言，...
freemarker生成word
03-14
"FreeMarker生成Word文档" FreeMarker是一种基于Java的模板引擎，可以用来生成各种格式的文档，包括Word文档。在这个例子中，我们将使用FreeMarker生成一个Word文档。 依赖项 在POM文件中，我们需要添加FreeMarker...
freemarker模板生成pdf
人生就像一场戏
08-10 1万+
一，依赖jar包 <!-- freemarker 读取html模板文件 --> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.23</v...
Spring Boot Freemark HTML 生成 PDF、生成水印Logo、docx文件生成PDF，Jar包运行可读取模板文件、字体文件
lisaihang96的博客
08-09 5090
Spring Boot Freemark HTML 生成 PDF，Jar包运行可读取模板文件、字体文件
freemarker+itextpdf 生成 pdf
小单的博客专栏
06-06 970
其中 freemarker 生成 html 片段省略，本文直接用 html 生成 pdf。1、添加 itextpdf 依赖。
freemarker生成pdf
08-02
使用FreeMarker生成PDF的过程如下： 1. 首先，需要使用FreeMarker将FTL（FreeMarker模板文件）转换为HTML。这可以通过在Java代码中使用FreeMarker库来实现。 2. 接下来，使用jtidy库将生成的HTML转换为格式要求严格的XHTML。jtidy库可以帮助清理和修复HTML代码，确保其符合XHTML的规范。 3. 最后，使用iText库将XHTML转换为PDF。iText是一个功能强大的Java库，可以用于创建和操作PDF文件。 在项目的pom.xml文件中，需要添加以下依赖项： ```xml <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.23</version> </dependency> <dependency> <groupId>org.xhtmlrenderer</groupId> <artifactId>flying-saucer-pdf</artifactId> <version>9.0.9</version> </dependency> ``` 通过以上步骤和依赖项，你可以使用FreeMarker生成PDF文件。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值