Java 转 PDF：从基础到最佳实践

简介

在当今数字化的时代，将 Java 应用程序中的数据转换为 PDF 格式是一项常见且重要的任务。PDF（Portable Document Format）以其跨平台、保留文档格式等特性，广泛应用于各种场景，如生成报表、合同、发票等。本文将深入探讨 Java 转 PDF 的相关知识，涵盖基础概念、使用方法、常见实践以及最佳实践，帮助读者全面掌握这一技术。

目录

1. 基础概念
   • PDF 格式概述
   • Java 操作 PDF 的常用库
2. 使用方法
   • 使用 iText 库创建 PDF
   • 使用 Apache PDFBox 创建 PDF
3. 常见实践
   • 在 PDF 中添加文本
   • 插入图片到 PDF
   • 生成表格在 PDF 中
4. 最佳实践
   • 性能优化
   • 安全性考虑
   • 代码结构与维护
5. 小结
6. 参考资料

基础概念

PDF 格式概述

PDF 是由 Adobe 公司开发的一种文件格式，旨在确保文档在不同操作系统、应用程序和设备上保持一致的外观和格式。它支持多种内容类型，包括文本、图像、矢量图形、表单等，并且可以进行加密、数字签名等安全操作。

Java 操作 PDF 的常用库

1. iText：一个功能强大且广泛使用的 Java 库，用于创建、编辑和转换 PDF 文档。它提供了丰富的 API 来处理 PDF 的各种元素，如文本、图像、表格等。
2. Apache PDFBox：是一个开源的 Java 库，专注于 PDF 文档的处理。它不仅可以创建 PDF，还能对现有 PDF 进行读取、编辑和转换等操作。

使用方法

使用 iText 库创建 PDF

首先，需要在项目中引入 iText 库的依赖。如果使用 Maven，可以在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>com.itextpdf</groupId>
    <artifactId>itextpdf</artifactId>
    <version>5.5.13</version>
</dependency>

以下是一个简单的示例，用于创建一个包含文本的 PDF 文件：

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Paragraph;
import com.itextpdf.text.pdf.PdfWriter;

import java.io.FileOutputStream;
import java.io.IOException;

public class ITextExample {
    public static void main(String[] args) {
        Document document = new Document();
        try {
            PdfWriter.getInstance(document, new FileOutputStream("output.pdf"));
            document.open();
            document.add(new Paragraph("这是一个使用 iText 生成的 PDF 文件。"));
            document.close();
        } catch (DocumentException | IOException e) {
            e.printStackTrace();
        }
    }
}

使用 Apache PDFBox 创建 PDF

同样，先在 pom.xml 中添加 Apache PDFBox 的依赖：

<dependency>
    <groupId>org.apache.pdfbox</groupId>
    <artifactId>pdfbox</artifactId>
    <version>2.0.24</version>
</dependency>

下面是使用 Apache PDFBox 创建 PDF 的示例代码：

import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.font.PDType1Font;

import java.io.IOException;

