Java生成PDF報表文件

視頻出處：https://www.bilibili.com/video/BV1Bo4y117zV?p=254

資源文件：鏈接：https://pan.baidu.com/s/1YpIeyK-j6NTZYf0pQkBpVA

提取碼：2333

在企業開發中，除了常見的Excel形式報表，還有PDF形式的報表。那么如何導出PDF形式的報表呢？

1.iText簡介

iText是著名的開放源碼的站點sourceforge一個項目，是用於生成PDF文檔的一個java類庫。通過iText不僅可以生成PDF或rtf的文檔，而且可以將XML、Html文件轉化為PDF文件。

獲取iText：

①下載iText.jar文件后，只需要在系統的CLASSPATH中加入iText.jar的路徑，在程序中就可以使用iText類庫了。

②引入maven坐標來使用iText：

<dependency>
  <groupId>com.lowagie</groupId>
  <artifactId>itext</artifactId>
  <version>2.1.7</version>
</dependency>

示例代碼:

package com.tsccg;

import com.lowagie.text.Document;
import com.lowagie.text.DocumentException;
import com.lowagie.text.Paragraph;
import com.lowagie.text.pdf.PdfWriter;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;

public class ItextDemo {
    public static void main(String[] args) {
        try {
            Document document = new Document();
            PdfWriter.getInstance(document, new FileOutputStream("D:\\Temp\\iTextTest.pdf"));
            document.open();
            document.add(new Paragraph("hello itext"));
            document.close();
        } catch (FileNotFoundException | DocumentException e) {
            e.printStackTrace();
        }
    }
}

iText是一種比較原生的API，當要生成的PDF內容較復雜時，使用起來會很繁瑣。好比jdbc。

如此，便催生了第二種使用起來更為簡便的技術：JasperReports

2.JasperReports

2.1JasperReports簡介

JasperReports底層基於iText。

JasperReports是一個強大、靈活的報表生成工具，能夠展示豐富的頁面內容，並將之轉換成PDF，HTML，或者XML格式。

該庫完全由Java寫成，可以用於在各種Java應用程序，包括J2EE，Web應用程序中生成動態內容。

一般情況下，JasperReports會結合Jaspersoft Studio(模板設計器)使用導出PDF報表。

maven坐標：

<dependency>
  <groupId>net.sf.jasperreports</groupId>
  <artifactId>jasperreports</artifactId>
  <version>6.8.0</version>
</dependency>

2.2入門案例

第一步：創建maven工程，導入JasperReports的maven坐標

<dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports</artifactId>
    <version>6.10.0</version>
    <exclusions>
        <exclusion>
            <groupId>com.lowagie</groupId>
            <artifactId>itext</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>com.lowagie</groupId>
    <artifactId>itext</artifactId>
    <version>2.1.7</version>
</dependency>
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

第二步：將提前准備好的jrxml文件復制到maven工程中(后面會詳細講解如何用工具創建jrxml文件)

demo.jrxml：

