SpringBoot 将 HTML 导出为 PDF

已于 2024-08-22 09:46:30 修改
阅读量1.6k 收藏 4
点赞数
分类专栏： SpringBoot 文章标签： spring boot html pdf
于 2023-09-12 15:13:58 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/baihaibo1024/article/details/132831924
版权

1. 项目目录

2. pom.xml

<!-- html 转 pdf -->
<dependency>
	<groupId>com.itextpdf</groupId>
	<artifactId>html2pdf</artifactId>
	<version>3.0.2</version>
</dependency>
<!-- 中文字体支持 -->
<dependency>
	<groupId>com.itextpdf</groupId>
	<artifactId>font-asian</artifactId>
	<version>7.1.13</version>
</dependency>
<!-- 流处理 -->
<dependency>
	<groupId>commons-io</groupId>
	<artifactId>commons-io</artifactId>
	<version>2.11.0</version>
</dependency>
<!-- 读取 resource 目录下文件 -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
	<version>2.6.3</version>
</dependency>

3. 创建 Service

TestService

package com.cnbai.service;

import com.cnbai.utils.HtmlToPdfUtils;
import org.springframework.core.io.ClassPathResource;

import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * 根据 html 文件生成 pdf 文件
 */
public class TestService {

    /** html 文件路径 */
    private static final String HTML_PATH = "html/test.html";

    /** 项目所在路径 */
    private static final String PATH = System.getProperty("user.dir");


    /**
     * 测试
     */
    public static void main(String[] args) {
        try {
            String path = generatePdf(HTML_PATH);
            System.out.println("文件路径：" + path);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }


    /**
     * 生成 pdf 文件
     */
    private static String generatePdf(String path) throws Exception {
        String pdfDirPath = PATH + File.separator + "pdf" + File.separator;
        File file = new File(pdfDirPath);
        if (!file.exists()) {
            file.mkdirs();
        }
        String pdfPath = pdfDirPath + "测试.pdf";
        ClassPathResource classPathResource = new ClassPathResource(path);
        InputStream inputStream = classPathResource.getInputStream();
        OutputStream outputStream = new FileOutputStream(pdfPath);
        HtmlToPdfUtils.convertToPdf(inputStream, outputStream);
        return pdfPath;
    }
}

4. 创建工具类

HtmlToPdfUtils

package com.cnbai.utils;

import com.cnbai.pdf.HeaderMarkerEventHandler;
import com.cnbai.pdf.PageEventHandler;
import com.cnbai.pdf.WaterMarkEventHandler;
import com.itextpdf.html2pdf.ConverterProperties;
import com.itextpdf.html2pdf.HtmlConverter;
import com.itextpdf.io.font.PdfEncodings;
import com.itextpdf.io.source.ByteArrayOutputStream;
import com.itextpdf.kernel.events.PdfDocumentEvent;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.font.PdfFontFactory;
import com.itextpdf.kernel.geom.PageSize;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.layout.font.FontProvider;
import org.springframework.core.io.ClassPathResource;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * 使用 itext7 将 html 生成 pdf
 */
public class HtmlToPdfUtils {

    /**
     * 自定义水印
     */
    private static final String WATERMARK_TEXT = "cnbai";

    /**
     * 页眉显示
     */
    private static final String headerText = "hahaha";

    /**
     * 页眉logo
     */
    private static final String logoUrl = "http://localhost/logo.jpg";

    /**
     * 自定义字体路径，ttc后缀的字体需要添加 -> ,0
     */
    private static final String FONT_PATH = "/font/simsun.ttc";

