博客主页: 南来_北往
系列专栏：Spring Boot实战
在现代应用程序开发中，生成PDF文件是一个常见的需求。PDF文件因其跨平台性和易读性，被广泛应用于文档交换、报告生成和打印预览等场景。Spring Boot作为一个用于简化Spring应用开发的框架，通过提供默认配置和快速开发环境，帮助开发者以最快的速度构建应用程序。而iTextPdf是一个强大的Java类库，用于生成和处理PDF文档。本文将介绍如何使用Spring Boot和iTextPdf高效生成PDF文件并实现预览功能。
一、准备工作
首先，确保你的Spring Boot项目中已经添加了iTextPdf依赖。你可以通过修改pom.xml文件来添加依赖项。以下是一个示例：
<dependency> <groupId>com.itextpdf</groupId> <artifactId>itext7-core</artifactId> <version>7.1.15</version>
</dependency>二、生成PDF文件
使用iTextPdf生成PDF文件的基本步骤如下：
-
创建PDF写入对象：使用
PdfWriter类创建一个PDF写入对象，该对象负责将PDF内容写入到指定的文件中。 -
创建PDF文档对象：使用
PdfDocument类创建一个PDF文档对象，该对象代表整个PDF文档。 -
创建文档对象：使用
Document类创建一个文档对象，该对象用于添加内容到PDF文档中。 -
添加内容到文档：使用
Document对象提供的各种方法（如add）将内容（如文本、段落、表格等）添加到PDF文档中。 -
关闭文档：在完成内容添加后，调用
Document对象的close方法以确保PDF文件正确生成。
以下是一个简单的示例代码，展示了如何使用iTextPdf生成一个包含“Hello, World!”文本的PDF文件：
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Paragraph;
import java.io.IOException; public class PdfGenerator { public static void main(String[] args) { String dest = "example.pdf"; try { createPdf(dest); System.out.println("PDF Created"); } catch (IOException e) { e.printStackTrace(); } } public static void createPdf(String dest) throws IOException { PdfWriter writer = new PdfWriter(dest); PdfDocument pdf = new PdfDocument(writer); Document document = new Document(pdf); document.add(new Paragraph("Hello, World!")); document.close(); }
}三、在Spring Boot中实现PDF生成
在Spring Boot中，你可以创建一个Controller来处理PDF生成请求。以下是一个示例，展示了如何创建一个简单的REST接口，用户请求时自动生成PDF文件并返回给客户端：
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.itextpdf.layout.Document;
import com.itextpdf.layout.element.Paragraph;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException; @RestController
public class PdfController { @GetMapping("/generate-pdf") public void generatePdf(HttpServletResponse response) throws IOException { response.setContentType("application/pdf"); response.setHeader("Content-Disposition", "attachment; filename=sample.pdf"); PdfWriter writer = new PdfWriter(response.getOutputStream()); PdfDocument pdfDocument = new PdfDocument(writer); Document document = new Document(pdfDocument); document.add(new Paragraph("Hello, this is a sample PDF document generated using iTextPDF and Spring Boot!")); document.close(); }
}启动Spring Boot应用后，打开浏览器访问http://localhost:8080/generate-pdf，这将触发PDF文件的下载，文件名为sample.pdf。
四、实现PDF预览功能
为了预览生成的PDF文件，你可以使用Swing组件（如JFrame和JPanel）结合PDFRenderer库来渲染PDF内容。以下是一个简单的示例，展示了如何在Swing应用程序中预览PDF文件：
1、添加PDFRenderer依赖：在你的pom.xml文件中添加Apache PDFBox依赖，该依赖包含了PDFRenderer类。
<dependency> <groupId>org.apache.pdfbox</groupId> <artifactId>pdfbox</artifactId> <version>2.0.24</version>
</dependency>
<dependency> <groupId>org.apache.pdfbox</groupId> <artifactId>pdfbox-tools</artifactId> <version>2.0.24</version>
</dependency>2、编写预览代码：使用PDFRenderer类渲染PDF内容，并将其显示在Swing组件中。
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.rendering.PDFRenderer;
import javax.swing.*;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException; public class PdfPreview { public static void main(String[] args) { String filePath = "example.pdf"; try { createAndShowGUI(filePath); } catch (IOException e) { e.printStackTrace(); } } private static void createAndShowGUI(String filePath) throws IOException { JFrame frame = new JFrame("PDF Preview"); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setSize(800, 600); PDDocument document = PDDocument.load(new File(filePath)); PDFRenderer pdfRenderer = new PDFRenderer(document); BufferedImage bufferedImage = pdfRenderer.renderImageWithDPI(0, 300); // Render the first page at 300 DPI ImageIcon imageIcon = new ImageIcon(bufferedImage); JLabel label = new JLabel(imageIcon); frame.getContentPane().add(new JScrollPane(label)); frame.setVisible(true); document.close(); }
}运行PdfGenerator类生成example.pdf文件，然后运行PdfPreview类预览生成的PDF文件。
五、总结
通过结合Spring Boot和iTextPdf，你可以高效地生成PDF文件并实现预览功能。本文介绍了如何在Spring Boot项目中添加iTextPdf依赖，如何生成PDF文件，以及如何在Swing应用程序中预览PDF文件。这些示例代码可以根据实际需求进行扩展和修改，以满足不同的应用场景。