<?xml version="1.0" encoding="UTF-8"?>
<!-- Created with Jaspersoft Studio version 6.9.0.final using JasperReports Library version 6.9.0-cb8f9004be492ccc537180b49c026951f4220bf3  -->
<jasperReport xmlns="http://jasperreports.sourceforge.net/jasperreports" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://jasperreports.sourceforge.net/jasperreports http://jasperreports.sourceforge.net/xsd/jasperreport.xsd" name="demo" pageWidth="595" pageHeight="842" columnWidth="555" leftMargin="20" rightMargin="20" topMargin="20" bottomMargin="20" uuid="e3403475-74c8-4358-a0fa-fb5b703b1abe">
   <property name="com.jaspersoft.studio.data.defaultdataadapter" value="One Empty Record"/>
   <parameter name="company" class="java.lang.String"/>
   <parameter name="reportDate" class="java.lang.String"/>
   <queryString>
      <![CDATA[]]>
   </queryString>
   <field name="name" class="java.lang.String"/>
   <field name="address" class="java.lang.String"/>
   <field name="email" class="java.lang.String"/>
   <background>
      <band splitType="Stretch"/>
   </background>
   <title>
      <band height="90" splitType="Stretch">
         <image>
            <reportElement x="0" y="0" width="100" height="86" uuid="1696c855-f322-478c-aecb-12aab31c1743"/>
            <imageExpression><![CDATA["https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fku.90sjimg.com%2Felement_pic%2F00%2F16%2F03%2F7956aed15300f1a.jpg&refer=http%3A%2F%2Fku.90sjimg.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=jpeg?sec=1640964989&t=aa09b2b82b9179dfb00664b1224c37e1"]]></imageExpression>
         </image>
         <staticText>
            <reportElement x="210" y="20" width="200" height="40" uuid="2e246083-05c6-4dbd-9059-f7fe986d139e"/>
            <textElement>
               <font fontName="華文宋體" size="20"/>
            </textElement>
            <text><![CDATA[JasperReports Test]]></text>
         </staticText>
         <textField>
            <reportElement x="468" y="50" width="100" height="30" uuid="14ac6dd3-7c52-457e-95b5-b8c2eebaae1b"/>
            <textFieldExpression><![CDATA[$P{reportDate}]]></textFieldExpression>
         </textField>
      </band>
   </title>
   <detail>
      <band height="37" splitType="Stretch">
         <textField>
            <reportElement x="60" y="4" width="100" height="30" uuid="9fd8ea6a-722d-4c35-a4dc-74f3ed490709"/>
            <textFieldExpression><![CDATA[$F{name}]]></textFieldExpression>
         </textField>
         <textField>
            <reportElement x="227" y="4" width="100" height="30" uuid="d2926cd3-c477-4801-98a6-8d9d7f43adec"/>
            <textFieldExpression><![CDATA[$F{address}]]></textFieldExpression>
         </textField>
         <textField>
            <reportElement x="400" y="4" width="100" height="30" uuid="e7a64e8c-7c91-4c3a-9e1f-f9861353fd79"/>
            <textFieldExpression><![CDATA[$F{email}]]></textFieldExpression>
         </textField>
      </band>
   </detail>
   <pageFooter>
      <band height="37" splitType="Stretch">
         <textField>
            <reportElement x="230" y="5" width="100" height="30" uuid="0eaaff53-787f-4d02-a940-4fd8f249ad95"/>
            <textElement textAlignment="Center"/>
            <textFieldExpression><![CDATA[$P{company}]]></textFieldExpression>
         </textField>
      </band>
   </pageFooter>
</jasperReport>

第三步：編寫測試方法，輸出PDF報表

@Test
public void testJasperReports()throws Exception{
    //要導入的jrxml模板文件路徑
    String jrxmlPath =
        "D:\\code\\自動生成報表\\01-生成PDF\\Project\\pdf-demo\\02-jasperReports-demo\\src\\main\\resources\\demo.jrxml";
    //生成的jasper文件路徑
    String jasperPath =
        "D:\\code\\自動生成報表\\01-生成PDF\\Project\\pdf-demo\\02-jasperReports-demo\\src\\main\\resources\\demo.jasper";

    //編譯模板
    JasperCompileManager.compileReportToFile(jrxmlPath,jasperPath);

    //構造數據
    Map paramters = new HashMap();
    paramters.put("reportDate",new SimpleDateFormat("yyyy-MM-dd").format(new Date()));
    paramters.put("company","tsccg");

    List<Map> list = new ArrayList();

    Map map1 = new HashMap();
    map1.put("name","zhangsan");
    map1.put("address","Beijing");
    map1.put("email","[e-mail]");

    Map map2 = new HashMap();
    map2.put("name","lisi");
    map2.put("address","ShangHai");
    map2.put("email","[e-mail]");

    list.add(map1);
    list.add(map2);

    //填充數據
    JasperPrint jasperPrint = JasperFillManager.fillReport(jasperPath, paramters,
                                                           new JRBeanCollectionDataSource(list));

    //輸出文件
    String pdfPath = "D:\\Temp\\jasperReportsTest.pdf";
    JasperExportManager.exportReportToPdfFile(jasperPrint,pdfPath);
}