    /**
     * html 转 pdf
     *
     * @param inputStream  输入流
     * @param outputStream 输出流
     */
    public static void convertToPdf(InputStream inputStream, OutputStream outputStream) throws IOException {
        PdfWriter pdfWriter = new PdfWriter(outputStream);
        PdfDocument pdfDocument = new PdfDocument(pdfWriter);

        // 设置为 A4 大小
        pdfDocument.setDefaultPageSize(PageSize.A4);

        // 添加中文字体支持
        ConverterProperties properties = new ConverterProperties();
        FontProvider fontProvider = new FontProvider();

        // 添加自定义字体, 例如宋体
        ClassPathResource classPathResource = new ClassPathResource(FONT_PATH);
        String fontPath = classPathResource.getPath() + ",0";
        PdfFont microsoft = PdfFontFactory.createFont(fontPath, PdfEncodings.IDENTITY_H, false);
        fontProvider.addFont(microsoft.getFontProgram(), PdfEncodings.IDENTITY_H);

        // 添加页眉
        pdfDocument.addEventHandler(PdfDocumentEvent.START_PAGE, new HeaderMarkerEventHandler(microsoft, headerText, logoUrl));

        // 添加水印
        pdfDocument.addEventHandler(PdfDocumentEvent.INSERT_PAGE, new WaterMarkEventHandler(WATERMARK_TEXT));

        // 添加页码
        pdfDocument.addEventHandler(PdfDocumentEvent.END_PAGE, new PageEventHandler(microsoft));

        properties.setFontProvider(fontProvider);

        // 读取 Html 文件流，查找出当中的 &nbsp; 或出现类似的符号空格字符
        inputStream = readInputStream(inputStream);
        if (inputStream != null) {
            // 生成 pdf 文档
            HtmlConverter.convertToPdf(inputStream, pdfDocument, properties);
            pdfWriter.close();
            pdfDocument.close();
        } else {
            System.out.println("转换失败！");
        }
    }


