Java項目導出數(shù)據(jù)為 PDF 文件的操作代碼

更新時間：2022年12月02日 09:59:58 作者：libin9iOak

一個小需求，需要將頁面上的數(shù)據(jù)導出為PDF，正常情況下這個需求需要讓前端來做，但是現(xiàn)在上面讓咱們后端來做，也沒問題，這篇文章主要介紹了Java項目導出數(shù)據(jù)為 PDF 文件的操作代碼,需要的朋友可以參考下

Java項目如何導出數(shù)據(jù)為 PDF 文件？

一個小需求，需要將頁面上的數(shù)據(jù)導出為PDF，正常情況下這個需求需要讓前端來做，但是現(xiàn)在上面讓咱們后端來做，也沒問題。

直接上代碼

一、代碼結(jié)構(gòu)如下

二、代碼說明

1、添加依賴 pom.xml

<dependency>
    <groupId>com.openhtmltopdf</groupId>
    <artifactId>openhtmltopdf-core</artifactId>
    <version>1.0.0</version>
</dependency>
<dependency>
    <groupId>com.openhtmltopdf</groupId>
    <artifactId>openhtmltopdf-pdfbox</artifactId>
    <version>1.0.0</version>
</dependency>
<dependency>
    <groupId>org.thymeleaf</groupId>
    <artifactId>thymeleaf</artifactId>
    <version>3.0.11.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.thymeleaf</groupId>
    <artifactId>thymeleaf-spring5</artifactId>
    <version>3.0.11.RELEASE</version>
</dependency>

2、HTML模板文件 audit_order_record.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org" lang="en">
<head>
    <meta charset="UTF-8"/>
    <title th:text="${pdfFileName}"></title>
    <style>
        @page {
            size: A4;
            @top-center {
                content: element(header);
            }
            @bottom-center {
                content: '';
                font-family: 'stxihei', serif;
            }
        }
        html, body {
            font-family: 'stxihei', serif;
        }
        table {
            -fs-table-paginate: paginate;
            border-collapse: collapse;
        }
        #page-header {
            position: running(header);
            border-bottom: 1px solid #555;
            padding: 5px;
        }
        #page-header-text {
            font-size: 16px;
        }
        #page-header-num:after {
            float: right;
            text-align: right;
            content: counter(page) '/' counter(pages);
        }
        table {
            width: 100%;
            margin: auto 0;
        }
        table, td, th {
            border: 1px solid #555;
            padding: 10px;
            text-align: center;
        }
        th {
            background-color: #eff3fa;
            width: 200px;
        }
</style>
</head>
<body>
<div id="page-header">
    <span id="page-header-text">審批記錄</span>
    <span id="page-header-num"></span>
</div>

<table>
    <tr>
        <th colspan="2">資源信息</th>
    </tr>
    <tr>
        <th>目錄名稱</th>
        <td>[[${resourceName}]]</td>
    </tr>
    <tr>
        <th>資源名稱</th>
        <td>[[${infoName}]]</td>
    </tr>
    <tr>
        <th>資源類型</th>
        <td>[[${resourceType}]]</td>
    </tr>
    <tr>
        <th>數(shù)據(jù)提供方</th>
        <td>[[${resOrgName}]]</td>
    </tr>
    <tr>
        <th colspan="2">訂閱信息</th>
    </tr>
    <tr>
        <th>資源需求方</th>
        <td>[[${orgName}]]</td>
    </tr>
    <tr>
        <th>需求方系統(tǒng)</th>
        <td>[[${systemName}]]</td>
    </tr>
    <tr>
        <th>聯(lián)系人</th>
        <td>[[${linkMan}]]</td>
    </tr>
    <tr>
        <th>聯(lián)系手機</th>
        <td>[[${linkPhone}]]</td>
    </tr>
    <tr>
        <th>申請日期</th>
        <td>[[${orderDate}]]</td>
    </tr>
    <tr>
        <th>申請理由</th>
        <td>[[${orderReason}]]</td>
    </tr>
    <tr>
        <th colspan="2">審核信息</th>
    </tr>
    <tr>
        <th>審核人</th>
        <td>[[${prejuUserName}]]</td>
    </tr>
    <tr>
        <th>審核結(jié)果</th>
        <td>[[${prejuResult}]]</td>
    </tr>
    <tr>
        <th>審核日期</th>
        <td>[[${prejuDate}]]</td>
    </tr>
    <tr>
        <th>審核意見</th>
        <td>[[${prejuSuggest}]]</td>
    </tr>