2.3原理

• JRXML：報表填充模板，本質是一個xml文件
• Jasper：由JRXML模板編譯成的二進制文件，用於代碼填充數據
• Jrprint：當用數據填充完Jasper后生成的對象，用於輸出報表
• Exporter：報表輸出的管理類，可以指定要輸出的報表為何種格式
• PDF/HTML/XML：報表形式

2.4開發流程

使用JasperReports導出pdf報表，開發流程如下：

1. 制作報表模板
2. 模板編譯
3. 構造數據
4. 填充數據
5. 輸出文件

如果由我們自己編寫報表模板文件會很繁瑣，這時我們就要使用一款模板設計軟件：Jaspersoft Studio，通過該軟件可以很便捷地設計出模板文件。

3.模板設計器Jaspersoft Studio

Jaspersoft Studio是一個圖形化的報表設計工具，可以非常方便的設計出PDF報表模板文件(其實就是一個xml文件)，再結合JasperReports使用，就可以渲染出PDF文件。

下載地址:https://community.jaspersoft.com/community-download

下載完成后會得到如下安裝文件：

直接雙擊安裝即可。

3.1 Jaspersoft Studio面板介紹

3.2 創建工程和模板文件

打開Jaspersoft Studio工具，首先需要創建一個工程，創建過程如下：

創建完工程后，可以在工程上點擊右鍵，創建模板文件：

可以看到創建處理的模板文件后綴為jrxml，從設計區面板可以看到如下效果：

可以看到整個文件是可視化的，分為幾大區域（Title、Page Header、Column Header等），如果某些區域不需要也可以刪除。

在面板左下角可以看到有三種視圖方式：Design（設計模式）、Source（源碼模式）、Preview（預覽模式）:

• 通過Design視圖可以看到模板的直觀結構和樣式
• 通過Source視圖可以看到文件xml源碼
• 通過Preview視圖可以預覽PDF文件輸出后的效果

通過右側Palette窗口可以看到常用的元素：

3.3 設計模板文件

3.3.1 增減Band

可以根據情況刪除或者增加模板文件中的區域（稱為Band），例如在Page Header區域上點擊右鍵，選擇刪除菜單：

其中Detail區域可以添加多個，其他區域只能有一個。

3.3.2 將元素應用到模板中

3.3.2.1 Image元素

從右側Palette面板中選擇Image元素（圖片元素），拖動到Title區域：

彈出如下對話框，有多種創建模式，選擇URL模式，並在下面輸入框中輸入一個網絡圖片的連接地址：

可以選中圖片元素，鼠標拖動調整位置，也可以通過鼠標調整圖片的大小。

調整完成后，可以點擊Preview進入預覽視圖，查看PDF輸出效果：

點擊Source進入源碼視圖，查看xml文件內容：

其實我們上面創建的demo1.jrxml模板文件，本質上就是一個xml文件，只不過我們不需要自己編寫xml文件的內容，而是通過Jaspersoft Studio這個設計器軟件進行可視化設計即可。

3.3.2.2 Static Text元素

Static Text元素就是靜態文本元素，用於在PDF文件上展示靜態文本信息：

雙擊Title面板中的Static Text元素，可以修改文本內容：

選中元素，也可以調整文本的字體和字號：

點擊Preview進入預覽視圖，查看效果：

3.3.2.3 Current Date元素

Current Date元素用於在報表中輸出當前系統日期，將改元素拖動到Title區域：

預覽輸出效果：

默認日期輸出格式如上圖所示，可以回到設計視圖並選中元素，在Properties面板中的Text Field子標簽中修改日期輸出格式：

修改日期格式：

保存文件后重新預覽：

3.3.3 動態數據填充

