【技术实战】Java实现导出为效果最好的PDF文件

原创 已于 2024-12-24 16:35:40 修改 · 1.5k 阅读 ·
大模型引用 6 次
·
本内容遵循CC 4.0 BY-SA版权协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
GEO检测
cknow-ai 小飞快飞

cknow-ai 关注

标签
#java #pdf #开发语言
分类 后端开发
于 2024-12-24 16:21:02 首次发布

前言

生成 PDF 文件的方法有很多，都会有几个卡点，就是样式和字体的问题，这里直接推荐 PlayWright 可以将网页转化为 pdf 文件，效果和网页效果一样，美得很
先给出 playwright 官网，https://playwright.dev/docs/intro ，依靠 Nodejs 环境，通过模拟浏览器操作并输出为 pdf文件；官网申明了运行的环境参数，所以出现的各种问题，先从这些条件上找找问题

Node.js 18+
Windows 10+, Windows Server 2016+ or Windows Subsystem for Linux (WSL).
macOS 13 Ventura, or later.
Debian 12, Ubuntu 22.04, Ubuntu 24.04, on x86-64 and arm64 architecture.

开整

首先声明这是一个Java 项目，所以会用到maven，现引入依赖

 <dependency>
            <groupId>com.microsoft.playwright</groupId>
     <artifactId>playwright</artifactId>
      <version>1.43.0</version> 
</dependency>

新建一个 pdf的工具类，其他地方使用直接调用；PdfUtil.java

import com.microsoft.playwright.*;
import com.microsoft.playwright.options.LoadState;
import com.microsoft.playwright.options.Margin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StringUtils;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Paths;

/**
 * pdf 工具
 * @author xiaofei
 * @date 2024/12/17 17:00
 */
@Slf4j
public class PdfUtil {

     /**
     * 将网页生成 pdf
     * @auth xiaofei
     * @date 2024/12/20 11:39
     */
    public static String generateHtmlToPdf(String url, String fileName,OutputStream outputStream) {
        log.info("开始生成网页的 pdf 文件，url={}",url);
        try (Playwright playwright = Playwright.create()) {
            Browser browser = playwright.chromium().launch(new BrowserType.LaunchOptions().setHeadless(true));
            BrowserContext context = browser.newContext();
            //new Browser.NewContextOptions()
            //                    .setViewportSize(375, 667) // 设置模拟 iPhone 6/7/8 的视口
            //                    .setUserAgent("Mozilla/5.0 (iPhone; CPU iPhone OS 11_0 like Mac OS X) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0 Mobile/15A372 Safari/604.1")
            Page page = context.newPage();
            page.navigate(url);
            // 修改根节点 <html> 的 font-size，设置为 16px（这是 1rem 对应的大小）
            page.evaluate("document.documentElement.style.fontSize = '25px';");
            //等待加载完成后
            page.waitForLoadState(LoadState.NETWORKIDLE);
            // 等待字体加载（如果页面依赖于 Web 字体）
            page.evaluate("document.fonts.ready.then(() => { window.isFontLoaded = true; });");
            page.waitForFunction("window.isFontLoaded === true");
            //手动等待 10秒
            page.waitForTimeout(10000);
            // 设置视口大小
            //page.setViewportSize(1920, 1080); // 设置视口大小为 1920x1080
            // 临时文件路径
            if (StringUtils.isEmpty(fileName)){
                fileName = "webPage.pdf";
            }
            fileName = "/data/logs/manage/"+fileName;
            //fileName =" /Users/macbook/Project/logs/manage/"+fileName;
            File tempFile = new File(fileName);
            if (tempFile == null || !tempFile.exists()){
                //tempFile.createNewFile();
            }
            // 输出为 PDF
            page.pdf(new Page.PdfOptions()
                    .setPath(Paths.get(tempFile.getAbsolutePath()))  // 设置输出 PDF 的路径
                    .setFormat("A4")  // 设置纸张格式
                    .setPrintBackground(true)  // 确保背景和图像被打印
                    //.setMargin(new Margin().setTop("10px").setBottom("10px").setLeft("10px").setRight("10px"))  // 设置边距
            );
            //输出到流
            if (outputStream != null){
                try {
                    byte[] pdfData = Files.readAllBytes(tempFile.toPath());
                    outputStream.write(pdfData);
                } catch (IOException e) {
                    throw new RuntimeException(e);
                }
            }

            // 删除临时文件
            //tempFile.delete();

            // 获取网页加载后的 HTML
            //content = page.content();
            browser.close();
        }
        log.info("完成生成网页的 pdf 文件");
        return fileName;
    }

