备案控制台
探索云世界
开发者社区 开发与运维 文章 正文

springboot使用html模版导出pdf文档

2024-03-18 150
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： springboot使用html模版导出pdf文档

目录

[toc]

一、介绍

在我们日常开发中，经常会遇到导出pdf这种需求，比如导出合同、导出业务报告等。这中导出功能都有一个特点，导出的pdf中有大量相同的文本布局以及样式，只有涉及到用户本人的信息时出现不同的内容。我们把这些相同的部分称作模版，在模版中放置一些变量来代表用户信息，比如用户姓名、年龄等。这样我们在导出pdf的时候，在数据库中把用户信息查出来，对模版中对应的变量进行替换，再把替换的结果转成pdf文件就可以了。

模版的类型有很多种：html模版、doc模版、excel模版、pdf模版等等。项目中使用哪一种要具体情况具体考虑。

将变量替换后的模版转成pdf文件的工具也有很多，最主流最方面的当然要数itextpdf了。它可以将常见的任何形式的模版转成pdf文件。

前几天俺就遇到一个导出pdf的需求，而且该pdf有点花里胡哨，明显存在大量css样式，所以我们就采用html作为模版，通过itextpdf将html转成pdf。主要步骤如下：

  1. 将html模版生成html页面文本，对模版进行变量替换
  2. 将html页面文本转成pdf文件

二、使用html模版生成html页面文本

如何对html模版进行变量替换，生成html页面文本，这里向大家提供两个方案，这两个方案各有优缺点，可依个人情况选择。

  • 使用jsoup工具

    该工具处理html文本十分友好。你可以直接根据id、class等属性来获取对应的html元素(如：getElementsByAttributeValue("id", "value"))，然后对获取的元素通过text()方法设置文本内容。这有点类似python的爬虫工具beautifulSoup，

    • 优点：只要知道html模版的结构就行。
    • 缺点：处理复杂的结构如表格时，可能会对模版的html标签结构进行修改，因此处理逻辑较为复杂。

  • 使用模版引擎，以thymeleaf为例

    类似于jsp，thymeleaf支持HTML5作为模版文件，其提供的模版引擎十分强大，而且在spring官方文档中首推的模版引擎就是thymleaf，spring也默认集成了thymleaf，足以可见他的强大。

    • 优点：利用thymleaf模版引擎，只需三四行代码就可以完成整个html模版的变量替换。
    • 缺点：需要对thymleaf的使用有基本的了解。

1. 使用jsoup工具生成html页面文本

  • 引入依赖

    我们引入spring-boot-starter-web和jsoup的依赖

    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 处理xml风格的工具包，对html有效，包含Jsoup -->
<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>styled-xml-parser</artifactId>
    <version>7.2.3</version>
</dependency>

  • 创建模版

    在resources下新建目录templates，并创建一个html模版文件：StudentReport.html

    <!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8">
        <title></title>
    </head>
    <body>
        <h1 style="text-align: center;">学生报告</h1>
        <!-- 班级信息 -->
        <table border="1" style="text-align: center">
            <tr>
                <td>学校</td>
                <td>年级</td>
                <td>班级</td>
                <td>学生人数</td>
            </tr>
            <tr>
                <!-- 变量：学校 -->
                <td id="school"></td>
                <!-- 变量：年级 -->
                <td id="grade"></td>
                <!-- 变量：班级 -->
                <td id="class"></td>
                <!-- 变量：学生人数 -->
                <td id="studentNum"></td>
            </tr>
        </table>
        <h3>
            班级概况：
        </h3>
        <!-- 变量：班级概况 -->
        <p id="situation" style="text-indent: 2em;">

        </p>
        <h3>
            学生列表：
        </h3>
        <!-- 学生列表 -->
        <table border="1">
            <tbody>
                <!-- 表头 -->
                <tr>
                    <th>姓名</th>
                    <th>性别</th>
                    <th>年龄</th>
                    <th>父亲</th>
                    <th>母亲</th>
                </tr>
                <!-- 学生数据 -->
                <tr id="studentList">
                    <!-- 变量：姓名 -->
                    <td id="name"></td>
                    <!-- 变量：性别 -->
                    <td id="sex"></td>
                    <!-- 变量：年龄 -->
                    <td id="age"></td>
                    <!-- 变量：父亲 -->
                    <td id="father"></td>
                    <!-- 变量：母亲 -->
                    <td id="mother"></td>
                </tr>
            </tbody>
        </table>
    </body>
