JasperReports - 設計

JasperReport 中的 JRXML 模板（或 JRXML 檔案）是標準的 XML 檔案，副檔名為 .jrxml。所有 JRXML 檔案都包含標籤 <jasperReport> 作為根元素。它又包含許多子元素（所有這些都是可選的）。JasperReport 框架可以處理不同型別的資料來源。在本教程中，我們將演示如何僅透過將 Java 資料物件（使用 Java bean）的集合傳遞給 JasperReport 引擎來生成基本報表。最終報表將顯示人員列表，其中包含其姓名和國家/地區等類別。

本章介紹以下步驟，以說明如何設計 JasperReport：

建立 JRXML 報表模板。
預覽 XML 報表模板。

建立 JRXML 報表模板

建立 JRXML 檔案，即使用文字編輯器建立名為 jasper_report_template.jrxml 的檔案，並根據我們的環境設定將其儲存在 C:\tools\jasperreports-5.0.1\test 中。

<?xml version = "1.0" encoding = "UTF-8"?>
<!DOCTYPE jasperReport PUBLIC "//JasperReports//DTD Report Design//EN"
   "http://jasperreports.sourceforge.net/dtds/jasperreport.dtd">

<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 = "jasper_report_template" language = "groovy" pageWidth = "595"
   pageHeight = "842" columnWidth = "555" leftMargin = "20" rightMargin = "20"
   topMargin = "20" bottomMargin = "20">
  
   <queryString>
      <![CDATA[]]>
   </queryString>
   
   <field name = "country" class = "java.lang.String">
      <fieldDescription><![CDATA[country]]></fieldDescription>
   </field>
	
   <field name = "name" class = "java.lang.String">
      <fieldDescription><![CDATA[name]]></fieldDescription>
   </field>
	
   <columnHeader>
      <band height = "23">
         
         <staticText>
            <reportElement mode = "Opaque" x = "0" y = "3" width = "535" 
               height = "15" backcolor = "#70A9A9" />
            
            <box>
               <bottomPen lineWidth = "1.0" lineColor = "#CCCCCC" />
            </box>
            
            <textElement />
            <text><![CDATA[]]> </text>
         </staticText>
			
         <staticText>
            <reportElement x = "414" y = "3" width = "121" height = "15" />
            
            <textElement textAlignment = "Center" verticalAlignment = "Middle">
               <font isBold = "true" />
            </textElement>
            
            <text><![CDATA[Country]]></text>
         </staticText>
         
         <staticText>
            <reportElement x = "0" y = "3" width = "136" height = "15" />
            
            <textElement textAlignment = "Center" verticalAlignment = "Middle">
               <font isBold = "true" />
            </textElement>
            
            <text><![CDATA[Name]]></text>
         </staticText>
  
      </band>
   </columnHeader>
 
    <detail>
      <band height = "16">
         
         <staticText>
            <reportElement mode = "Opaque" x = "0" y = "0" width = "535" 
               height = "14" backcolor = "#E5ECF9" />
            
            <box>
               <bottomPen lineWidth = "0.25" lineColor = "#CCCCCC" />
            </box>
            
            <textElement />
            <text><![CDATA[]]> </text>
         </staticText>
			
         <textField>
            <reportElement x = "414" y = "0" width = "121" height = "15" />
            
            <textElement textAlignment = "Center" verticalAlignment = "Middle">
               <font size = "9" />
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{country}]]>
            </textFieldExpression>
         </textField>
         
         <textField>
            <reportElement x = "0" y = "0" width = "136" height = "15" />
            <textElement textAlignment = "Center" verticalAlignment = "Middle" />
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$F{name}]]>
            </textFieldExpression>
         </textField>

      </band>
   </detail>
	
</jasperReport>

以下是上述報表模板中主要欄位的詳細資訊：

<queryString> - 此處為空（因為我們透過 Java Bean 傳遞資料）。通常包含檢索報表結果的 SQL 語句。
<field name> - 此元素用於將資料從資料來源或查詢對映到報表模板。name 在報表主體中重複使用，並且區分大小寫。
<fieldDescription> - 此元素將欄位名稱與 XML 檔案中的相應元素對映。
<staticText> - 這定義了不依賴於任何資料來源、變數、引數或報表表示式的靜態文字。
<textFieldExpression> - 這定義了結果欄位的外觀。
$F{country} - 這是一個變數，包含結果的值，即標籤 <field name> 中預定義的欄位。
<band> - 頻段包含顯示在報表中的資料。

報表設計完成後，將其儲存在 C:\ 目錄中。

預覽 XML 報表模板

JasperReports JAR 檔案中提供了一個實用程式 net.sf.jasperreports.view.JasperDesignViewer，它有助於預覽報表設計，而無需編譯或填充它。此實用程式是一個獨立的 Java 應用程式，因此可以使用 ANT 執行。

讓我們編寫一個 ANT 目標 viewDesignXML 來檢視 JRXML。因此，讓我們在 C:\tools\jasperreports-5.0.1\test 目錄下建立並儲存 build.xml（應放置在與 JRXML 相同的目錄中）。以下是 build.xml 檔案：

<?xml version = "1.0" encoding = "UTF-8"?>
<project name = "JasperReportTest" default = "viewDesignXML" basedir = ".">

   <import file = "baseBuild.xml" />
   <target name = "viewDesignXML" description = "Design viewer is 
      launched to preview the JXML report design.">
      
      <java classname = "net.sf.jasperreports.view.JasperDesignViewer" fork = "true">
         <arg value = "-XML" />
         <arg value = "-F${file.name}.jrxml" />
         <classpath refid = "classpath" />
      </java>
   </target>

</project>

接下來，讓我們開啟命令提示符並轉到放置 build.xml 的目錄。執行命令 ant（因為 viewDesignXML 是預設目標）。輸出如下：

C:\tools\jasperreports-5.0.1\test>ant
Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml

viewDesignXML:
[java] log4j:WARN No appenders could be found for logger
(net.sf.jasperreports.engine.xml.JRXmlDigesterFactory).
[java] log4j:WARN Please initialize the log4j system properly.

可以忽略 Log4j 警告，並且作為上述執行的結果，將開啟一個標有“JasperDesignViewer”的視窗，顯示我們的報表模板預覽。

如我們所見，僅顯示了獲取資料的報表表示式，因為 JasperDesignViewer 無法訪問實際資料來源或報表引數。透過關閉視窗或在命令列視窗中按 Ctrl-c 來終止 JasperDesignViewer。

列印頁面