【亲测免费】 OpenHTMLtoPDF 开源项目教程

2026-01-23 04:37:49作者：魏献源Searcher

An HTML to PDF library for the JVM. Based on Flying Saucer and Apache PDF-BOX 2. With SVG image support. Now also with accessible PDF support (WCAG, Section 508, PDF/UA)!

项目地址：https://gitcode.com/gh_mirrors/op/openhtmltopdf

1. 项目介绍

OpenHTMLtoPDF 是一个基于 Java 的库，用于将 HTML 和 CSS 转换为 PDF 文件。它基于 Flying Saucer 和 Apache PDFBox 2，支持 SVG 图像和可访问的 PDF 支持（WCAG、Section 508、PDF/UA）。该项目的目标是提供一个高效、易用的工具，帮助开发者生成高质量的 PDF 文档。

2. 项目快速启动

2.1 环境准备

确保你已经安装了 Java 8 或更高版本。

2.2 添加依赖

在你的 Maven 项目中，添加以下依赖：

<dependency>
    <groupId>com.openhtmltopdf</groupId>
    <artifactId>openhtmltopdf-core</artifactId>
    <version>1.0.10</version>
</dependency>

2.3 编写代码

以下是一个简单的示例代码，展示如何使用 OpenHTMLtoPDF 将 HTML 转换为 PDF：

import com.openhtmltopdf.pdfboxout.PdfRendererBuilder;
import java.io.FileOutputStream;
import java.io.OutputStream;

public class HtmlToPdfExample {
    public static void main(String[] args) throws Exception {
        String html = "<html><body><h1>Hello, OpenHTMLtoPDF!</h1></body></html>";
        try (OutputStream os = new FileOutputStream("output.pdf")) {
            PdfRendererBuilder builder = new PdfRendererBuilder();
            builder.withHtmlContent(html, null);
            builder.toStream(os);
            builder.run();
        }
    }
}

2.4 运行代码

编译并运行上述代码，你将得到一个名为 output.pdf 的文件，其中包含 "Hello, OpenHTMLtoPDF!" 的标题。

3. 应用案例和最佳实践

3.1 生成报告

OpenHTMLtoPDF 可以用于生成各种类型的报告，如财务报告、销售报告等。通过使用 HTML 和 CSS 来设计报告的布局，可以轻松生成格式化的 PDF 文件。

3.2 生成发票

发票通常需要特定的格式和布局。使用 OpenHTMLtoPDF，你可以通过编写 HTML 模板来生成符合要求的发票 PDF。

3.3 生成合同

合同文档通常需要严格的格式和排版。OpenHTMLtoPDF 可以帮助你生成符合法律要求的合同 PDF 文件。

4. 典型生态项目

4.1 Apache PDFBox

Apache PDFBox 是一个用于创建和操作 PDF 文档的 Java 库。OpenHTMLtoPDF 使用 PDFBox 作为其 PDF 生成引擎，提供了强大的 PDF 处理能力。

4.2 Flying Saucer

Flying Saucer 是一个基于 Java 的 XHTML 渲染库，OpenHTMLtoPDF 基于 Flying Saucer 构建，提供了对 HTML 和 CSS 的强大支持。

4.3 SVG 支持

OpenHTMLtoPDF 支持 SVG 图像，这使得你可以在生成的 PDF 中包含复杂的图形和图表。

通过以上教程，你应该能够快速上手使用 OpenHTMLtoPDF 项目，并了解其在实际应用中的最佳实践和相关生态项目。

openhtmltopdf