    /**
     * 读取 HTML 流文件，并查询当中的 &nbsp; 或类似符号，并将其替换为空格
     */
    private static InputStream readInputStream(InputStream inputStream) {
        try {
            // 1. 创建字节数组输出流，用来输出读取到的内容
            ByteArrayOutputStream baos = new ByteArrayOutputStream();

            // 2. 创建缓存大小，1KB
            byte[] buffer = new byte[1024];
            int len; // 每次读取到内容的长度

            // 3. 开始读取输入流中的内容
            while ((len = inputStream.read(buffer)) != -1) {
                baos.write(buffer, 0, len);
            }

            // 4. 把字节数组转换为字符串
            String content = baos.toString();

            // 5. 关闭输入流和输出流
            inputStream.close();
            baos.close();

            // 6. 判断 HTML 内容是否具有 HTML 的特殊字符标记
            Pattern compile = Pattern.compile("&[a-zA-Z]{1,10};", Pattern.CASE_INSENSITIVE);
            Matcher matcher = compile.matcher(content);
            String replaceAll = matcher.replaceAll("");

            // 7. 将字符串转化为输入流返回
            return getStringStream(replaceAll);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }


    /**
     * 将一个字符串转化为输入流
     */
    private static InputStream getStringStream(String sInputString) {
        if (sInputString != null && !sInputString.trim().isEmpty()) {
            try {
                return new ByteArrayInputStream(sInputString.getBytes());
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return null;
    }
}

5. 创建配置类

HeaderMarkerEventHandler

package com.cnbai.pdf;

import com.itextpdf.io.image.ImageDataFactory;
import com.itextpdf.kernel.events.Event;
import com.itextpdf.kernel.events.IEventHandler;
import com.itextpdf.kernel.events.PdfDocumentEvent;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.geom.Rectangle;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfPage;
import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
import com.itextpdf.layout.Canvas;
import com.itextpdf.layout.element.Image;
import com.itextpdf.layout.element.Paragraph;
import com.itextpdf.layout.property.TextAlignment;
import org.springframework.util.StringUtils;

import java.net.MalformedURLException;
import java.net.URL;

/**
 * 生成 pdf 页眉
 */
public class HeaderMarkerEventHandler implements IEventHandler {

    /**
     * pdf字体
     */
    private final PdfFont pdfFont;

    /**
     * 页眉显示
     */
    private final String title;

    /**
     * logo地址
     */
    private String logoUrl;

    public HeaderMarkerEventHandler(PdfFont pdfFont, String title) {
        this.pdfFont = pdfFont;
        this.title = title;
    }

    public HeaderMarkerEventHandler(PdfFont pdfFont, String title, String logoUrl) {
        this.pdfFont = pdfFont;
        this.title = title;
        this.logoUrl = logoUrl;
    }

    @Override
    public void handleEvent(Event event) {
        PdfDocumentEvent docEvent = (PdfDocumentEvent) event;
        PdfDocument pdf = docEvent.getDocument();
        PdfPage page = docEvent.getPage();
        Rectangle pageSize = page.getPageSize();
        PdfCanvas pdfCanvas = new PdfCanvas(page.getLastContentStream(), page.getResources(), pdf);
        Canvas canvas = new Canvas(pdfCanvas, pageSize);
        float x = pageSize.getRight() - 60;
        float y = pageSize.getTop() - 32;
        Paragraph p = new Paragraph(title)
                .setFontSize(9)
                .setFont(pdfFont);
        // 显示在顶部右侧位置
        canvas.showTextAligned(p, x, y, TextAlignment.RIGHT);
        
        if (!StringUtils.isEmpty(logoUrl)) {
            try {
                URL url = new URL(logoUrl);
                Image logo = new Image(ImageDataFactory.create(url));
                logo.scaleAbsolute(100, 20);
                logo.setMarginLeft(30);
                logo.setMarginTop(15);
                canvas.add(logo);
            } catch (MalformedURLException e) {
                System.out.println("logo 无法解析: " + logoUrl);
            }
        }
        canvas.close();
    }
}

PageEventHandler

package com.cnbai.pdf;

import com.itextpdf.kernel.events.Event;
import com.itextpdf.kernel.events.IEventHandler;
import com.itextpdf.kernel.events.PdfDocumentEvent;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.geom.Rectangle;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfPage;
import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
import com.itextpdf.layout.Canvas;
import com.itextpdf.layout.element.Paragraph;
import com.itextpdf.layout.property.TextAlignment;

/**
 * 生成 pdf 页码
 */
public class PageEventHandler implements IEventHandler {

    /**
     * pdf字体
     */
    private final PdfFont pdfFont;

    public PageEventHandler(PdfFont pdfFont) {
        this.pdfFont = pdfFont;
    }

    @Override
    public void handleEvent(Event event) {
        PdfDocumentEvent documentEvent = (PdfDocumentEvent) event;
        PdfDocument document = documentEvent.getDocument();
        PdfPage page = documentEvent.getPage();
        Rectangle pageSize = page.getPageSize();
        PdfCanvas pdfCanvas = new PdfCanvas(page.getLastContentStream(), page.getResources(), document);
        Canvas canvas = new Canvas(pdfCanvas, pageSize);
        float x = (pageSize.getLeft() + pageSize.getRight()) / 2;
        float y = pageSize.getBottom() + 15;
        Paragraph paragraph =
                new Paragraph("第" + document.getPageNumber(page) + "页/共" + document.getNumberOfPages() + "页")
                .setFontSize(10)
                .setFont(pdfFont);
        canvas.showTextAligned(paragraph, x, y, TextAlignment.CENTER);
        canvas.close();
    }
}

WaterMarkEventHandler

package com.cnbai.pdf;

import com.itextpdf.kernel.colors.WebColors;
import com.itextpdf.kernel.events.Event;
import com.itextpdf.kernel.events.IEventHandler;
import com.itextpdf.kernel.events.PdfDocumentEvent;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.font.PdfFontFactory;
import com.itextpdf.kernel.geom.Rectangle;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfPage;
import com.itextpdf.kernel.pdf.canvas.PdfCanvas;
import com.itextpdf.layout.Canvas;
import com.itextpdf.layout.element.Paragraph;
import com.itextpdf.layout.property.TextAlignment;
import com.itextpdf.layout.property.VerticalAlignment;

import java.io.IOException;

/**
 * 生成 pdf 水印
 */
public class WaterMarkEventHandler implements IEventHandler {

    /**
     * 水印内容
     */
    private final String waterMarkContent;

    /**
     * 一页中有几列水印
     */
    private final int waterMarkX;

    /**
     * 一页中每列有多少水印
     */
    private final int waterMarkY;

    public WaterMarkEventHandler(String waterMarkContent) {
        this(waterMarkContent, 5, 5);
    }

    public WaterMarkEventHandler(String waterMarkContent, int waterMarkX, int waterMarkY) {
        this.waterMarkContent = waterMarkContent;
        this.waterMarkX = waterMarkX;
        this.waterMarkY = waterMarkY;
    }

    @Override
    public void handleEvent(Event event) {
        PdfDocumentEvent documentEvent = (PdfDocumentEvent) event;
        PdfDocument document = documentEvent.getDocument();
        PdfPage page = documentEvent.getPage();
        Rectangle pageSize = page.getPageSize();
        PdfFont pdfFont = null;
        try {
            pdfFont = PdfFontFactory.createFont("STSongStd-Light", "UniGB-UCS2-H", false);
        } catch (IOException e) {
            e.printStackTrace();
        }

        PdfCanvas pdfCanvas = new PdfCanvas(page.newContentStreamAfter(), page.getResources(), document);
        Paragraph waterMark = new Paragraph(waterMarkContent).setOpacity(0.5f);
        Canvas canvas = new Canvas(pdfCanvas, pageSize)
                .setFontColor(WebColors.getRGBColor("lightgray"))
                .setFontSize(16)
                .setFont(pdfFont);

        for (int i = 0; i < waterMarkX; i++) {
            for (int j = 0; j < waterMarkY; j++) {
                canvas.showTextAligned(waterMark, (150 + i * 300), (160 + j * 150), document.getNumberOfPages(),
                        TextAlignment.CENTER, VerticalAlignment.BOTTOM, 120);
            }
        }
        canvas.close();
    }
}

6. 创建 Html 文件

test.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>测试标题</title>
</head>
<body>
cnbai
<img src="http://localhost/image.jpg">
<img src="upload/test.jpg">
</body>
</html>

7. 字体文件

字体文件在本地 windows 拷贝出来，放在图中目录下

baihb1024
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 8
    评论
专栏目录
springboot整合itextpdf导出pdf
周不老的博客
06-17 2351
springboot整合itextpdf导出pdf 1.pom依赖 如果使用别的版本有可能会报错,建议使用这2个版本 <dependency> <groupId>com.itextpdf</groupId> <artifactId>itextpdf</artifactId> <version>5.5.5</version> </dependency> <dependency>
springboot thymeleaf html转pdf两种实现
yzshen123456的博客
04-30 783
写博客记录肯定是有不一样的，那么切记，html里一定要带上字体，纸张大小也可以。甚至页眉页脚水印都可以通过css来设置.尤其openhtmltopdf，代码没有直接支持水印什么的，就是让你在HTML里用样式处理。oepnhtmltopdf比上边第一种方式简单，生成的pdf也比第一种清晰，不知道第一种哪里可以设置。thymeleaf是用来获取html数据的，毕竟是个模版，传参最终拼成html的字符串string。代码抄袭就不展示了，我主要是把thymleaf放到了业务工程，pdf转换是单独的插件。
springboot使用itext生成pdf并保存到本地
03-02
html渲染页面转换为pdf并设置页眉，页码，水印，目录，二维码
java springboot 生成pdf 的方式有哪些
最新发布
cesske的博客
07-27 1143
在Spring Boot应用程序中生成PDF文件，‌可以通过以下几种方式实现：‌。
springboot 使用itextpdf、thymeleaf，将html转为PDF
fanhengkui的专栏
02-20 908
itextpdf目前使用的是5版本的。
SpringBoot使用HTML转PDF
weixin_46361701的博客
10-16 223
SpringBoot使用HTML转PDF
Springboot将html导出为PDF
KF30350的博客
05-26 2877
项目搭建 springboot >2.2.2.RELEASE pom.xml导入flying-saucer-pdf-itext5 包 <dependency> <groupId>org.xhtmlrenderer</groupId> <artifactId>flying-saucer-pdf-itext5</artifactId> <version>9.0.6</version> </dependency&
spring boot 转pdf (html转pdf)
qq_37782946的博客
01-11 1599
springboot html转pdf
springboot html 动态数据转pdf
F1520080的博客
04-17 696
param ftlFilePath html 模板文件相对路径(相对于 resources路径,路径 + 文件名)@param relativePath 资源文件相对路径(相对于 resources路径,路径 + 文件名)@param relativePath 资源文件相对路径(相对于 resources路径,路径 + 文件名)@param relativePath 资源文件相对路径(相对于 resources路径,路径 + 文件名)@param fontFile 所需字体文件(相对路径+文件名)
SpringBoot ---HTML转PDF工具
一只菜鸟夹
03-21 319
之前项目用的WKHtmlToPdf，速度较慢，现在需要改成基于ITEXT。
SpringBoot自定义HTML生成PDF，支持水印文本及图片
weixin_44254869的博客
10-10 524
根据HTML实现数据渲染填充PDF动态列表，表格，图片 步骤3、自定义HTML模版 注：需要前端配合自定义模版计算高度 否则会导致边框 分页失效 步骤4、Controller实现 步骤5 Yml设置 注：注意路径读取，及字体文件 Ftl模版高度设置
spring-boot-htmltopdf-master.zip
04-17
spring-boot-htmltopdf-spring-boot-htmltopdf-master.zip spring-boot-htmltopdf-master.zip
html转PDF（java版 ）
06-15
对html的规范要求极高,例如：页面中必须闭合，必须: * * *
SpringBoot在线预览PDF文件
04-25
通过SpringBoot框架实现PDF在线预览，此项目只是简单的Demo个小实例，只提供参考，希望能给需要的朋友带来帮助。
freemarket+itext+springboot将html静态页面渲染后导出为pdf文件
haha_66666的博客
10-12 6892
1、maven依赖 &lt;dependency&gt; &lt;groupId&gt;com.itextpdf&lt;/groupId&gt; &lt;artifactId&gt;itextpdf&lt;/artifactId&gt; &lt;version&gt;5.4.2&lt;/version&gt;
springboot项目实现导出pdf功能，这也太简单了吧
理想万岁万万岁的博客
04-04 6375
在我们日常开发中，经常会遇到导出pdf这种需求，比如导出合同、导出业务报告等。这中导出功能都有一个特点，导出的pdf中有大量相同的文本布局以及样式，只有涉及到用户本人的信息时出现不同的内容。我们把这些相同的部分称作模版，在模版中放置一些变量来代表用户信息，比如用户姓名、年龄等。这样我们在导出pdf的时候，在数据库中把用户信息查出来，对模版中对应的变量进行替换，再把替换的结果转成pdf文件就可以了。模版的类型有很多种：html模版、doc模版、excel模版、pdf模版等等。
springboot通过thymeleaf模板实现动态html模板转pdf文件
victory_chao的博客
03-28 7795
项目中，有一个需求是动态的合同模板，最终可生成pdf文件。项目架构是springboot 1、在pom.xml里添加thymeleaf的starter和生成pdf的jar <dependency> <groupId>org.springframework.boot</groupId> <artifactId&...
4、制作一个html转pdf的spring boot starter
Lune_solitair
11-01 442
记录每一个努力的日子！ 上一篇：使用euereka、zuul、config、feign、ribbon基本组件完成微服务架构 参考项目：github 1.2.0分支 tool模块 1、依赖软件 wkhtmltopdf 2、关键代码 使用ProcessBuilder来执行可执行脚本 public Html2pdf(String command){ this.command = command; } public final void conver(String htmlPath, String pdfP
如何将 canvas 导出为pdf
05-30
可以使用 jsPDF 库将 canvas 导出为 PDF。以下是一个基本示例： 1. 在 HTML 文件中，添加一个 canvas 元素和一个按钮： ```html <canvas id="myCanvas"></canvas> <button onclick="exportPdf()">导出为 PDF</button> ``` 2. 在 JavaScript 文件中，使用 jsPDF 库将 canvas 导出为 PDF： ```javascript function exportPdf() { // 获取 canvas 元素 const canvas = document.getElementById("myCanvas"); // 创建 jsPDF 实例 const doc = new jsPDF(); // 获取 canvas 图像的数据 URL const dataUrl = canvas.toDataURL(); // 将数据 URL 添加到 PDF 中 doc.addImage(dataUrl, "PNG", 0, 0, canvas.width, canvas.height); // 导出 PDF doc.save("myCanvas.pdf"); } ``` 以上代码将在单击按钮时导出 canvas 元素为名为 "myCanvas.pdf" 的 PDF 文件。
评论 8
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值