public class PDFBoxExample {
    public static void main(String[] args) {
        try (PDDocument document = new PDDocument()) {
            PDPage page = new PDPage();
            document.addPage(page);

            try (PDPageContentStream contentStream = new PDPageContentStream(document, page)) {
                contentStream.beginText();
                contentStream.setFont(PDType1Font.HELVETICA_BOLD, 12);
                contentStream.newLineAtOffset(100, 700);
                contentStream.showText("这是一个使用 Apache PDFBox 生成的 PDF 文件。");
                contentStream.endText();
            } catch (IOException e) {
                e.printStackTrace();
            }

            document.save("output.pdf");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

常见实践

在 PDF 中添加文本

使用 iText：

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Font;
import com.itextpdf.text.Paragraph;
import com.itextpdf.text.pdf.PdfWriter;

import java.io.FileOutputStream;
import java.io.IOException;

public class AddTextToPDFWithIText {
    public static void main(String[] args) {
        Document document = new Document();
        try {
            PdfWriter.getInstance(document, new FileOutputStream("text_output.pdf"));
            document.open();

            Font font = new Font(Font.FontFamily.TIMES_ROMAN, 16, Font.BOLD);
            Paragraph paragraph = new Paragraph("这是一段加粗的文本", font);
            document.add(paragraph);

            document.close();
        } catch (DocumentException | IOException e) {
            e.printStackTrace();
        }
    }
}

使用 Apache PDFBox：

import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.font.PDType1Font;

import java.io.IOException;

public class AddTextToPDFWithPDFBox {
    public static void main(String[] args) {
        try (PDDocument document = new PDDocument()) {
            PDPage page = new PDPage();
            document.addPage(page);

            try (PDPageContentStream contentStream = new PDPageContentStream(document, page)) {
                contentStream.beginText();
                contentStream.setFont(PDType1Font.HELVETICA, 14);
                contentStream.newLineAtOffset(100, 700);
                contentStream.showText("这是一段使用 Apache PDFBox 添加的文本。");
                contentStream.endText();
            } catch (IOException e) {
                e.printStackTrace();
            }

            document.save("text_output.pdf");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

插入图片到 PDF

使用 iText：

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Image;
import com.itextpdf.text.pdf.PdfWriter;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;

public class AddImageToPDFWithIText {
    public static void main(String[] args) {
        Document document = new Document();
        try {
            PdfWriter.getInstance(document, new FileOutputStream("image_output.pdf"));
            document.open();

            Image image = Image.getInstance(new File("example.jpg").getAbsolutePath());
            image.scaleToFit(200, 200);
            document.add(image);

            document.close();
        } catch (DocumentException | IOException e) {
            e.printStackTrace();
        }
    }
}

使用 Apache PDFBox：

import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject;

import java.io.File;
import java.io.IOException;

public class AddImageToPDFWithPDFBox {
    public static void main(String[] args) {
        try (PDDocument document = new PDDocument()) {
            PDPage page = new PDPage();
            document.addPage(page);

            PDImageXObject pdImage = PDImageXObject.createFromFileByExtension(new File("example.jpg"), document);
            PDRectangle cropBox = page.getCropBox();
            float x = (cropBox.getWidth() - pdImage.getWidth()) / 2;
            float y = (cropBox.getHeight() - pdImage.getHeight()) / 2;

            try (PDPageContentStream contentStream = new PDPageContentStream(document, page)) {
                contentStream.drawImage(pdImage, x, y);
            } catch (IOException e) {
                e.printStackTrace();
            }

            document.save("image_output.pdf");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

生成表格在 PDF 中

使用 iText：

import com.itextpdf.text.Document;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Table;
import com.itextpdf.text.pdf.PdfWriter;

import java.io.FileOutputStream;
import java.io.IOException;

public class AddTableToPDFWithIText {
    public static void main(String[] args) {
        Document document = new Document();
        try {
            PdfWriter.getInstance(document, new FileOutputStream("table_output.pdf"));
            document.open();

            Table table = new Table(3);
            table.addCell("表头 1");
            table.addCell("表头 2");
            table.addCell("表头 3");
            table.addCell("数据 1");
            table.addCell("数据 2");
            table.addCell("数据 3");

            document.add(table);
            document.close();
        } catch (DocumentException | IOException e) {
            e.printStackTrace();
        }
    }
}

使用 Apache PDFBox：

import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDPageContentStream;
import org.apache.pdfbox.pdmodel.font.PDType1Font;
import org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState;

import java.io.IOException;

public class AddTableToPDFWithPDFBox {
    public static void main(String[] args) {
        try (PDDocument document = new PDDocument()) {
            PDPage page = new PDPage();
            document.addPage(page);

            PDPageContentStream contentStream = new PDPageContentStream(document, page);
            contentStream.beginText();
            contentStream.setFont(PDType1Font.HELVETICA, 12);

            float x = 100;
            float y = 700;
            float cellWidth = 100;
            float cellHeight = 20;

            // 绘制表头
            contentStream.showTextAligned(PDExtendedGraphicsState.create(), "表头 1", x, y, 0);
            contentStream.showTextAligned(PDExtendedGraphicsState.create(), "表头 2", x + cellWidth, y, 0);
            contentStream.showTextAligned(PDExtendedGraphicsState.create(), "表头 3", x + 2 * cellWidth, y, 0);

            // 绘制表格线
            for (int i = 0; i < 2; i++) {
                contentStream.moveTo(x, y - (i + 1) * cellHeight);
                contentStream.lineTo(x + 3 * cellWidth, y - (i + 1) * cellHeight);
                contentStream.stroke();
            }

            for (int i = 0; i < 3; i++) {
                contentStream.moveTo(x + i * cellWidth, y);
                contentStream.lineTo(x + i * cellWidth, y - 2 * cellHeight);
                contentStream.stroke();
            }

            // 绘制表格数据
            contentStream.showTextAligned(PDExtendedGraphicsState.create(), "数据 1", x, y - cellHeight, 0);
            contentStream.showTextAligned(PDExtendedGraphicsState.create(), "数据 2", x + cellWidth, y - cellHeight, 0);
            contentStream.showTextAligned(PDExtendedGraphicsState.create(), "数据 3", x + 2 * cellWidth, y - cellHeight, 0);

            contentStream.endText();
            contentStream.close();

            document.save("table_output.pdf");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

最佳实践

性能优化

• 批量处理：如果需要生成多个 PDF 文件，避免重复初始化库和资源，尽量在一个流程中完成所有操作。
• 内存管理：及时释放不再使用的资源，如关闭 Document 和 PDDocument 等对象，防止内存泄漏。

安全性考虑

• 加密：使用库提供的加密功能对 PDF 文件进行加密，设置访问密码和权限，保护文档内容。
• 数字签名：对于需要认证和完整性保证的文档，添加数字签名，确保文档来源可靠且未被篡改。

代码结构与维护

• 模块化：将 PDF 生成相关的代码封装成独立的方法或类，提高代码的可维护性和复用性。
• 错误处理：在代码中添加详细的错误处理机制，以便在出现问题时能够快速定位和解决。

小结

本文全面介绍了 Java 转 PDF 的相关知识，从基础概念到使用方法，再到常见实践和最佳实践。通过使用 iText 和 Apache PDFBox 等库，读者可以轻松地在 Java 应用程序中创建、编辑和处理 PDF 文档。在实际应用中，应根据具体需求选择合适的库，并遵循最佳实践来优化性能、保障安全和提高代码质量。

参考资料

• iText 官方文档
• Apache PDFBox 官方文档
• Java 技术手册