</html>

    在浏览器里打开该html模版如下图所示

  • 变量替换的逻辑

    如果html模版的结构相对来讲比较简单的话，变量替换的逻辑便不难理解。但若遇到复杂的结构，该逻辑便有点力不从心了，因为它具有一定的局限性，而且针对复杂的结构，变量替换的逻辑相对也会更加复杂。

    // 变量替换，src-html模版位置，params-进行变量替换的真实数据,key与html模版中标签的id属性一致，value为真实数据
public static String placeholder(String src, Map<String, Object> params) throws IOException {
     
    File file = new File(src);
    // 通过Jsoup创建Document对象，Document就可以表示整个html文本了。
    Document document = Jsoup.parse(file, "utf-8");

    // 设置内容文本，真正进行变量替换的方法
    setText(document, params);

    // 将变量替换好以后，输出html文本
    String outerHtml = document.outerHtml();
    System.out.println(outerHtml);

    return outerHtml;
}

// 给html模版设置文本数据，document-html模版，params-进行变量替换的真实数据
private static void setText(Document document, Map<String, Object> params) {
     
    Set<Map.Entry<String, Object>> entrySet = params.entrySet();
    for (Map.Entry<String, Object> entry : entrySet) {
     
        // 获取最后一个对应的element
        Element element = document.getElementsByAttributeValue("id", entry.getKey()).last();
        if ("tr".equals(element.tagName())) {
     
            List<Map<String, Object>> counselList = (List<Map<String, Object>>)entry.getValue();
            // 设置行，就是把列表数据设置到html的表格行中
            setRowsText(document, element, counselList);

        } else {
     
            // 对html元素设置文本
            element.text(entry.getValue().toString());
        }

    }
}

// 把列表数据设置到html的表格行中，document-html模版，element-表示一行的元素，即tr标签。list-真实列表数据
private static void setRowsText(Document document, Element element, List<Map<String, Object>> list) {
     

    if (list.isEmpty()) {
     
        return;
    }

    Iterator<Map<String, Object>> iterator = list.iterator();

    do {
     
        Map<String, Object> counsel = iterator.next();
        // 设置文本数据
        setText(document, counsel);

        if (iterator.hasNext()) {
     
            // 追加一行
            appendTableRow(element);
        }

    } while (iterator.hasNext());

    // 如果list集合中还有元素，则复制当前element追加到当前element后面，并循环到前面一步，
    // 如果list集合中没有元素了，则说明内容已经写完了，返回即可
}

// 扩展一行
private static void appendTableRow(Element element) {
     
    Node parent = element.parent();
    Element tbody = (Element) parent;
    tbody.appendChild((Node) element.clone());
}

  • 测试

    我们写一个Controller，通过接口来测试上面的方法

    @RestController
@RequestMapping("/student")
public class StudentController {
     

