SpringBoot+Thymeleaf實現生成PDF檔案

2022-09-16 22:04:01

前言

溫馨提示：本部落格使用Thymeleaf模板引擎實現PDF列印僅供參考：

在閱讀該部落格之前，先要了解一下Thymeleaf模板引擎，因為是使用Thymeleaf模板引擎實現的PDF列印的，

Thymeleaf是一個現代的伺服器端 Java 模板引擎，適用於 Web 和獨立環境。

Thymeleaf 的主要目標是為您的開發工作流程帶來優雅的自然模板——HTML可以在瀏覽器中正確顯示，也可以用作靜態原型，從而在開發團隊中實現更強大的共同作業。

藉助 Spring Framework 的模組、與您最喜歡的工具的大量整合以及插入您自己的功能的能力，Thymeleaf 是現代 HTML5 JVM Web 開發的理想選擇——儘管它可以做的更多。

不瞭解小夥伴可以去Thymeleaf官網檢視，有更詳細的講解。

接下來就不一一介紹了，直接上程式碼。

一、引入依賴

1.Thymeleaf，生成PDF相關依賴

1.1 以下依賴為必要依賴，一個都不能少，依賴version可以根基實際情況使用相關的依賴版本。

二、application.yml設定

1.yml組態檔

yml組態檔使用設定thymeleaf模板路徑（範例）：

以上相關為基礎且必須設定的內容，接下來繼續講解thymeleaf引擎需要生成PDF的相關設定。

三、PDF相關設定

1.PDF設定程式碼（如下）：

package com.cy.xgsm.configuration;

import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;

import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.itextpdf.html2pdf.ConverterProperties;
import com.itextpdf.html2pdf.resolver.font.DefaultFontProvider;
import com.itextpdf.io.font.PdfEncodings;
import com.itextpdf.kernel.font.PdfFont;
import com.itextpdf.kernel.font.PdfFontFactory;
import com.itextpdf.layout.font.FontProvider;
import com.cy.xgsm.controller.PrintPdfController;

/**
 * 
 * @author Dylan
 * PDF相關設定
 */
@Configuration
public class PdfConfiguration {
	
	private static final Logger log = LoggerFactory.getLogger(PdfConfiguration.class);
	
	@Bean
	public FontProvider getFontProvider() throws URISyntaxException, IOException {
		FontProvider provider = new DefaultFontProvider(true, true, false);
		byte[] bs = null;
		//SIMSUN.TTC為字型
		try (InputStream in = PrintPdfController.class.getClassLoader().getResourceAsStream("font/SIMSUN.TTC")) {
			bs = IOUtils.toByteArray(in);
		}		
		PdfFont pdfFont = PdfFontFactory.createTtcFont(bs, 1, PdfEncodings.IDENTITY_H, false, true);
		provider.addFont(pdfFont.getFontProgram());
		return provider;
	}
	
	@Bean
	public ConverterProperties converterProperties(FontProvider fontProvider, Configuration config) {
		ConverterProperties cp = new ConverterProperties();
		cp.setBaseUri(config.getPdfUrl());
		try {
			cp.setFontProvider(fontProvider);
		} catch (Exception e) {
			log.error("列印PDF時未能新增字型", e);
		}
		return cp;
	}
	
}

注意PDF設定需要新增列印PDF字型，SIMSUN.TTC為列印需要的字型，但是也可以是其他的

四、Controller

1.以上所有的相關設定資訊都設定完了，接下來就可以寫Api介面了

package com.cy.xgsm.controller;

import java.io.IOException;
import java.io.OutputStream;
import java.net.URLEncoder;

import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;

import com.itextpdf.html2pdf.ConverterProperties;
import com.itextpdf.html2pdf.HtmlConverter;
import com.itextpdf.kernel.geom.PageSize;
import com.itextpdf.kernel.pdf.PdfDocument;
import com.itextpdf.kernel.pdf.PdfWriter;
import com.cy.xgsm.common.Result;
import com.cy.xgsm.model.OrderInfo;
import com.cy.xgsm.service.OrderInfoService;

/**
 * 列印PDF 控制接入層
 * 
 * @author Dylan
 *
 */
@Controller
@RequestMapping("print")
public class PrintPdfController {
	
    private static final Logger log = LoggerFactory.getLogger(PrintPdfController.class);
    
	@Autowired
	private OrderInfoService service;
	//thymeleaf模板引擎
    @Autowired
    TemplateEngine templateEngine;
	//html轉換成pdf需要使用ConverterProperties
    @Autowired
    ConverterProperties converterProperties;    
	
    @GetMapping("order/{orderId}.pdf")
	public void orderPdf(@PathVariable Long orderId, HttpServletResponse resp) throws IOException {
		Result<OrderInfo> result = service.selectByPrimaryKey(orderId);
		if (!result.isComplete()) {
            resp.sendError(404, "訂單ID不存在");
        }
        Context context = new Context();
        context.setVariable("order", result.getData());
		///html/pdf/order-template為列印模板紙張路徑
        processPdf(context, "/html/pdf/order-template", result.getData().getKddh(), resp);
		
	}

	/**
	 * 呼叫生成PDF
	 * @param context 上下文
	 * @param template 模板檔案
	 * @param filename 檔名
	 * @param resp
	 */
	private void processPdf(Context context, String template, String filename, HttpServletResponse resp) throws IOException {
        log.info("生成PDF：" + filename);
        String html = templateEngine.process(template, context);
        String filenameEncoded = URLEncoder.encode(filename, "utf-8");
        resp.setContentType("application/pdf");
        resp.setHeader("Content-Disposition", "filename=" + filenameEncoded + ".pdf");
        try (OutputStream out = resp.getOutputStream()) {
            PdfDocument doc = new PdfDocument(new PdfWriter(out));
			//列印使用什麼什麼紙張可根據實際情況，我這裡預設使用A4
            doc.setDefaultPageSize(PageSize.A4.rotate());
            HtmlConverter.convertToPdf(html, doc, converterProperties);
        }
		
	}

}

1.請求介面報錯解決方式：

如果在請求介面的時候發生以下錯誤資訊是列印模板的路徑錯誤了。