Spring Boot+Thymeleaf生成PDF文档的实用指南

后端

2023-08-08 12:51:15

使用Spring Boot和Thymeleaf轻松生成PDF文档

准备工作

Java开发环境（JDK） ：安装Java开发环境（JDK）以提供编译和运行Java代码的必要工具。

Maven构建工具 ：安装Maven构建工具以自动化项目构建、依赖管理和部署过程。

Spring Boot ：Spring Boot是一个功能强大的Java开发框架，简化了基于Spring的应用程序的开发和配置。

Thymeleaf ：Thymeleaf是一个功能丰富的Java模板引擎，用于创建动态和可复用的HTML内容。

iText7 PDF库 ：iText7是用于创建、操作和维护PDF文档的开源Java库。

创建Spring Boot项目

使用Spring Initializr创建Spring Boot项目骨架。这将创建一个包含所需依赖项和配置的项目结构。

添加Thymeleaf依赖项

在项目中添加Thymeleaf依赖项，使其能够将HTML模板转换为动态内容。

创建PDF生成Controller

创建一个Controller类来处理PDF生成请求，该类将定义用于生成和下载PDF文档的端点。

创建PDF生成Service

在Service层实现PDF生成逻辑，该逻辑将获取数据、创建HTML内容并将其转换为PDF文档。

创建Thymeleaf模板

创建一个Thymeleaf模板以定义PDF文档的HTML结构和内容。

运行项目并测试

运行Spring Boot项目并访问定义的端点以触发PDF生成。生成的PDF文档将被下载并保存在本地计算机上。

代码示例

// Controller
@GetMapping("/generate-pdf")
public void generatePdf(HttpServletResponse response) {
    pdfService.generatePdf(response);
}

// Service
public void generatePdf(HttpServletResponse response) {
    // 获取数据并创建HTML内容
    String html = thymeleafTemplateEngine.process("pdf-template", data);

    // 转换为PDF并设置响应头
    PdfDocument pdf = iText7.html2pdf(html, response.getOutputStream());
    response.setContentType("application/pdf");
    response.setHeader("Content-Disposition", "inline; filename=document.pdf");

    // 关闭PDF文档
    pdf.close();
}

// Thymeleaf模板
<!DOCTYPE html>
<html>
<body>
    <h1>Employees</h1>
    <ul>
        <li th:each="employee : ${employees}">
            <span th:text="${employee.name}"></span>
            <span th:text="${employee.email}"></span>
        </li>
    </ul>
</body>
</html>