    @GetMapping("/placehold/jsoup")
    public String jsoup() throws IOException {
     
        // 获取html模版文件
        File tmpl = new ClassPathResource("templates/StudentReport.html").getFile();

        // 模拟数据库中查询的数据
        Map<String, Object> params = new HashMap<>();
        params.put("school", "家里蹲大学");
        params.put("grade", "八年级");
        params.put("class", "三班");
        params.put("studentNum", 999);
        params.put("situation", "这个班的学生相当吊炸天，勿以善小而不为，勿以恶小而为之，关关雎鸠，在水之洲。窈窕淑女，君子好逑。");

        List<Map<String, Object>> counselList = new ArrayList<>();
        counselList.add(getCounsel("周一", "男", 32, "周一他爸", "周一他妈"));
        counselList.add(getCounsel("周二", "女", 42, "周二他爸", "周二他妈"));
        counselList.add(getCounsel("周三", "男", 54, "周三他爸", "周三他妈"));
        counselList.add(getCounsel("周四", "男", 13, "周四他爸", "周四他妈"));
        counselList.add(getCounsel("周五", "女", 43, "周五他爸", "周五他妈"));
        counselList.add(getCounsel("周六", "女", 74, "周六他爸", "周六他妈"));
        counselList.add(getCounsel("周日", "男", 22, "周日他爸", "周日他妈"));
        params.put("studentList", counselList);

        String html = JsoupPlaceholdUtil.placeholder(tmpl, params);

        return html;
    }

    private Map<String, Object> getCounsel(String name, String sex, Integer age, String father, String mother) {
     
        Map<String, Object> params = new HashMap<>();
        params.put("name", name);
        params.put("sex", sex);
        params.put("age", age);
        params.put("father", father);
        params.put("mother", mother);
        return params;
    }
}

  • 在浏览器中访问该接口，localhost:port/student/placehold/jsoup

    从浏览器中我们可以看到，真实数据已经完美地放在html文本中了

2. 使用模版引擎生成html页面文本

模版引擎我们选择thymleaf的原因是spring天然支持，无需对其集成进行多余的配置，只需要引入依赖就可以使用了。

  • 引入依赖

    我们引入spring-boot-starter-web和thymeleaf的依赖

    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- thymeleaf模版引擎 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

  • 创建模版

    使用thymleaf模版引擎，就需要按照它的要求通过给html标签添加各种th:属性来写html模版。在resources下新建目录templates，并创建一个html模版文件：StudentReportTH.html。

    <!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org" lang="en">
<head>
    <meta charset="utf-8">
    <title></title>
</head>
<body>
<h1 style="text-align: center;">学生报告</h1>
<!-- 班级信息 -->
<table border="1" style="text-align: center">
    <tr>
        <td>学校</td>
        <td>年级</td>
        <td>班级</td>
        <td>学生人数</td>
    </tr>
    <tr>
        <td th:text="${school}">XX学校</td>
        <td th:text="${grade}">XX年级</td>
        <td th:text="${class}">XX班级</td>
        <td th:text="${studentNum}">0</td>
    </tr>
</table>
<h3>
    班级概况：
</h3>
<p id="situation" style="text-indent: 2em;">

</p>
<h3>
    学生列表：
</h3>
<!-- 学生列表 -->
<table border="1">
    <tbody>
    <!-- 表头 -->
    <tr>
        <th>姓名</th>
        <th>性别</th>
        <th>年龄</th>
        <th>父亲</th>
        <th>母亲</th>
    </tr>
    <!-- 学生数据 -->
    <tr th:each="student in ${studentList}" th:if="${studentList}">
        <td th:text="${student.name}">XXX</td>
        <td th:text="${student.sex}">XX</td>
        <td th:text="${student.age}">XXX</td>
        <td th:text="${student.father}">XXX</td>
        <td th:text="${student.mother}">XXX</td>
    </tr>
    </tbody>
</table>
</body>
</html>

    在浏览器里打开该html模版如下图所示

  • 变量替换

    有了thymeleaf，变量替换的任何细节我们都不用关心，只需要把模版和数据交给它就可以了。只需要仅仅4行代码。

    另外在springboot中已经自动将thymleaf添加到IOC容器中了，我们只需要依赖注入就可以了。

    @Autowired
private WebApplicationContext applicationContext;
@Autowired
private LocaleResolver localeResolver;
@Autowired
private SpringTemplateEngine springTemplateEngine;

