专栏名称: 芋道源码
纯 Java 源码分享公众号,目前有「Dubbo」「SpringCloud」「Java 并发」「RocketMQ」「Sharding-JDBC」「MyCAT」「Elastic-Job」「SkyWalking」「Spring」等等
目录
相关文章推荐
芋道源码  ·  万字:一文搞懂184个支付名词 ·  2 天前  
芋道源码  ·  使用Redisson时,为何synchron ... ·  3 天前  
芋道源码  ·  MySQL+Redis,百万数据轻松优化 ·  5 天前  
51好读  ›  专栏  ›  芋道源码

Spring Boot3集成iText实现PDF导出功能

芋道源码  · 公众号  · Java  · 2024-11-08 09:31

正文

👉 这是一个或许对你有用的社群

🐱 一对一交流/面试小册/简历优化/求职解惑,欢迎加入芋道快速开发平台知识星球。下面是星球提供的部分资料: 

👉这是一个或许对你有用的开源项目

国产 Star 破 10w+ 的开源项目,前端包括管理后台 + 微信小程序,后端支持单体和微服务架构。

功能涵盖 RBAC 权限、SaaS 多租户、数据权限、商城、支付、工作流、大屏报表、微信公众号、CRM 等等功能:

  • Boot 仓库:https://gitee.com/zhijiantianya/ruoyi-vue-pro
  • Cloud 仓库:https://gitee.com/zhijiantianya/yudao-cloud
  • 视频教程:https://doc.iocoder.cn
【国内首批】支持 JDK 21 + SpringBoot 3.2.2、JDK 8 + Spring Boot 2.7.18 双版本 

来源:江南一点雨


不知道小伙伴们在项目中有没有遇到过导出 PDF 的需求,我在之前的 tienchin 项目中有一个合同导出的功能,需要将文档导出为 PDF。

将文档导出为 PDF 有很多方案,不同方案的优缺点也各不相同,今天就和大家演示一个。

一 解决方案

以下是列举的一些常见的 PDF 导出方案。

1.1 iText

iText 是一个强大的 PDF 处理库,可以用来创建和操作 PDF 文件。在 Spring Boot 项目中,你可以通过添加 iText 的依赖来使用它。iText 支持直接创建 PDF,也可以将 HTML 内容转换为 PDF。

iText 的特点如下:

优点:

  • 功能强大,支持创建和编辑 PDF 文件。
  • 提供丰富的 API,支持添加图像、水印、表格、书签和超链接等。
  • 支持数字签名和加密 PDF 文件。
  • 性能优秀,能够高效地处理大型 PDF 文件和复杂操作。

缺点:

  • 学习曲线较陡峭,需要一定的时间和精力去熟悉。
  • 商业版需要购买许可证,可能会增加成本。
  • 对于简单的 PDF 处理任务可能过于复杂。

1.2 OpenPDF

OpenPDF 是基于 iText5.x 版本开发的,它提供了将 HTML 转换为 PDF 的功能。

OpenPDF 的特点如下:

优点:

  • 简单易用,适合快速开发。
  • 提供了创建和操作 PDF 文件的一组 API。

缺点:

功能相对较少,可能无法满足复杂需求。

1.3 Apache PDFBox

Apache PDFBox 是一个开源的 Java PDF 库,可以用来创建和编辑 PDF 文档。它提供了丰富的 API 来操作 PDF 内容。

Apache PDFBox 的特点如下:

优点:

  • 功能齐全,支持创建、编辑、提取内容等操作。
  • 支持 OCR 识别和打印等功能。
  • 性能稳定,适合全面处理 PDF 文件的场景。
  • 开源免费,采用 Apache 许可证。

缺点:

  • 相对于 iText,处理大型文件时性能可能略逊一筹。
  • API 设计较为复杂,可能会影响开发效率。

1.4 Flyingsaucer

Flyingsaucer 是一个基于 iText 和 XHTMLRenderer 的 Java 库,可以将 XHTML/CSS 内容转换为 PDF。

Flyingsaucer 特点如下:

优点:

  • 可以将 HTML/CSS 内容直接转换为 PDF。
  • 支持使用 CSS 样式来控制 PDF 的外观。

缺点:

  • 不支持富文本,对于使用富文本编辑器的内容处理不佳。
  • 对 HTML 的规范性要求较高,容错性较差。

上面是给大家列举的几个常见的方案,实际方案除了这些还有很多,比如 WeasyPrint、OpenHTMLtoPDF 等,在实际项目中选择哪种方案取决于你的具体需求,比如是否需要处理复杂的布局、是否需要支持 CSS 样式、是否需要处理中文等非 ASCII 字符等。每种方案都有其优缺点,需要根据项目实际情况进行选择。

这里和小伙伴们演示一下 iText 的使用,这个工具的能力最为强大。

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/ruoyi-vue-pro
  • 视频教程:https://doc.iocoder.cn/video/

二 iText

2.1 什么是 iText

iText 是一个功能强大的开源 Java 库,用于创建和操作 PDF 文件。

iText 提供了丰富的 API,可以生成交互式 PDF 文档、添加书签、页码、水印,以及拆分和合并 PDF 文档等。