上面我們在PDF文件中展示的都是一些靜態數據，那么如果需要動態展示一些數據應該如何實現呢？我們可以使用Outline面板中的Parameters和Fields來實現。

Parameters通常用來展示單個數據，Fields通常用來展示需要循環的列表數據。

3.3.3.1 Parameters

在Parameters上點擊右鍵，創建一個Parameter參數：

可以在右側的Properties面板中修改剛才創建的參數名稱：

將剛才創建的Parameter參數拖動到面板中：

進入預覽視圖，查看效果：

由於模板中我們使用了Parameter動態元素，所以在預覽之前需要為其動態賦值：

注意：由於我們是在Jaspersoft Studio軟件中進行預覽，所以需要通過上面的輸入框動態為Parameter賦值，在后期項目使用時，需要我們在Java程序中動態為Parameter賦值進行數據填充。

3.3.3.2 Fields

使用Fields方式進行數據填充，既可以使用jdbc數據源方式也可以使用JavaBean數據源方式。

• jdbc數據源數據填充

第一步：在Repository Explorer面板中，在Data Adapters點擊右鍵，創建一個數據適配器

第二步：選擇Database JDBC Connection

第三步：選擇mysql數據庫，並完善jdbc連接信息

為了能夠在Jaspersoft Studio中預覽到數據庫中的數據，需要加入MySQL的驅動包

第四步：在Outline視圖中，右鍵點擊工程名，選擇Database and Query菜單

第五步：在彈出的對話框中選擇剛剛創建的JDBC數據庫連接選項

第六步：在彈出對話框中Language選擇sql，在右側區域輸入SQL語句並點擊Read Fields按鈕

可以看到通過點擊上面的Read Fields按鈕，已經讀取到了t_setmeal表中的所有字段信息並展示在了下面，這些字段可以根據需要進行刪除或者調整位置

第七步：在Outline視圖中的Fields下可以看到t_setmeal表中相關字段信息，拖動某個字段到設計區的Detail區域並調整位置

可以看到，在拖動Fields到設計區時，同時會產生兩個元素，一個是靜態文本，一個是動態元素。靜態文本相當於表格的表頭，可以根據需要修改文本內容。最終設計完的效果如下：

第八步：使用Preview預覽視圖進行預覽

通過上圖可以看到，雖然列表數據展示出來了，但是展示的還存在問題。在每條數據遍歷時表頭也跟着遍歷了一遍。這是怎么回事呢？這是由於我們設計的表頭和動態Fields都在Detail區域。為了能夠解決上面的問題，需要將表頭放在Column Header區域，將動態Fields放在Detail區域。具體操作如下：

1、在Outline視圖的Column Header點擊右鍵創建出一個區域

2、將Detail下的靜態文本拖動到Column Header下

拖動完成后如下：

3、調整靜態文本在Column Header區域的位置，最終效果如下

4、預覽查看效果

• JavaBean數據源數據填充

第一步：復制上面的demo1.jrxml文件，名稱改為demo2.jrxml

修改Report Name：

第二步：打開demo2.jrxml文件，將detail區域中的動態Fields元素刪除

第三步：將Outline面板中Fields下的字段全部刪除

第四步：清除JDBC數據源和相關SQL語句

第五步：在Fields處點擊右鍵創建新的Field

創建完成后在Properties屬性面板中修改Field的名稱

第六步：將創建的Fields拖動到Detail區域並調整好位置

注意：使用此種JavaBean數據源數據填充方式，無法正常進行預覽，因為這些動態Fields需要在Java程序中動態進行數據填充。

3.3.4添加邊框

3.4 結合JasperReports輸出報表

前面我們已經使用Jaspersoft Studio設計了兩個模板文件：demo1.jrxml和demo2.jrxml。其中demo1.jrxml的動態列表數據是基於JDBC數據源方式進行數據填充，demo2.jrxml的動態列表數據是基於JavaBean數據源方式進行數據填充。本小節我們就結合JasperReports的Java API來完成pdf報表輸出。