public String thymeleaf(HttpServletRequest request, HttpServletResponse response) {
     

    // 实际数据
    Map<String, Object> params = new HashMap<>();

    // 变量替换
    Writer writer = new FastStringWriter();
    WebExpressionContext context = new WebExpressionContext(springTemplateEngine.getConfiguration(),
                                                            request,
                                                            response,
                                                            applicationContext.getServletContext(),
                                                            localeResolver.resolveLocale(request),
                                                            params);
    // springboot对thymeleaf的默认配置为 prefix="classpath:templates", suffix=".html"
    springTemplateEngine.process("StudentReportTH", context,writer);

    return s = writer.toString();
}

  • 测试

    我们写一个Controller，通过接口来测试上面的方法

    @RestController
@RequestMapping("/student")
public class StudentController {
     
  @Autowired
  private WebApplicationContext applicationContext;
  @Autowired
  private LocaleResolver localeResolver;
  @Autowired
  private SpringTemplateEngine springTemplateEngine;

  private Map<String, Object> getCounsel(String name, String sex, Integer age, String father, String mother) {
     
      Map<String, Object> params = new HashMap<>();
      params.put("name", name);
      params.put("sex", sex);
      params.put("age", age);
      params.put("father", father);
      params.put("mother", mother);
      return params;
  }

  @GetMapping("/placehold/thymeleaf")
  public String thymeleaf(HttpServletRequest request, HttpServletResponse response) {
     
      Map<String, Object> params = new HashMap<>();
      params.put("school", "家里蹲大学");
      params.put("grade", "八年级");
      params.put("class", "三班");
      params.put("studentNum", 999);
      params.put("situation", "这个班的学生相当吊炸天，勿以善小而不为，勿以恶小而为之，关关雎鸠，在水之洲。窈窕淑女，君子好逑。");

      List<Map<String, Object>> counselList = new ArrayList<>();
      counselList.add(getCounsel("周一", "男", 32, "周一他爸", "周一他妈"));
      counselList.add(getCounsel("周二", "女", 42, "周二他爸", "周二他妈"));
      counselList.add(getCounsel("周三", "男", 54, "周三他爸", "周三他妈"));
      counselList.add(getCounsel("周四", "男", 13, "周四他爸", "周四他妈"));
      counselList.add(getCounsel("周五", "女", 43, "周五他爸", "周五他妈"));
      counselList.add(getCounsel("周六", "女", 74, "周六他爸", "周六他妈"));
      counselList.add(getCounsel("周日", "男", 22, "周日他爸", "周日他妈"));
      params.put("studentList", counselList);

      Writer writer = new FastStringWriter();
      WebExpressionContext context = new WebExpressionContext(springTemplateEngine.getConfiguration(),
                                                              request,
                                                              response,
                                                              applicationContext.getServletContext(),
                                                              localeResolver.resolveLocale(request),
                                                              params);
      // springboot对thymeleaf的默认配置为 prefix="classpath:templates", suffix=".html"
      springTemplateEngine.process("StudentReportTH", context,writer);
      return s = writer.toString();}
}

  • 在浏览器中访问该接口，localhost:port/student/placehold/thymeleaf

    从浏览器中我们可以看到，真实数据已经完美地放在html文本中了，处理变量替换的逻辑也就四行。
    使用thymeleaf后html页面.png

三、将html页面文本转成pdf文件

上面我们通过两种方式对html模版进行变量替换并得到html文本内容了。接下来要做的就是把html文本内容转成pdf。

在上面pom.xml的基础上中引入依赖

<dependencies>

    <!-- itext核心包 -->
    <dependency>
        <groupId>com.itextpdf</groupId>
        <artifactId>itext7-core</artifactId>
        <version>7.2.3</version>
    </dependency>
    <!-- html转pdf，包含类似于jsoup依赖的操作html文档的依赖 -->
    <dependency>
        <groupId>com.itextpdf</groupId>
        <artifactId>html2pdf</artifactId>
        <version>4.0.3</version>
    </dependency>

</dependencies>

使用itextpdf将html文件转成pdf的过程也是相当简单。