iText 支持将 PDF 保存为图像文件,如 PNG 或 JPEG,并且可以在 PDF 文档上绘制各种几何形状,如圆形、线条等。

iText的主要特点

  1. 交互性 :可以创建交互式 PDF 文档,如表单填写。
  2. 添加元素 :可以添加书签、页码、水印等。
  3. 分割与合并 :可以将现有 PDF 分割或合并其他页面。
  4. 表单处理 :可以处理 PDF 表单。
  5. 保存为图像 :可以将 PDF 保存为图像格式。
  6. 绘制功能 :提供 Canvas 类,支持绘制各种形状。

注意,iText 本身不支持中文,需要引入中文字体文件,并使用 BaseFont.createFont 方法创建字体对象,然后使用该字体对象创建文本。

在使用 iText 时,还需要注意开源协议的问题。iText 目前遵循 AGPL 开源协议,如果是商业用途,需要公开源代码或者购买商业许可。

此外,iText 还提供了一些高级功能,如 PDF 加密、数字签名、优化 PDF 文件大小等。

2.2 案例

首先我们新建一个 Spring Boot 项目,引入 Thymeleaf 依赖,引入这个依赖的原因在于我们一会利用 Thymeleaf 做页面模版,然后利用 iText 做 PDF 生成。

项目创建成功之后,再引入 iText 的依赖,最终依赖如下:

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation group: 'com.itextpdf', name: 'itextpdf', version: '5.5.13.4'
    implementation group: 'com.itextpdf', name: 'html2pdf', version: '5.0.5'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
}

注意,这里和 iText 相关的依赖一共有两个。

接下来我们创建一个 HTML 页面作为生成的 PDF 模版,这个模版我们就放到 Thymeleaf 默认的 templates 目录下:

html>
<h1 th:text="${title}">h1>
<table border="1">
    <tr>
        <td>图书名称td>
        <td th:text="${name}">td>
    tr>
    <tr>
        <td>图书价格td>
        <td th:text="${price}">td>
    tr>
    <tr>
        <td>图书作者td>
        <td th:text="${author}">td>
    tr>
table>

这个页面模版使用 Thymeleaf 来构建。

另外,由于这些工具大部分都不直接支持中文,需要我们提前准备中文字体,松哥这里准备了一个宋体字库,放在 resources/fonts 目录下:

接下来我们就准备一个生成 PDF 的工具类,如下:

package org.javaboy.openpdfdemo.utils;

import com.itextpdf.html2pdf.ConverterProperties;
import com.itextpdf.html2pdf.HtmlConverter;
import com.itextpdf.io.font.PdfEncodings;
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 java.io.IOException;
import java.io.OutputStream;

/**
 * @github:https://github.com/lenve
 * @gitee:https://gitee.com/lenve
 */

public class HtmlToPdfUtils {

    public static void convertToPdf(String html, 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();

        // 添加自定义字体,例如宋体
        PdfFont stSong = PdfFontFactory.createFont(HtmlToPdfUtils.class.getResource("/fonts/STSong.ttf").getPath(), PdfEncodings.WINANSI);
        fontProvider.addFont(stSong.getFontProgram(), PdfEncodings.IDENTITY_H);

        properties.setFontProvider(fontProvider);
        if (html != null) {
            // 生成pdf文档
            HtmlConverter.convertToPdf(html, pdfDocument, properties);
            pdfWriter.close();
            pdfDocument.close();
        } else {
            throw new RuntimeException("HTML 内容不能为空");
        }
    }
}

这块代码没啥好说的,基本上见名知义。

最后,在 Controller 接口中调用该工具类,如下:

package org.javaboy.openpdfdemo.controller;

import com.itextpdf.text.DocumentException;
import jakarta.servlet.http.HttpServletResponse;
import org.javaboy.openpdfdemo.utils.HtmlToPdfUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;

import java.io.IOException;

/**
 * @github:https://github.com/lenve
 * @gitee:https://gitee.com/lenve
 */

@RestController
public class HelloController {

    @Autowired
    TemplateEngine templateEngine;

    @GetMapping("/getBookInfo")
    public void getBookInfo(HttpServletResponse response) throws IOException, DocumentException {
        Context ctx = new Context();
        ctx.setVariable("title","图书详情");
        ctx.setVariable("name","");
        ctx.setVariable("price","99.00");
        ctx.setVariable("author","江南一点雨");
        String bookInfo = templateEngine.process("book_info", ctx);
        response.setContentType("application/pdf;charset=utf-8");
        HtmlToPdfUtils.convertToPdf(bookInfo, response.getOutputStream());
    }
}

先利用 TemplateEngine,将页面模版的内容转为渲染后的 HTML 字符串,然后调用工具方法去生成 PDF,生成的 PDF 直接就赋值给请求响应的输出流。

最后,我们在浏览器中访问 http://localhost:8080/getBookInfo 就可以查看生成的 PDF 内容啦~

好啦,一个简单的案例,带小伙伴们感受下 Java 生成 PDF。


欢迎加入我的知识星球,全面提升技术能力。

👉 加入方式,长按”或“扫描”下方二维码噢

星球的内容包括:项目实战、面试招聘、源码解析、学习路线。

文章有帮助的话,在看,转发吧。

谢谢支持哟 (*^__^*)