3.4.1 JDBC數據源方式填充數據

第一步：創建maven工程，導入相關maven坐標

<dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports</artifactId>
    <version>6.10.0</version>
    <exclusions>
        <exclusion>
            <groupId>com.lowagie</groupId>
            <artifactId>itext</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>com.lowagie</groupId>
    <artifactId>itext</artifactId>
    <version>2.1.7</version>
</dependency>
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
</dependency>

第二步：將設計好的demo1.jrxml文件復制到當前工程的resources目錄下

第三步：編寫單元測試

@Test
public void testReport_JDBC() throws Exception{
    Class.forName("com.mysql.jdbc.Driver");
    Connection connection = 
        DriverManager.getConnection("jdbc:mysql://localhost:3306/health", 
                                    "root", 
                                    "root");

    String jrxmlPath = "D:\\ideaProjects\\projects111\\jasperreports_test\\src\\main\\resources\\demo1.jrxml";
    String jasperPath = "D:\\ideaProjects\\projects111\\jasperreports_test\\src\\main\\resources\\demo1.jasper";

    //編譯模板
    JasperCompileManager.compileReportToFile(jrxmlPath,jasperPath);

    //構造數據
    Map paramters = new HashMap();
    paramters.put("company","傳智播客");

    //填充數據---使用JDBC數據源方式填充
    JasperPrint jasperPrint = 
        JasperFillManager.fillReport(jasperPath, 
                                    paramters, 
                                    connection);
    //輸出文件
    String pdfPath = "D:\\test.pdf";
    JasperExportManager.exportReportToPdfFile(jasperPrint,pdfPath);
}

通過上面的操作步驟可以輸出pdf文件，但是中文的地方無法正常顯示。這是因為JasperReports默認情況下對中文支持並不友好，需要我們自己進行修復。具體操作步驟如下：

1、在Jaspersoft Studio中打開demo1.jrxml文件，選中中文相關元素，統一將字體設置為“華文宋體”並將修改后的demo1.jrxml重新復制到maven工程中

2、將本章資源/解決中文無法顯示問題目錄下的文件復制到maven工程的resources目錄中

按照上面步驟操作后重新執行單元測試導出PDF文件：

3.4.2 JavaBean數據源方式填充數據

第一步：為了能夠避免中文無法顯示問題，首先需要將demo2.jrxml文件相關元素字體改為“華文宋體”並將demo2.jrxml文件復制到maven工程的resources目錄下

第二步：編寫單元測試方法輸出PDF文件

@Test
public void testReport_JavaBean() throws Exception{
    String jrxmlPath = "D:\\ideaProjects\\projects111\\jasperreports_test\\src\\main\\resources\\demo2.jrxml";
    String jasperPath = "D:\\ideaProjects\\projects111\\jasperreports_test\\src\\main\\resources\\demo2.jasper";

    //編譯模板
    JasperCompileManager.compileReportToFile(jrxmlPath,jasperPath);

    //構造數據
    Map paramters = new HashMap();
    paramters.put("company","傳智播客");

    List<Map> list = new ArrayList();
    Map map1 = new HashMap();
    map1.put("tName","入職體檢套餐");
    map1.put("tCode","RZTJ");
    map1.put("tAge","18-60");
    map1.put("tPrice","500");

    Map map2 = new HashMap();
    map2.put("tName","陽光爸媽老年健康體檢");
    map2.put("tCode","YGBM");
    map2.put("tAge","55-60");
    map2.put("tPrice","500");
    list.add(map1);
    list.add(map2);

    //填充數據---使用JavaBean數據源方式填充
    JasperPrint jasperPrint = 
        JasperFillManager.fillReport(jasperPath, 
                                     paramters, 
                                     new JRBeanCollectionDataSource(list));
    //輸出文件
    String pdfPath = "D:\\test.pdf";
    JasperExportManager.exportReportToPdfFile(jasperPrint,pdfPath);
}

查看輸出效果：