在Spring Boot中轻松掌握iTextPDF，打造动态PDF文档

2023-12-10 17:50:06

使用 iTextPDF 在 Spring Boot 中处理 PDF 文档

前言

作为一种备受推崇的文件格式，PDF（便携式文档格式）因其出色的稳定性和跨平台兼容性而在众多领域得到广泛应用。在 Java 开发中，iTextPDF 因其灵活的 API 设计和强大的功能而成为创建和操作 PDF 文档的首选。本文将深入探讨如何使用 iTextPDF 在 Spring Boot 中高效地处理 PDF 文档，涵盖从基本示例到复杂操作的各个方面。

依赖引入

在 Spring Boot 项目中，首先需要通过 pom.xml 文件引入 iTextPDF 依赖：

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

基本示例

为了快速上手，让我们从一个简单的示例开始，展示如何利用 iTextPDF 创建一个 PDF 文档：

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

public class PdfGenerator {
    public static void main(String[] args) throws Exception {
        // 创建一个文档对象
        Document document = new Document(PageSize.A4);
        
        // 为文档创建 PDF Writer
        PdfWriter writer = PdfWriter.getInstance(document, new FileOutputStream("HelloWorld.pdf"));
        
        // 打开文档
        document.open();
        
        // 向文档中添加段落
        Paragraph paragraph = new Paragraph("Hello World!");
        document.add(paragraph);
        
        // 关闭文档
        document.close();
    }
}

运行此代码将在项目目录下生成一个名为 "HelloWorld.pdf" 的 PDF 文档，其中包含 "Hello World!" 文本。

灵活操作

iTextPDF 为 PDF 文档的操作提供了广泛的功能，包括：

文本编辑： 使用 Paragraph 和 Phrase 对象轻松地向文档中添加文本。
图片处理： 将图片添加到文档中，并控制其位置和大小。
表格创建： 使用 Table 对象创建表格，轻松插入和修改表格内容。
样式控制： 使用字体、颜色和对齐方式等样式选项来控制文本和对象的显示。
布局管理： 使用 ColumnText 和 FlowingBlock 等布局对象来控制文档中元素的布局和分页。

综合实例

为了展示 iTextPDF 在 Spring Boot 中更高级的应用，让我们构建一个更复杂的示例：创建一个包含表格的 PDF 文档，并将其存储在数据库中。

import com.itextpdf.text.*;
import com.itextpdf.text.pdf.PdfPTable;
import com.itextpdf.text.pdf.PdfWriter;

import javax.persistence.*;
import java.io.ByteArrayOutputStream;
import java.util.List;

@Entity
public class Employee {
    @Id
    @GeneratedValue
    private Long id;
    private String name;
    private String email;
    
    // ... getters and setters
}

public class PdfGenerator {
    public static void main(String[] args) throws Exception {
        // 从数据库中获取员工列表
        List<Employee> employees = ...;
        
        // 创建一个ByteArrayOutputStream来保存PDF文档
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        
        // 为文档创建PDF Writer
        Document document = new Document(PageSize.A4);
        PdfWriter writer = PdfWriter.getInstance(document, baos);
        
        // 打开文档
        document.open();
        
        // 创建一个表格
        PdfPTable table = new PdfPTable(3);
        table.setWidthPercentage(100);
        table.addCell("ID");
        table.addCell("姓名");
        table.addCell("邮箱");
        
        // 将员工信息添加到表格中
        for (Employee employee : employees) {
            table.addCell(String.valueOf(employee.getId()));
            table.addCell(employee.getName());
            table.addCell(employee.getEmail());
        }
        
        // 将表格添加到文档中
        document.add(table);
        
        // 关闭文档
        document.close();
        
        // 将PDF文档保存到数据库中
        Employee employee = ...;
        employee.setPdfDocument(baos.toByteArray());
        ... // 保存员工信息到数据库
    }
}