// 设置字体
ConverterProperties converterProperties = new ConverterProperties();
FontSet fontSet = new FontSet();
if (!fontSet.addFont("C:\\Windows\\Fonts\\simhei.ttf")) {
   
    throw new RuntimeException("获取字体失败");
}
converterProperties.setFontProvider(new FontProvider(fontSet));
// html转pdf， 并将pdf作为字节数组保存在bos中
ByteArrayOutputStream bos = new ByteArrayOutputStream();
HtmlConverter.convertToPdf(jsoupHtml, bos, converterProperties);

然后我们对上面两种方式生成的html文本内容进行转换。

  • 对jsoup生成的html文本内容进行转换并测试

    @GetMapping("/export/jsoup")
public void exportJsoup(HttpServletResponse response) throws IOException {
     
    String jsoupHtml = jsoup();

    // 设置字体
    ConverterProperties converterProperties = new ConverterProperties();
    FontSet fontSet = new FontSet();
    if (!fontSet.addFont("C:\\Windows\\Fonts\\simhei.ttf")) {
     
        throw new RuntimeException("获取字体失败");
    }
    converterProperties.setFontProvider(new FontProvider(fontSet));

    ByteArrayOutputStream bos = new ByteArrayOutputStream();
    HtmlConverter.convertToPdf(jsoupHtml, bos, converterProperties);

    String fileName = "将jsoup生成的html转换成pdf文件";

    // 设置中文文件名
    fileName = new String(fileName.getBytes("utf-8"),"iso8859-1");
    String encode = URLEncoder.encode(fileName, "iso8859-1");

    ServletOutputStream outputStream = response.getOutputStream();
    response.setContentType("application/x-download");
    response.addHeader("Content-Disposition", "attachment; filename=" + encode + ".pdf");
    response.setCharacterEncoding("UTF-8");
    outputStream.write(bos.toByteArray());
}

    调用接口下载pdf文件

    下载jsoup转的pdf文件.png

然后打开下载的pdf文件

打开pdf文件.png

  • 对thymeleaf生成的html文本内容进行转换并测试

    与上面的步骤相同，接口如下

    @GetMapping("/export/thymeleaf")
public void exportThymeleaf(HttpServletRequest request, HttpServletResponse response) throws IOException {
     
    String jsoupHtml = thymeleaf(request, response);

    // 设置字体
    ConverterProperties converterProperties = new ConverterProperties();
    FontSet fontSet = new FontSet();
    if (!fontSet.addFont("C:\\Windows\\Fonts\\simhei.ttf")) {
     
        throw new RuntimeException("获取字体失败");
    }
    converterProperties.setFontProvider(new FontProvider(fontSet));

    ByteArrayOutputStream bos = new ByteArrayOutputStream();
    HtmlConverter.convertToPdf(jsoupHtml, bos, converterProperties);

    String fileName = "将thymeleaf生成的html转换成pdf文件";

    // 设置中文文件名
    fileName = new String(fileName.getBytes("utf-8"),"iso8859-1");
    String encode = URLEncoder.encode(fileName, "iso8859-1");

    ServletOutputStream outputStream = response.getOutputStream();
    response.setContentType("application/x-download");
    response.addHeader("Content-Disposition", "attachment; filename=" + encode + ".pdf");
    response.setCharacterEncoding("UTF-8");
    outputStream.write(bos.toByteArray());
}

    同样地通过接口将pdf下载到本机，查看pdf

    打开pdf文件.png

