Java将数据写入到PDF文件的操作步骤
更新时间：2025年10月27日 09:27:56 作者：何中应
本文介绍了如何在Java中将数据写入到PDF文件中,包括安装PDF生成工具、创建Maven项目、配置文件、创建模板、编写代码和启动测试,文中通过代码示例和图文给大家介绍的非常详细,需要的朋友可以参考下
说明：业务中有时会有将系统数据写入到PDF文件中，生成一份报告文件的场景，本文介绍如何实现。
安装应用
在写代码前，先安装一个生成PDF的工具，是开源的，在 Github 上，地址：
https://github.com/wkhtmltopdf/wkhtmltopdf/releases
我在 windows 系统上演示，就下载下面这个版本，后面部署测试/线上环境也可以下对应的版本，在服务器上部署。
下载下来后，如下，是一个可执行程序
双击安装
安装到系统上一个没有中文，没有空格的路径下
Demo
写一个 demo，创建一个 Maven 项目
第一步：引入依赖
引入相关依赖，继承 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依赖，用调用接口的方式来测试 -->
<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>
<!-- 编译插件，定义编译语言，后面用于构建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 不要指定版本，不然会报启动错误，详细看下面：
启动项目，报下面这个异常
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 管理的依赖版本
第二步：配置文件
添加相关配置到 application.yml 中，如下：
spring:
thymeleaf:
prefix: classpath:/template/
suffix: .html
mode: HTML
cache: false # 关闭缓存
wkhtmltopdf:
exec: D:\dev\wkhtmltopdf\bin\wkhtmltopdf.exe
这里面定义了后面 PDF 填充的模板（静态资源）的路径，和前面下载的 PDF 转换工具在系统中的安装路径。
第三步：创建模板
创建一个 PDF 填充模板，内容如下，填充数据用 ${对象名.属性名} 占位，语法应该和 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 中所需要的数据；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() {
// 构建响应头
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 实现类）
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.创建上下文
Context context = new Context();
WrapperConfig config = new WrapperConfig(wkhtmltopdfPath);
// 2.创建PDF生成器
Pdf pdf = new Pdf(config);
// 3.填充数据
PDFDTO pdfdto = new PDFDTO("Hello World", "张三", "男", "18");
context.setVariable("data", pdfdto);
// 4.指定模板，这里只需指定名称，模板所在路径、模板后缀名都在配置文件中设置过了
String htmlContent = templateEngine.process("template", context);
pdf.addPage(htmlContent, SourceType.htmlAsString);
// 5.配置 PDF 文件的通用参数
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);
}
}
}
第五步：启动测试
启动项目，调用接口，返回字节数组
保存为 PDF 文件，打开如下，数据内容已填充到 PDF 文件里
OKKK，现在就是进一步完成细节，一边根据业务需求，完善 PDF 的内容、结构和样式，修改/增加模板文件，一边在后端代码里完善获取数据的逻辑。
总结
本文介绍了在 Java 中如何将数据写入到 PDF 文件中。
以上就是Java将数据写入到PDF文件的操作步骤的详细内容，更多关于Java数据写入PDF的资料请关注脚本之家其它相关文章！
相关文章
SpringBoot+Prometheus+Grafana实现应用监控和报警的详细步骤
这篇文章主要介绍了SpringBoot+Prometheus+Grafana实现应用监控和报警的详细步骤,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-02-02
这篇文章主要为大家介绍了java编程数据类型全面详解教程，强烈推荐新手入，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步2021-10-10
这篇文章主要为大家介绍了SpringMVC RESTFul实体类创建及环境搭建详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-05-05
这篇文章主要介绍了java 获取对象中为null的字段实例代码,非常不错，具有一定的参考借鉴价值，需要的朋友可以参考下2019-04-04
本文介绍了在Java中将数组转换为列表的两种常见方法使用Arrays.asList和Java8的Stream API,Arrays.asList方法简单易用,但返回的列表是固定大小的；而使用Stream API可以实现更灵活的操作,如过滤和映射,根据具体需求选择合适的方法,感兴趣的朋友一起看看吧2025-03-03
这篇文章主要为大家介绍了Java程序中Doc文档注释的示例教程，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步2021-10-10
在java中可以进行多线程编程，在java标准库中提供了一个Thread类，来表示线程操作，本文主要介绍了Java中Thread类的使用和它的属性，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-04-04
本文主要介绍了springboot 整合 clickhouse的实现示例，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-02-02
这是一个使用了java+JSP+Springboot+maven+mysql+ThymeLeaf+FTP开发的在线蛋糕销售商城，是一个毕业设计的实战练习，具有线上蛋糕商城该有的所有功能，感兴趣的朋友快来看看吧2022-01-01
在开发中,我们经常会遇到这样的需求,将Excel的数据导入数据库中,这篇文章主要来和大家讲讲Java如何使用双异步实现将Excel的数据导入数据库,感兴趣的可以了解下2024-01-01
最新评论