</table>
</body>
</html>

3、添加字體

將字體文件 STXIHEI.TTF 放在 pdf/fonts 下面

4、PDF 導出工具類

package com.libin.pdf.demo.util;

import com.openhtmltopdf.pdfboxout.PdfRendererBuilder;
import org.springframework.util.ResourceUtils;
import org.thymeleaf.context.Context;
import org.thymeleaf.spring5.SpringTemplateEngine;
import org.thymeleaf.templateresolver.ClassLoaderTemplateResolver;
import org.thymeleaf.templateresolver.FileTemplateResolver;

import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.OutputStream;
import java.util.Map;

public class PdfUtil {

    /**
     * @param response     http請求后的相應
     * @param pdfFileName  pdf文件名稱(不包含pdf后綴)
     * @param templateName 模板名稱
     * @param variables    模板變量
     */
    public static void exportPdf(HttpServletResponse response, String pdfFileName, String templateName, Map<String, Object> variables) throws Exception {
        response.setContentType("application/pdf");
        response.setHeader("Content-Disposition", "attachment;filename=" + new String((pdfFileName + ".pdf").getBytes(), "iso8859-1"));
        OutputStream os = response.getOutputStream();
        //構(gòu)造模板引擎
        ClassLoaderTemplateResolver resolver = new ClassLoaderTemplateResolver();
        resolver.setPrefix("pdf/templates/"); //模板所在目錄，相對于當前classloader的classpath。
        resolver.setSuffix(".html"); //模板文件后綴
//        FileTemplateResolver resolver = new FileTemplateResolver();
//        resolver.setPrefix(ServletActionContext.getServletContext().getRealPath("pdf/templates") + File.separator); // 如果放在web下
//        resolver.setSuffix(".html");

        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(resolver);
        //構(gòu)造上下文(Model)
        Context context = new Context();
        context.setVariable("pdfFileName", pdfFileName);
        context.setVariables(variables);
        //渲染模板
        String example = templateEngine.process(templateName, context);
        PdfRendererBuilder builder = new PdfRendererBuilder();
        //設置字體文件
        builder.useFont(ResourceUtils.getFile("classpath:pdf/fonts/SIMHEI.TTF"), "stxihei");
//        builder.useFont(new File(ServletActionContext.getServletContext().getRealPath("/pdf/fonts/SIMHEI.TTF")), "stxihei"); // 如果是放在web下面
        builder.useFastMode();
        builder.withHtmlContent(example, null);
        builder.toStream(os);
        builder.run();
    }
}

5、導出接口

 package com.libin.pdf.demo.controller;

import com.libin.pdf.demo.util.PdfUtil;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
import java.util.Map;

@RestController
public class DemoController {

    @GetMapping("pdf")
    public void test(HttpServletResponse response) throws Exception {
        Map<String, Object> variables = new HashMap<>();
        // 資源信息
        // 資源名稱
        variables.put("resourceName", "XXXXXXXXXX");
        // 目錄名稱
        variables.put("infoName", "XXXXXXXXXX");
        //資源類型
        variables.put("resourceType", "XXXXXXXXXX");
        // 數(shù)據(jù)提供方
        variables.put("resOrgName", "XXXXXXXXXX");

        // 資源需求方
        variables.put("orgName", "XXXXXXXXXX");
        // 需求方系統(tǒng)
        variables.put("systemName", "XXXXXXXXXX");
        // 聯(lián)系人
        variables.put("linkMan", "XXXXXXXXXX");
        // 聯(lián)系手機
        variables.put("linkPhone", "XXXXXXXXXX");
        // 申請日期
        variables.put("orderDate", "XXXXXXXXXX");
        // 申請理由
        variables.put("orderReason", "XXXXXXXXXX");

        // 審核人
        variables.put("prejuUserName", "XXXXXXXXXX");
        // 審核結(jié)果
        variables.put("prejuResult", "XXXXXXXXXX");
        // 審核日期
        variables.put("prejuDate", "XXXXXXXXXX");
        // 審核意見
        variables.put("prejuSuggest", "XXXXXXXXXX");

        PdfUtil.exportPdf(response, "審批記錄", "audit_order_record.html", variables);
    }
}