    public static void main(String[] args) {
        System.out.println("Screenshot begin!");
        String url = "https://baidu.com";
        String outputPath = "baidu.pdf";
        PdfUtil.generateHtmlToPdf(url, outputPath,null);
    }

提供一个 controller 类对外使用 ：PdfToolController.java

import util.PdfUtil;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.web.bind.annotation.*;

import java.io.IOException;
import java.util.Map;

/**
 * pdf 工具
 * @author xiaofei
 * @date 2024/12/20 14:37
 */
@RestController
@RequestMapping("/webapi/pdfTool")
public class PdfToolController {

    /**
     * 获取 网页pdf
     */
    @GetMapping("/getHtmlToPdf")
    public void htmlToPdf(HttpServletResponse response, String url, String fileName) throws IOException {

        PdfUtil.generateHtmlToPdf(url, fileName,response.getOutputStream());
    }

     /**
     * 获取 网页pdf
     */
    @PostMapping("/postHtmlToPdf")
    public void postHtmlToPdf(HttpServletResponse response,@RequestBody Map<String,Object> params) throws IOException {
        String url = (String) params.get("url");
        String fileName = (String) params.get("fileName");
        PdfUtil.generateHtmlToPdf(url, fileName,response.getOutputStream());
    }
}

重点来了，就是部署问题；需要有 nodejs环境，可以手动安装；playwright需要的浏览器驱动等内容会在服务第一次使用时自动下载，可以不用管

# 安装 nvm (Node 版本管理器)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
# 下载并安装 Node.js（可能需要重启终端）
nvm install 22  # docker容器内支持的最低版本
# 验证环境中是否存在正确的 Node.js 版本
node -v  # 应该打印 `v22.12.0`
# 验证环境中是否存在正确的 npm 版本
npm -v  # 应该打印 `10.9.0`

如果是docker环境，我这里提供一个 dockerfile，特别说明需要高版本的 JDK，不然有一些坑，可以自己测试下试试，我之前用过 jdk8，总是出现一些问题，估计是操作系统版本的问题，所以我改用 jdk17

# 选 择 一 个 包 含  JDK 的 基 础 镜 像 ， 这 里 选 择 的 是  openjdk:17-jdk-slim
FROM openjdk:17-jdk-slim


# 设 置 工 作 目 录
WORKDIR /app

# -------------------
# 安 装  Node.js 部 分
# -------------------

# 1. 安 装  curl
RUN apt-get update && apt-get install -y curl

# 2. 下 载  Node.js 安 装 脚 本  (这 里 下 载 的 是  LTS 版 本 )
RUN curl -fsSL https://deb.nodesource.com/setup_lts.x | bash -

# 3. 安 装  Node.js 和  npm
RUN apt-get install -y nodejs

# 4. （ 可 选 ） 验 证  Node.js 和  npm 安 装
RUN node -v
RUN npm -v

# 安 装  Playwright 依 赖 以 及 系 统 依 赖
#RUN apt-get install playwright chromium
RUN apt-get install -y libglib2.0-0 libnss3 libnspr4 libdbus-1-3 libatk1.0-0 libatk-bridge2.0-0 libcups2 libdrm2  libatspi2.0-0 libx11-6 libxcomposite1 libxrandr2 \
     libxrender1 libxtst6 ca-certificates fonts-noto-cjk  libxdamage1 libxfixes3 libgbm1 libxkbcommon0 libpango-1.0-0 libcairo2 libasound2 \
      libx11-xcb1  libxcursor1  libgtk-3-0 libpangocairo-1.0-0 libcairo-gobject2  libgdk-pixbuf-2.0-0

ENV LANG C.UTF-8
RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
RUN echo "Asia/Shanghai" > /etc/timezone

COPY *.jar app.jar
CMD ["java", "-jar", "app.jar"]

如果是通过 docker-compose 构建的 docker镜像，提供一个 docker-compose.yml

pdftool:
    image: pdftool
    container_name: tool
    ports:
        - "8181:8181"
    volumes:
        - /data/logs/tool:/data/logs/tool

所以整个构建过程是如下，如果是 Jenkins 方式，只需要配置一个任务就是了，这里提供一个手动构建的过程

1、停止服务
docker stop tool
2、创建镜像
 docker build -t pdftool .
3、 运行应用
docker-compose -f docker-compose.yml up -d 

4、执行操作
curl http://localhost:8181/webapi/pdftool/getHtmlToPdf?url=https://baidu.cn&fileName=test.pdf 

5、查看日志
docker logs tool 

6、进入容器
docker exec -u root -it tool bash

可以在浏览器中执行，或者通过 Apifox 中操作；这里推荐用 post请求，因为网页链接中还有参数等，如果 get请求就会有问题

http://localhost:8181/webapi/pdftool/getHtmlToPdf?url=https://baidu.cn&fileName=test.pdf

如果将这个功能作为一个服务，其他应用调用，可以这么实现；可以同时输出到文件和输出流中


import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import okhttp3.OkHttpClient;
import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import org.apache.commons.io.FileUtils;

import java.io.*;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;
/**
 * pdf 工具
 * @author xiaofei
 * @date 2024/12/17 17:00
 */
public class PdfUtil {
 /**
  * 将网页生成 pdf
  * @auth xiaofei
  * @date 2024/12/20 11:39
  */
public static void generateUrlToPdf(String url, String fileName,OutputStream outputStream){
        //调用第三方服务转化
        Map<String, Object> params = new HashMap<>();
        params.put("url", url);
        params.put("fileName", fileName);
 
        OkHttpClient client = new OkHttpClient().newBuilder()
                .connectTimeout(10, TimeUnit.SECONDS)  // 设置连接超时时间为10秒
                .readTimeout(30, TimeUnit.SECONDS)     // 设置读取超时时间为30秒
                .writeTimeout(15, TimeUnit.SECONDS)    // 设置写入超时时间为15秒
                .build();
        okhttp3.MediaType mediaType = okhttp3.MediaType.parse("application/json");
        RequestBody body = RequestBody.create(mediaType, JSONObject.toJSONString(params));

        okhttp3.Request request = new okhttp3.Request.Builder()
                .url("https://localhost:8181/webapi/pdfTool/postHtmlToPdf")
                .method("POST", body)
                .addHeader("Content-Type", "application/json")
                .addHeader("Accept", "*/*")
                .addHeader("Connection", "keep-alive")
                .build();
        try (okhttp3.Response response = client.newCall(request).execute()) {
            if (!response.isSuccessful()) {
                throw new IOException("Unexpected code " + response);
            }
            ResponseBody responseBody = response.body();
            if (responseBody != null && outputStream != null) {
                try (InputStream inputStream = responseBody.byteStream()) {
                    ByteArrayOutputStream baos = new ByteArrayOutputStream();
                    byte[] buffer = new byte[1024];
                    int bytesRead;
                    while ((bytesRead = inputStream.read(buffer)) != -1) {
                        baos.write(buffer, 0, bytesRead);
                    }             
                    // 将内容写入到文件
                    try (FileOutputStream fos = new FileOutputStream(fileName)) {
                        fos.write(baos.toByteArray());
                    }
                    // 将内容写入到输出流
                    baos.writeTo(outputStream);
                }
            }
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    public static void main(String[] args) throws IOException {
        System.out.println("Screenshot begin!");
        String url = "http://baidu.com";
        String outputPath = "baidu.pdf";
        PdfUtil.generateUrlToPdf(url, outputPath,null);
    }

结尾

至此整个功能就完成了，最大的问题就是环境问题导致 playwright没有正常安装，导致功能无法跑通；多试多折腾，总会找到办法，如果你在使用中也遇到一些问题仍然无法解决，就在评论区标注下，大家一起想办法

点赞 点赞 4
评论 0
书签 书签 4
Java操作pdf的工具类itext
学Java，找哪吒
04-18 1万+
在企业的信息系统中，报表处理一直占比较重要的作用，iText是一种生成PDF报表的Java组件。通过在服务器端使用Jsp或JavaBean生成PDF报表，客户端采用超链接显示或下载得到生成的报表，这样就很好的解决了B/S系统的报表处理问题。
【Java】Java生成PDF工具类
wjianwei666的专栏
09-21 1859
Java生成PDF工具类是一个非常实用的工具类，可以帮助我们以程序化的方式生成PDF文件。通过该工具类，我们可以向PDF文件中添加文字、图片、表格等多种内容，并且可以进行格式化和样式设置。Java生成PDF工具类常用于生成报表、发票、合同等文档。
Java 利用iText生成pdf并导出
musa875643dn的专栏
05-01 3040
前言   项目中需要导出pdf文档，以前没有做过这块儿的功能，于是上网搜索了一下，目前有好几个构件支持该项功能，结合项目要求，很快就确定使用iText来实现。   那么接下来怎么着手呢，我第一反应是上官网查看官方提供的api和demo，通常官方的例子都很简炼并且不会有复杂的上下文，很容易上手。   官网http://developers.itextpdf.com/examples 上有很多实
Java 生成各种 PDF 实战方案（图片、模板、表格）
竹林幽深
03-29 4217
本篇文章的重点还是在讲通过java生成pdf，其实如果是单纯的模板填充挺简单的，但是又要填充模板还要动态生成表格就比较麻烦了，因为如果在模板中画表格的框去生成的话，超过模板框的位置就会隐藏，我刚接到需求的时候也是有点难受，在网上也是找了大量的资料，研究了半天，发现好多都是你粘贴我，我粘贴你，最终我也算是搞成了，把这些整合一下，让大家用的好用一些，废话不多说，直接上代码！可以看到，我们在代码中并没有新开一页，只是加了一个间隙，就可以保证动态生成的表格和模板在一个页面，就此，基本上就算完成了。
Java实现pdf导出
最新发布
qq_62851576的博客
04-09 510
本文介绍了使用FreeMarker模板引擎和OpenHTMLtoPDF工具实现Java动态PDF导出的完整方案。核心流程包括：通过FreeMarker渲染HTML模板，使用OpenHTMLtoPDF将HTML转为PDF，并支持批量文件打包为ZIP下载。重点解决了表格截断、中文乱码等常见问题，提供了CSS优化方案和代码实现示例。该方案适用于企业级报表生成场景，具有模板与数据分离、易于维护的特点，能够显著降低PDF开发门槛。
Java中的PDF生成
weixin_46372265的博客
07-18 4156
在这个数字化时代，PDF文件已成为传递信息的重要方式。无论是合同、报告，还是技术文档，PDF都因其跨平台兼容性和固定格式而备受青睐。那么，你是否想过如何使用Java生成PDF呢？今天，我们将深入探讨Java中的PDF生成技术，让你轻松掌握这一技能，成为职场中的技术达人。在深入讨论技术细节之前，我们先来简单了解一下PDF。PDF，全称为Portable Document Format，是由Adobe公司在1993年推出的一种文件格式。
【教程】如何使用Java生成PDF文档？
Dark_orange的博客
03-02 1万+
PDF文档的生成通常包括两个步骤，首先需要使用Java代码创建一个PDF文档对象，然后向文档中添加内容。要生成PDF文档，我们可以使用多种Java开源库，如iText、Apache PDFBox和Flying Saucer等。在本教程中，我们将使用iText库来生成PDF文档。iText是一个流行的开源Java库，它提供了创建PDF文档所需的所有功能。本教程介绍了如何使用Java和iText库生成PDF文档。我们首先介绍了如何创建文档对象，然后向其中添加文本、图片和表格等内容。
java生成PDF（图片，模板，表格）
qq_45699784的博客
11-10 3万+
java生成pdf（单模板、多模板+图片+表格，包括页头/页脚及水印）
PDF技术（一）-Java实现Office系列文件转PDF文件
晋文子上的博客
10-10 1万+
最近，公司要求做个文件转pdf的调研报告，于是在网上找了一些实现方法，现在将这些方法做个对比，并记录下来，以后或许有用呢，哈哈。 首先说一下需求，产品要求不能使用第三方软件实现，因为这种实现方式效率不高，所以需要使用“纯Java代码”实现。同时也对跨平台有要求，系统需要运行在linux系统上。综合现阶段发现的方案，决定采用基于Aspose的方式进行实现。 好了，现在先看一下对比的结果： 各实...
Java如何实现Pdf的导出？
执笔画红颜丶的博客
07-14 3万+
Java如何实现Pdf的导出？ 在某些场景中，我们需要从数据库或其他来源获取的数据信息，动态的导出Pdf文件，如准考证的打印等。这时我们需要借助第三方依赖包—itextpdf 来实现此需求。 一、制作PDF模板 1、在Word内制作模板 因为PDF常用的软件不支持编辑，所以先用Word工具，如WPS或者Office新建一个空白Word文档，里面制作出自己想要的样式。 2、将Word转换成PDF形式 将设置好的Word文档转换成PDF形式，保存起来。 3、编辑PDF准备表单 用Adobe A
PDF技术（四）-Java实现Html转PDF文件
热门推荐
晋文子上的博客
10-10 4万+
html转换为pdf的关键技术是如何处理网页中复杂的css样式、以及中文乱码处理。 各实现对比表 于Windows平台进行测试：   基于IText 基于FlyingSaucer 基于WKHtmlToPdf 基于pd4ml 跨平台性 跨平台 ...
java导出pdf（纯代码实现）
weixin_51114236的博客
07-14 2万+
在项目开发中，产品的需求越来越奇葩啦，开始文件下载都是下载为excel的，做着做着需求竟然变了，要求能导出pdf。导出pdf倒也不是特别大的问题关键就是麻烦。方法二：利用HTML页面导出，奈何自己不会写HTML，前端忙没时间帮忙写。本着求人不如靠己的想法就选择了第三种比较麻烦的方法，自己用table画。方法一：利用模板导出，但是首先编辑模板的工具不好找，现有的国外的工具要收费，所以放弃了这个。方法三：自己用纯代码画格式（可调字体大小，颜色，对复杂没有规则的数据都可以）然后就可以了直接导出pdf。
java实现生成PDF文件
xhga
10-24 2万+
1.PDF文件简介 PDF是可移植文档格式，是一种电子文件格式，具有许多其他电子文档格式无法相比的优点。PDF文件格式可以将文字、字型、格式、颜色及独立于设备和分辨率的图形图像等封装在一个文件中。该格式文件还可以包含超文本链接、声音和动态影像等电子信息，支持特长文件，集成度和安全可靠性都较高。在系统开发中通常用来生成比较正式的报告或者合同类的电子文档。 2.生成P
Java使用pdf模板生成pdf文件
不积跬步，无以至千里
06-25 2万+
有时候，业务中我们需要使用pdf模板生成一份pdf文件。如何生成pdf文件？如下，我们把左侧的模板生成为右侧的填充文件。
java生成pdf
weixin_35748962的博客
12-30 2583
要在 Java 中生成 PDF 文件，可以使用一些第三方库，例如 iText、Apache PDFBox 或者 JasperReports。 iText 是一个开源的 PDF 库，可以用来生成、编辑和阅读 PDF 文件。使用 iText 生成 PDF 的基本流程如下： 创建一个 Document 对象。 使用 Document 对象的 add() 方法向 PDF 中添加文本、图像和其他内容。 创...
JAVA生成PDF（itextpdf）
NCHUtianlin的博客
07-13 2847
生成PDF
JAVA实现纯代码导出PDF文件
weixin_45620445的博客
11-07 3584
突发奇想，发布一篇生成pdf的博客。最初做导出pdf文件还是刚接触项目的时候，从最边缘的功能开始..........想要实现导出PDF文件，但是当时已经生成了对应的Word文件，就想着直接把Word文件转为PDF就好了，还方便格式什么的都实现了，最后花了很大力气是实现了，但是效果不尽人意，就想着要不然直接生成PDF得了，后续就是看了一些博客，仿照着实现了导出PDF文件，但是自己最终实现效果有一点小瑕疵，一直没有空去有哈一下，最近有点空闲时间查了一下资料，把这个小瑕疵修复掉了。
Java 在线生成 PDF 文件
weixin_46619605的博客
02-17 2021
Java 在线生成 PDF 文件
Java生成PDF文件
weixin_34249367的博客
01-06 1484
一、前言 　　最近在做也导出试卷的功能，刚开始是导出为doc，可是导出来格式都有变化，最后说直接将word转为pdf，可是各种不稳定，各种报错、最后想到直接将文件写入pdf(参考:http://www.cnblogs.com/qlqwjy/p/8193281.html)。经一番查找，选定iText--用于生成PDF文档的一个Java类库。   二、iText简介 　　iText是著名的开放...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值