Java將數(shù)據(jù)寫入到PDF文件的操作步驟

更新時間：2025年10月27日 09:27:56 作者：何中應(yīng)

本文介紹了如何在Java中將數(shù)據(jù)寫入到PDF文件中,包括安裝PDF生成工具、創(chuàng)建Maven項(xiàng)目、配置文件、創(chuàng)建模板、編寫代碼和啟動測試,文中通過代碼示例和圖文給大家介紹的非常詳細(xì),需要的朋友可以參考下

安裝應(yīng)用

在寫代碼前，先安裝一個生成PDF的工具，是開源的，在 Github 上，地址：

https://github.com/wkhtmltopdf/wkhtmltopdf/releases

我在 windows 系統(tǒng)上演示，就下載下面這個版本，后面部署測試/線上環(huán)境也可以下對應(yīng)的版本，在服務(wù)器上部署。

在這里插入圖片描述

下載下來后，如下，是一個可執(zhí)行程序

在這里插入圖片描述

雙擊安裝

在這里插入圖片描述

安裝到系統(tǒng)上一個沒有中文，沒有空格的路徑下

在這里插入圖片描述

Demo

寫一個 demo，創(chuàng)建一個 Maven 項(xiàng)目

第一步：引入依賴

引入相關(guān)依賴，繼承 Spring boot，pom.xml 如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.12</version>
        <relativePath/>
    </parent>

    <groupId>com.hezy</groupId>
    <artifactId>pdf_demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!-- web依賴，用調(diào)用接口的方式來測試 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- 生成pdf依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>com.github.jhonnymertz</groupId>
            <artifactId>java-wkhtmltopdf-wrapper</artifactId>
            <version>1.3.1-RELEASE</version>
        </dependency>

        <!-- lombok依賴 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <!-- 編譯插件，定義編譯語言，后面用于構(gòu)建PDF文件byte[]，返回給前端 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>17</source>
                    <target>17</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

需要注意的是，spring-boot-starter-thymeleaf 不要指定版本，不然會報(bào)啟動錯誤，詳細(xì)看下面：

啟動項(xiàng)目，報(bào)下面這個異常

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
2025-10-23 22:28:23.811 ERROR 11536 --- [           main] o.s.b.d.LoggingFailureAnalysisReporter   : 

***************************
APPLICATION FAILED TO START
***************************

Description:

A component required a bean of type 'org.thymeleaf.TemplateEngine' that could not be found.


Action:

Consider defining a bean of type 'org.thymeleaf.TemplateEngine' in your configuration.

as follows：

解決

thymeleaf 版本與 Spring Boot 版本不匹配

不要指定thymeleaf 版本，讓它用 Spring Boot 指定的

通過下面的步驟，可以查看 Spring Boot 管理的依賴版本

第二步：配置文件

添加相關(guān)配置到 application.yml 中，如下：

spring:
  thymeleaf:
    prefix: classpath:/template/
    suffix: .html
    mode: HTML
    cache: false  # 關(guān)閉緩存
  wkhtmltopdf:
    exec: D:\dev\wkhtmltopdf\bin\wkhtmltopdf.exe

這里面定義了后面 PDF 填充的模板（靜態(tài)資源）的路徑，和前面下載的 PDF 轉(zhuǎn)換工具在系統(tǒng)中的安裝路徑。

第三步：創(chuàng)建模板

創(chuàng)建一個 PDF 填充模板，內(nèi)容如下，填充數(shù)據(jù)用 ${對象名.屬性名} 占位，語法應(yīng)該和 FreeMaker 差不多

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>${data.title}</title>
</head>
<body>
<div>姓名：</div> <div th:text="${data.name}"></div>
<div>年齡：</div> <div th:text="${data.age}"></div>
<div>性別：</div> <div th:text="${data.sex}"></div>
</body>
</html>

頁面打開如下：

在這里插入圖片描述

注意一下模板所在位置，需要和前面配置文件中指定的保持一致

在這里插入圖片描述

第四步：寫代碼

寫一個接口，接口做兩件事，1）組裝 PDF 中所需要的數(shù)據(jù)；2）合成 PDF 文件，返回前端

（Controller）

import com.hezy.service.PDFService;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;

@RestController
public class PDFController {

    @Resource
    private PDFService pdfService;

    @PostMapping("/pdf")
    public byte[] pdf() {
        // 構(gòu)建響應(yīng)頭
        String fileName = "example.pdf";
        String encodedFileName = URLEncoder.encode(fileName, StandardCharsets.UTF_8);
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
        headers.setContentDispositionFormData("attachment", encodedFileName);

        // 返回
        return ResponseEntity.ok()
                .headers(headers)
                .body(pdfService.pdf()).getBody();
    }
}

（Service 實(shí)現(xiàn)類）

import com.github.jhonnymertz.wkhtmltopdf.wrapper.Pdf;
import com.github.jhonnymertz.wkhtmltopdf.wrapper.configurations.WrapperConfig;
import com.github.jhonnymertz.wkhtmltopdf.wrapper.objects.SourceType;
import com.github.jhonnymertz.wkhtmltopdf.wrapper.params.Param;
import com.hezy.pojo.PDFDTO;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;

import javax.annotation.Resource;

@Service
public class PDFServiceImpl implements PDFService {

    @Value("${spring.wkhtmltopdf.exec:}")
    private String wkhtmltopdfPath;

    @Resource
    private TemplateEngine templateEngine;

    @Override
    public byte[] pdf() {
        try {
            // 1.創(chuàng)建上下文
            Context context = new Context();
            WrapperConfig config = new WrapperConfig(wkhtmltopdfPath);

            // 2.創(chuàng)建PDF生成器
            Pdf pdf = new Pdf(config);

            // 3.填充數(shù)據(jù)
            PDFDTO pdfdto = new PDFDTO("Hello World", "張三", "男", "18");
            context.setVariable("data", pdfdto);

            // 4.指定模板，這里只需指定名稱，模板所在路徑、模板后綴名都在配置文件中設(shè)置過了
            String htmlContent = templateEngine.process("template", context);
            pdf.addPage(htmlContent, SourceType.htmlAsString);

            // 5.配置 PDF 文件的通用參數(shù)
            pdf.addParam(new Param("--page-size", "A4"),
                    new Param("--margin-top", "15mm"),
                    new Param("--margin-bottom", "15mm"),
                    new Param("--margin-left", "15mm"),
                    new Param("--margin-right", "15mm"),
                    new Param("--enable-local-file-access"),
                    new Param("--disable-smart-shrinking"),
                    new Param("--print-media-type"),
                    new Param("--encoding", "UTF-8"));
            
            // 6.生成PDF
            return pdf.getPDF();
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
}