文章标签：
Java
Spring
前端开发
数据采集
移动开发
关键词：
HTML Springboot
springboot HTML
HTML文档
PDF文档
Spring Boot模版
理想万岁万万岁
目录
相关文章
不爱讲大道理
|
1月前
HTML文档基础标签（2）
HTML文档基础标签（2）
不爱讲大道理
16 1
sunrr
|
8天前
|
移动开发 开发者 HTML5
html文档
【4月更文挑战第19天】html文档
sunrr
11 1
不爱讲大道理
|
1月前
|
移动开发 SEO HTML5
HTML文档基础标签（1）
HTML文档基础标签（1）
不爱讲大道理
14 1
龙腾九州
|
1月前
|
移动开发 HTML5
HTML5文档头部相关标记
【2月更文挑战第9天】HTML5文档头部相关标记。
龙腾九州
13 1
java开发-郭老师
|
18天前
|
Java Linux
Springboot 解决linux服务器下获取不到项目Resources下资源
Springboot 解决linux服务器下获取不到项目Resources下资源
java开发-郭老师
36 0
风水道人
|
26天前
|
Java API Spring
SpringBoot项目调用HTTP接口5种方式你了解多少？
SpringBoot项目调用HTTP接口5种方式你了解多少？
风水道人
80 2
风水道人
|
26天前
|
前端开发 JavaScript Java
6个SpringBoot 项目拿来就可以学习项目经验接私活
6个SpringBoot 项目拿来就可以学习项目经验接私活
风水道人
34 0
zhishijike
|
1月前
|
前端开发 Java 关系型数据库
SpringBoot+MyBatis 天猫商城项目
SpringBoot+MyBatis 天猫商城项目
zhishijike
57 1
hhzz
|
1月前
|
JSON JavaScript 前端开发
解决js中Long类型数据在请求与响应过程精度丢失问题（springboot项目中）
解决js中Long类型数据在请求与响应过程精度丢失问题（springboot项目中）
hhzz
42 0
风水道人
|
29天前
|
Java Maven 微服务
springboot项目开启远程调试-jar包
springboot项目开启远程调试-jar包
风水道人
20 0

热门文章

最新文章

  • 1
    组态软件之万维组态介绍（web组态、html组态、vue2/vue3组态）
  • 2
    HTML深度解析：更改文本颜色
  • 3
    uni-app使用v-html输出富文本图片溢出解决
  • 4
    【前端设计】HTML+CSS+JavaScript基本特性
  • 5
    有关Java发送邮件信息（支持附件、html文件模板发送）
  • 6
    黑色个人主页HTML源码
  • 7
    《HTML 简易速速上手小册》第4章：HTML 的表单与输入（2024 最新版）
  • 8
    《HTML 简易速速上手小册》第5章：HTML 高级布局技巧（2024 最新版）
  • 9
    如何使用HTML5的语义化标签来提高网站的可访问性？
  • 10
    html的常用标签
  • 1
    使用pdf2docx轻松将PDF转换成docx
    47
  • 2
    Python实现从PDF和图片提取文字的方法总结
    54
  • 3
    使用Spire.PDF for Python插件从PDF文件提取文字和图片信息
    84
  • 4
    如何使用Python抓取PDF文件并自动下载到本地
    34
  • 5
    如何在 CRM Assignment block 里创建支持 Web Service 的 PDF 附件
    10
  • 6
    itext制作pdf表格
    23
  • 7
    Java【代码 16】将word、excel文件转换为pdf格式和将pdf文档转换为image格式工具类分享（Gitee源码）aspose转换中文乱码问题处理
    105
  • 8
    福利来袭，.NET Core开发5大案例，30w字PDF文档大放送！！！
    36
  • 9
    CVPR 2023 最全分割类论文整理：图像/全景/语义/实例分割等【附PDF+代码】
    120
  • 10
    分享一个word转pdf的工具类Aspose[java]
    47

    • 相关课程

    更多
  • SpringBoot快速掌握 - 核心技术
  • HTML 入门与实战
  • HTML基础入门学习
  • HTML5 新特性教程
  • 零基础学前端HTML+CSS
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • 企业数字化基石——阿里巴巴云计算基础设施实践-试读
  • 天猫 HTML5 互动技术实践
  • 天猫HTML5互动技术实践

    • 相关实验场景

    更多
  • Html5和Webpack3：Webpack5的常见用法
  • Html5和Webpack2：Webpack5打包JS和样式表
  • Html5和Webpack1：Webpack5打包工具介绍
    • 下一篇
    部署LAMP环境（Alibaba Cloud Linux 3）