PDF 和 Excel

Spring提供了一些方法来返回除HTML之外的其他输出,包括PDF和Excel电子表格。本节介绍如何使用这些功能。

文档视图简介

HTML页面并非始终是用户查看模型输出的最佳方式,Spring使您可以轻松地从模型数据动态生成PDF文档或Excel电子表格。文档是视图,并以正确的内容类型从服务器流式传输,以(希望)使客户端PC能够响应地运行其电子表格或PDF查看器应用程序。

为了使用Excel视图,您需要将Apache POI库添加到您的类路径中。对于PDF生成,您需要添加(最好是)OpenPDF库。

如果可能,您应该使用底层文档生成库的最新版本。特别是,我们强烈建议使用OpenPDF(例如,OpenPDF 1.2.12)而不是过时的原始iText 2.1.7,因为OpenPDF得到积极维护并修复了不受信任的PDF内容的重要漏洞。

PDF视图

一个简单的单词列表的PDF视图可以扩展org.springframework.web.servlet.view.document.AbstractPdfView并实现buildPdfDocument()方法,如下例所示

  • Java

  • Kotlin

public class PdfWordList extends AbstractPdfView {

	protected void buildPdfDocument(Map<String, Object> model, Document doc, PdfWriter writer,
			HttpServletRequest request, HttpServletResponse response) throws Exception {

		List<String> words = (List<String>) model.get("wordList");
		for (String word : words) {
			doc.add(new Paragraph(word));
		}
	}
}
class PdfWordList : AbstractPdfView() {

	override fun buildPdfDocument(model: Map<String, Any>, doc: Document, writer: PdfWriter,
			request: HttpServletRequest, response: HttpServletResponse) {

		val words = model["wordList"] as List<String>
		for (word in words) {
			doc.add(Paragraph(word))
		}
	}
}

控制器可以从外部视图定义(按名称引用)或作为处理程序方法中的View实例返回此类视图。

Excel视图

从Spring Framework 4.2开始,org.springframework.web.servlet.view.document.AbstractXlsView作为Excel视图的基类提供。它基于Apache POI,具有专门的子类(AbstractXlsxViewAbstractXlsxStreamingView),这些子类取代了过时的AbstractExcelView类。

编程模型类似于AbstractPdfView,其中buildExcelDocument()作为中央模板方法,控制器能够从外部定义(按名称)或作为处理程序方法中的View实例返回此类视图。