Spring Boot 实现 PDF 导出在Spring Boot应用程序中实现PDF导出功能可以选择多种库和技术栈。每种方法都有其优缺点适用于不同的场景。以下是四种常见的方式iText、Apache PDFBox、JasperReports 和 Thymeleaf Flying Saucer。我将详细对比这些方法并提供相应的代码示例。1. iText优点:丰富的API: 支持复杂的PDF操作如加密、数字签名、表单处理等。企业级支持: 提供广泛的文档和支持社区。多格式输出: 除了PDF还支持其他格式如HTML、XML的转换。缺点:商业许可: iText 7 是商业软件某些高级功能需要购买许可证。学习曲线: API较为复杂可能需要一定的学习成本。性能:对于大多数应用场景来说iText 的性能是足够的。它在内存管理和文件处理速度方面表现优秀尤其适合处理复杂的PDF文档。适用场景:适合需要生成复杂PDF文档的应用尤其是那些涉及安全性和高级功能的企业级应用。示例代码:!-- 添加依赖 -- dependency groupIdcom.itextpdf/groupId artifactIditext7-core/artifactId version7.1.15/version !-- 请检查并使用最新版本 -- /dependency import com.itextpdf.kernel.pdf.PdfDocument; import com.itextpdf.kernel.pdf.PdfWriter; import com.itextpdf.layout.Document; import com.itextpdf.layout.element.Paragraph; import javax.servlet.http.HttpServletResponse; import java.io.IOException; public class ITextPdfService { public void export(HttpServletResponse response) throws IOException { // 设置响应头 response.setContentType(application/pdf); response.setHeader(Content-Disposition, attachment; filenameusers.pdf); try (PdfWriter writer new PdfWriter(response.getOutputStream()); PdfDocument pdf new PdfDocument(writer); Document document new Document(pdf)) { // 添加内容到PDF document.add(new Paragraph(Hello, this is a PDF document created with iText in Spring Boot!)); // 关闭文档 document.close(); } } }2. Apache PDFBox优点:完全开源: 没有商业限制适合所有类型的项目。轻量级: 依赖项较少项目结构简洁。易于上手: API相对简单适合快速开发和学习。缺点:功能有限: 在一些复杂的功能上如处理大型PDF或执行高级操作可能不如iText强大。性能问题: 在处理非常大的文件或高并发场景下性能可能会略逊于iText。性能:PDFBox 在处理较小的PDF文件时表现良好但在处理大文件或者高并发场景下其性能可能会略逊于iText。适用场景:适合需要生成简单PDF文档的应用尤其是那些希望保持完全开源的项目。示例代码:!-- 添加依赖 -- dependency groupIdorg.apache.pdfbox/groupId artifactIdpdfbox/artifactId version2.0.27/version !-- 请检查并使用最新版本 -- /dependency 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 javax.servlet.http.HttpServletResponse; import java.io.IOException; public class PdfBoxPdfService { public void export(HttpServletResponse response) throws IOException { // 设置响应头 response.setContentType(application/pdf); response.setHeader(Content-Disposition, attachment; filenameusers.pdf); try (PDDocument document new PDDocument()) { PDPage page new PDPage(); document.addPage(page); try (PDPageContentStream contentStream new PDPageContentStream(document, page)) { contentStream.setFont(PDType1Font.HELVETICA_BOLD, 12); contentStream.beginText(); contentStream.newLineAtOffset(100, 700); contentStream.showText(Hello, this is a PDF document created with Apache PDFBox in Spring Boot!); contentStream.endText(); } // 将PDF写入响应输出流 document.save(response.getOutputStream()); } } }3. JasperReports优点:强大的报表设计能力: 支持复杂的表格、图表、分组、子报表等功能。多数据源支持: 可以从数据库、JavaBean集合、CSV、XML等多种数据源获取数据。丰富的样式和格式化: 支持多种字体、颜色、边框、背景等样式设置以及日期、数字等格式化。集成度高: 与Spring Boot集成方便可以轻松地将报表生成逻辑嵌入到应用程序中。输出格式多样: 除了PDF还支持HTML、Excel、CSV等多种输出格式。缺点:学习曲线较陡: JRXML模板语法较为复杂需要一定时间来掌握。依赖项较多: 需要引入多个依赖项可能会增加项目的复杂度。性能问题: 在处理非常大的数据集时可能会遇到性能瓶颈尤其是在内存管理和渲染速度方面。性能:在处理复杂报表和大数据集时表现较好尤其是在需要高级功能如分组、图表的情况下。适用场景:适合需要生成复杂报表的应用尤其是包含大量数据、图表、分组等元素的场景。适合需要支持多种输出格式的应用。示例代码:!-- 添加依赖 -- dependency groupIdnet.sf.jasperreports/groupId artifactIdjasperreports/artifactId version6.17.0/version !-- 请检查并使用最新版本 -- /dependency import net.sf.jasperreports.engine.*; import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.servlet.http.HttpServletResponse; import java.io.InputStream; import java.util.HashMap; import java.util.List; import java.util.Map; RestController RequestMapping(/api) public class JasperReportController { GetMapping(/export-jasper-pdf) public void export(HttpServletResponse response) throws Exception { // 设置响应头 response.setContentType(application/pdf); response.setHeader(Content-Disposition, attachment; filenamereport.pdf); // 加载JRXML模板 InputStream reportTemplate getClass().getResourceAsStream(/templates/report.jrxml); JasperReport jasperReport JasperCompileManager.compileReport(reportTemplate); // 准备数据 ListUser users userService.getAllUsers(); // 假设有一个UserService类 JRBeanCollectionDataSource dataSource new JRBeanCollectionDataSource(users); // 设置参数 MapString, Object parameters new HashMap(); parameters.put(title, User Report); // 生成PDF JasperPrint jasperPrint JasperFillManager.fillReport(jasperReport, parameters, dataSource); JasperExportManager.exportReportToPdfStream(jasperPrint, response.getOutputStream()); } }4. Thymeleaf Flying Saucer优点:HTML/CSS友好: 使用标准的HTML和CSS进行页面布局和样式设置非常适合前端开发人员。易于维护: HTML模板容易理解和修改尤其适合那些已经熟悉HTML/CSS的团队。灵活性高: 可以轻松地将现有的Thymeleaf模板转换为PDF减少了重复工作。轻量级: 相对于JasperReportsFlying Saucer的依赖项较少项目结构更简洁。快速开发: 对于简单的PDF生成需求开发速度较快因为不需要学习新的模板语言。缺点:功能有限: 相比JasperReportsFlying Saucer的功能较为有限特别是在处理复杂报表如分组、图表时。性能一般: 在处理大文件或高并发场景下性能可能不如JasperReports。样式兼容性: 某些CSS样式可能无法完全兼容导致PDF渲染效果与预期不符。性能:对于简单的PDF生成需求性能足够并且开发速度快维护成本低。适用场景:适合需要将现有的HTML页面转换为PDF的应用尤其是那些已经有现成的HTML模板的情况。适合生成简单的文档如发票、合同、报告等而不涉及复杂的报表功能。示例代码:!-- 添加依赖 -- dependency groupIdorg.thymeleaf/groupId artifactIdthymeleaf/artifactId version3.0.12.RELEASE/version !-- 请检查并使用最新版本 -- /dependency dependency groupIdorg.xhtmlrenderer/groupId artifactIdflying-saucer-pdf-itext5/artifactId version9.1.20/version !-- 请检查并使用最新版本 -- /dependency import org.springframework.core.io.ClassPathResource; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import org.thymeleaf.TemplateEngine; import org.thymeleaf.context.Context; import org.xhtmlrenderer.pdf.ITextRenderer; import javax.servlet.http.HttpServletResponse; import java.io.InputStream; import java.io.InputStreamReader; import java.io.OutputStream; import java.nio.charset.StandardCharsets; RestController RequestMapping(/api) public class PdfController { private final TemplateEngine templateEngine; public PdfController(TemplateEngine templateEngine) { this.templateEngine templateEngine; } GetMapping(/export-thymeleaf-pdf) public void export(HttpServletResponse response) throws Exception { // 设置响应头 response.setContentType(application/pdf); response.setHeader(Content-Disposition, attachment; filenamereport.pdf); // 加载HTML模板 InputStream templateInputStream new ClassPathResource(templates/report.html).getInputStream(); String htmlContent new String(templateInputStream.readAllBytes(), StandardCharsets.UTF_8); // 准备上下文数据 Context context new Context(); context.setVariable(users, userService.getAllUsers()); // 假设有一个UserService类 context.setVariable(title, User Report); // 渲染HTML String processedHtml templateEngine.process(htmlContent, context); // 将HTML转换为PDF ITextRenderer renderer new ITextRenderer(); renderer.setDocumentFromString(processedHtml); renderer.layout(); // 输出PDF try (OutputStream outputStream response.getOutputStream()) { renderer.createPDF(outputStream); } } }性能与易用性对比特性iTextApache PDFBoxJasperReportsThymeleaf Flying Saucer性能高中高复杂报表中简单文档易用性复杂简单复杂简单功能强大有限非常强大报表有限HTML/CSS依赖项较多部分需商业许可少较多少适用场景复杂PDF文档简单PDF文档复杂报表简单文档/HTML转PDF学习曲线陡峭平缓陡峭平缓总结选择 iText如果你需要生成复杂的PDF文档尤其是涉及到安全性和高级功能的企业级应用。iText 提供了最全面的功能和最佳的性能但需要注意其商业许可要求。选择 Apache PDFBox如果你希望保持完全开源并且只需要生成简单的PDF文档。PDFBox 轻量级且易于上手适合小型项目或对性能要求不高的场景。选择 JasperReports如果你需要生成复杂的报表特别是涉及到分组、图表、子报表等功能。JasperReports 是一个功能强大且成熟的工具适合企业级应用。选择 Thymeleaf Flying Saucer如果你需要将现有的HTML页面转换为PDF或者只需要生成简单的文档如发票、合同等。它易于使用开发速度快特别适合前端开发人员。在实际项目中建议根据具体需求和技术栈选择合适的工具。如果你不确定哪种工具更适合可以先尝试一个小规模的原型项目评估其性能和易用性再做最终决定。