Java 将html转pdf并下载

---

一、需求分析

需求如下：
1.根据用户的信息动态渲染html
2.访问接口时将html转为pdf并下载

二、引入依赖

此处模板渲染用到了Freemarker所以引入了相关依赖
html转pdf使用的依赖是itext

        <dependency>
            <groupId>com.itextpdf</groupId>
            <artifactId>itextpdf</artifactId>
            <version>5.5.10</version>
        </dependency>
        <dependency>
            <groupId>com.itextpdf</groupId>
            <artifactId>itext-asian</artifactId>
            <version>5.2.0</version>
        </dependency>
        <dependency>
            <groupId>com.itextpdf.tool</groupId>
            <artifactId>xmlworker</artifactId>
            <version>5.5.11</version>
        </dependency>
        <dependency>
            <groupId>org.xhtmlrenderer</groupId>
            <artifactId>flying-saucer-pdf-itext5</artifactId>
            <version>9.0.6</version>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
            <version>2.3.5.RELEASE</version>
        </dependency>

三、代码示例

1、controller层

import com.erfou.service.PdfTemplateRenderImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
public class FileController {

    @Autowired
    private PdfTemplateRenderImpl pdfTemplateRender;

    @RequestMapping("/")
    public ResponseEntity<byte[]> downloadTemplate() throws Exception {
        HttpHeaders headers = new HttpHeaders();
        String filename = new String("ssk.pdf".getBytes("utf-8"), "iso-8859-1");
        headers.setContentDispositionFormData("attachment", filename);
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
        //xxxxService.queryXXXById(); 查询数据填充到html模板中，使用map存放
        Map<String,Object> dataMap=new HashMap<>();
        dataMap.put("date","2022年10月12日");
        dataMap.put("name","耳否");
        dataMap.put("companyName","Koalaclass");
        //html模板名称
        byte[] bytes= pdfTemplateRender.render(dataMap,"/table.ftl");
        ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(bytes, headers, HttpStatus.CREATED);
        return responseEntity;
    }
}

2、service层

package com.erfou.service;

import javax.annotation.PostConstruct;
import java.io.IOException;
import java.util.Map;
import java.io.StringWriter;
import java.io.Writer;

import com.erfou.utils.PdfUtil;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import org.springframework.stereotype.Service;

@Service
public class PdfTemplateRenderImpl {

    private Configuration configuration;

    @PostConstruct
    private void init() throws IOException {
        configuration = new Configuration(Configuration.VERSION_2_3_23);
        //download是存放html文件的目录，对该目录下的html文件进行加载
        configuration.setClassLoaderForTemplateLoading(this.getClass().getClassLoader(), "/templates");
        configuration.setDefaultEncoding("UTF-8");
    }
    public  byte[] render(Map<String, Object> data, String templateFileName) throws Exception {

        String htmlContent = freeMarkerVar(data, templateFileName);

        return PdfUtil.htmlToPdf(htmlContent);

    }

    private String freeMarkerVar(Map<String, Object> data, String templateFileName) throws Exception {
        try {
            // 加载一个模板文件，创建一个模板对象
            Template template = configuration.getTemplate(templateFileName);
            Writer writer = new StringWriter();
            template.process(data, writer);
            return writer.toString();
        } catch (IOException | TemplateException e) {
            throw new Exception("系统异常", e);
        }

    }
}

3、工具类

import java.io.ByteArrayOutputStream;
import java.io.FileNotFoundException;

import com.itextpdf.text.pdf.BaseFont;
import org.xhtmlrenderer.pdf.ITextFontResolver;
import org.xhtmlrenderer.pdf.ITextRenderer;

public class PdfUtil {

    /**
     * 将html 转化为 pdf
     * @param htmlContent html utf-8编码
     * @return pdf文件字节流
     */
    public static byte[] htmlToPdf(String htmlContent) throws Exception {

        try {
            ITextRenderer renderer = new ITextRenderer();
            //解决中文不显示问题
            ITextFontResolver fontResolver = renderer.getFontResolver();
// 可以将本地字体文件复制到项目中        
   //fontResolver.addFont(PdfUtil.class.getClass().getResource("/ststic/font/simhei.ttf").getPath(), BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
//此处引用的本地的字体文件如果部署到linux上请自行查询相关字体文件
            fontResolver.addFont("c:/Windows/Fonts/simsun.ttc", BaseFont.IDENTITY_H, BaseFont.NOT_EMBEDDED);
            renderer.setDocumentFromString(htmlContent);
            renderer.layout();
            ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
            renderer.createPDF(outputStream);
            return outputStream.toByteArray();

        } catch (FileNotFoundException e) {
            throw new Exception("系统异常", e);
        } catch (Exception e) {
            throw new Exception("系统异常", e);
        }
    }
}

4、html：table.ftl

DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta charset="UTF-8"/>
    <title>表格样式title>
    <meta name="viewport" content="initial-scale=1, maximum-scale=1, user-scalable=no, width=device-width"/>
    <link rel="stylesheet" href="https://static.loyalvalleycapital.com/web/css/frame.css"/>
    <style>
        table.table-separate th{
            font-weight:bold;
            font-size:14px;
            border-top:1px solid #F3EDE9 !important;
        }
        table.table-separate td{
            padding: 13px 0;
            font-weight:100;
        }
        .table-separate td.tit{
            background-color: #f4f9fe;
            font-weight:normal;
            padding:22px 0;
            width:15%;
        }
        .table-separate td.cont{
            text-align: left;
            padding:16px 22px;
            width:85%;
            line-height:175%;
        }
        .table-separate.no-border th{
            border:none;
            text-align: left;
        }
        .table-separate.no-border td{
            text-align: left;
            border:none;
        }

        table {
            border-collapse: collapse;
            table-layout: fixed;
            word-break:break-all;
            font-size: 10px;
            width: 100%;
            text-align: center;
        }
        td {
            word-break:break-all;
            word-wrap : break-word;
        }
        @page {
            size:210mm 297mm;//纸张大小A4
        margin: 0.25in;
            -fs-flow-bottom: "footer";
            -fs-flow-left: "left";
            -fs-flow-right: "right";
            padding: 1em;
        }
        #footer {
            font-size: 90%; font-style: italic;
            position: absolute; top: 0; left: 0;
            -fs-move-to-flow: "footer";
        }
        #pagenumber:before {
            content: counter(page);
        }
        #pagecount:before {content: counter(pages);
        }
    style>
head>
<body class="bg-white pb-3"  style = "font-family: SimSun;">
<div id="footer" style="">  Page <span id="pagenumber"/> of <span id="pagecount"/> div>
<div style="max-width:600px;margin:0 auto;padding:10px;">
    <div class="f18 text-center mv-2 bold">${companyName!""}合伙人服务日报div>
    <div class="f14 text-center mb-3">${date!""}div>

    <div class="">
        <div class="f14 mb bold">一、旗舰基金股东动态div>
        <div class="f14 mb">1、旗舰基金公司新闻div>
        <table class="table-separate">
            <tbody>
            <tr>
                <td class="tit" valign="middle">${name!""}td>

                <td class="cont">
                    <p class="bold">&nbps;第 3 期员工持股计划（草案）摘要p>
                    <p>1、甘肃刚泰控股（集团）股份有限公司（以下简称“公司”）第3期员工持 股计划（以下简称“第3期员工持股计划”）根据《中华人民共和国公司法》、《中华人民共和国证券法》、
                        《关于上市公司实施员工持股计划试点的指导意见》 及其他有关法律、法规、规范性文件以及《甘肃刚泰控股（集团）股份有限公司章程》的规定制定，遵循公平、公正、公开的原则，旨在完善公司的激励机制，确保公司未来发展战略和经营目标的实现。p>
                    <p>4、第3期员工持股计划以“份”作为认购单位，每份份额为1元，起始认购 份数为100万份，超过100万份的，以10万份的整数倍累积计算。公司全部员工 持股计划涉及的股票数量累计不超过公司现有股本总额的10%，任一持有人持有的 员工持股计划份额所对应的标的股票数量不超过公司股本总额的 1%（不包括员工 在公司首次公开发行股票上市前获得的股份、通过二级市场自行购买的股份及通过股权激励获得的股份）。p>
                td>
            tr>
            tbody>
        table>


        <div class="f14 mt-3 mb bold">一、客户沟通和反馈div>
        <div class="f14 mb">今天联系的客户：div>
        <div class="">
            <table class="table-separate">
                <thead>
                <th>联系人th>
                <th>沟通内容th>
                <th>客户反馈th>
                thead>
                <tbody>
                <tr>
                    <td>XXXtd>
                    <td>XXXtd>
                    <td>XXXtd>
                tr>
                <tr>
                    <td>XXXtd>
                    <td>XXXtd>
                    <td>XXXtd>
                tr>
                tbody>
            table>
        div>


        <div class="f14 mt-3 mb bold">三、官网、微信和客户服务系统变化div>
        <div class="">
            <table class="table-separate">
                <tbody>
                <tr>
                    <td class="tit" valign="middle">运营td>
                    <td class="">
                        <p class="bold">XXXp>
                    td>
                    <td class="text-left pl-2">
                        <p>· 上海正心公益基金会正式获批 1727 p>
                        <p>· XXXXp>
                    td>
                tr>

                tbody>
            table>
        div>

        <div class="f14 mt-3 mb bold">四、其他工作div>
        <div class="f14 mb">近期过生日的客户有： div>
        <div class="">
            <p>8.27 王军p>
            <p class="bold">8.27 陈鱼海p>
        div>
    div>
div>

body>
html>

5、配置文件

server:
  port: 8080
spring:
  freemarker:
    template-loader-path: classpath:/templates
    cache: false
    charset: utf-8
    suffix: .ftl
    settings:
      number_format: 0
  mvc:
    static-path-pattern: /static/**

目录结构如下

四、PDF展示

五、踩坑日记

1.中文不显示问题，这个问题在pdfUtil类中我已经解决了，需要在html页面中设置字体，然后pdfUtil加载一个字体集xx.ttf文件
2.图片加载不出来问题，图片路径尽量使用http:xxxx连接，另外要使用img标签，不要使用image标签
3.在html中尽量不要使用css3的语法，否则下载出来的pdf可能对css3的样式会失效
4.html页面取值的时候，如果后台传过来是空，那么直接会报错，可以在页面进行一个控制，如果为空就显示空字符串 ,如下图所示：

5.生成的pdf有白色边框的问题，有问题的形式如下：

这样有白色边框是有问题的，解决方法就是在html(ftl)文件中添加样式

@page:left{
   margin: 0cm;
} 
@page:right{
   margin: 0cm;
}

六、Demo地址

https://download.csdn.net/download/qq_43548590/86748933