JasperReports - 編譯報表設計

上一頁
下一頁

我們在上一章節生成了 JasperReport 模板（JRXML 檔案）。此檔案不能直接用於生成報表。它必須編譯成 JasperReport 的原生二進位制格式，稱為 **Jasper** 檔案。編譯時，我們將 JasperDesign 物件轉換為 JasperReport 物件：

Jasper Report Compiling

介面 net.sf.jasperreports.engine.design.JRCompiler 在編譯過程中起著核心作用。此介面有多個實現，具體取決於報表表示式使用的語言，報表表示式可以用 Java、Groovy、JavaScript 或任何其他指令碼語言編寫，只要編譯器實現能夠在執行時對其進行評估。

我們可以透過以下兩種方式編譯 JRXML 檔案：

  • 程式設計編譯。
  • 透過 ANT 任務編譯。

JRXML 的程式設計編譯

JasperReports API 提供了一個外觀類 net.sf.jasperreports.engine.JasperCompileManager 用於編譯 JasperReport。此類包含多個公共靜態方法，用於編譯報表模板。模板的來源可以是檔案、輸入流和/或記憶體物件。

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>

以下程式碼演示瞭如何編譯上述 jasper_report_template.jrxml 檔案。

package com.tutorialspoint;

import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JasperCompileManager;

public class JasperReportCompile {

   public static void main(String[] args) {
      String sourceFileName = "C://tools/jasperreports-5.0.1/test" + 
         "/jasper_report_template.jrxml";

      System.out.println("Compiling Report Design ...");
      try {
          /**
          * Compile the report to a file name same as
          * the JRXML file name
          */
         JasperCompileManager.compileReportToFile(sourceFileName);
      } catch (JRException e) {
         e.printStackTrace();
      }
      System.out.println("Done compiling!!! ...");
   }
}

模板編譯

下一步，讓我們將上述內容儲存到檔案 **C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\JasperReportCompile.java** 中，並在 build.xml 檔案中匯入 baseBuild.xml，如下所示。baseBuild.xml 已經包含了 **compile** 和 **run** 目標：

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

   <import file = "baseBuild.xml"/>

</project>

接下來，讓我們開啟命令列視窗，並轉到放置 build.xml 的目錄。最後，執行命令 **ant -Dmain-class=com.tutorialspoint.JasperReportCompile**，如下所示：

C:\tools\jasperreports-5.0.1\test>ant -Dmain-class = com.tutorialspoint.JasperReportCompile
Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml
compile:
   [javac] C:\tools\jasperreports-5.0.1\test\baseBuild.xml:27:
   warning: 'includeantruntime' was not set, defaulting to
   build.sysclasspath=last;set to false for repeatable builds
   [javac] Compiling 1 source file to C:\tools\jasperreports-5.0.1\test\classes

run:
   [echo] Runnin class : com.tutorialspoint.JasperReportCompile
   [java] Compiling Report Design ...
   [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.
   [java] Done compiling!!! ...

BUILD SUCCESSFUL
Total time: 8 seconds

上述編譯的結果是，您將看到模板檔案 jasper_report_template.jasper 已在 C:\tools\jasperreports-5.0.1\test 目錄中生成。

預覽已編譯的報表模板

net.sf.jasperreports.view.JasperDesignViewer 可用於預覽已編譯的報表模板和 JRXML 模板。

為了進一步操作，讓我們向上面的 build.xml 檔案新增一個新的目標 **viewDesign**，這將允許我們預覽已編譯的報表。以下是修改後的 build.xml：

匯入檔案 - baseBuild.xml 來自章節 環境設定，應將其放置在與 build.xml 相同的目錄中。

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

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

</project>

讓我們在命令提示符下執行命令 - **ant** (viewDesign 是預設目標)。JasperDesignViewer 視窗將開啟，顯示如下所示的 Jasper 檔案：

Jasper Design Viewer

透過 ANT 任務編譯

由於報表模板編譯更像是一個設計時作業而不是執行時作業，因此 JasperReport 庫具有一個自定義 ANT 任務。在某些情況下，當 JRXML 檔案在執行時建立時，我們不能使用此 ANT 任務。自定義 ANT 任務稱為 JRC，由類 net.sf.jasperreports.ant.JRAntCompileTask 實現。其語法和行為與內建的 **<javac>** ANT 任務非常相似。

模板編譯

讓我們向現有的 build.xml 新增新的目標 **compilereportdesing**。在這裡，原始檔夾使用巢狀的 <src> 標記和檔案集指定。巢狀的 source 標記允許編譯散佈在許多不同位置且未分組在單個根報表原始檔夾下的報表模板。以下是修改後的 build.xml：

<?xml version = "1.0" encoding = "UTF-8"?>
<project name = "JasperReportTest" default = "compilereportdesing" basedir = ".">
   
   <import file = "baseBuild.xml" />
   <target name = "viewDesign" description = "Design viewer is 
      launched to preview the compiled report design.">
      
      <java classname = "net.sf.jasperreports.view.JasperDesignViewer" fork = "true">
         <arg value = "-F${file.name}.jasper" />
         <classpath refid = "classpath" />
      </java>
		
   </target>

   <target name = "compilereportdesing" description = "Compiles the 
      JXML file and produces the .jasper file.">
		
      <taskdef name = "jrc" classname = "net.sf.jasperreports.ant.JRAntCompileTask">
         <classpath refid = "classpath" />
      </taskdef>
      
      <jrc destdir = ".">
         <src>
            <fileset dir = ".">
               <include name = "*.jrxml" />
            </fileset>
         </src>
         <classpath refid = "classpath" />
      </jrc>
   </target>

</project>

接下來，讓我們開啟命令提示符並轉到放置 build.xml 的目錄。執行命令 **ant** (compilereportdesing 是預設目標)；輸出如下所示：

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

compilereportdesing:
   [jrc] Compiling 1 report design files.
   [jrc] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.engine.xml.JRXmlDigesterFactory).
   [jrc] log4j:WARN Please initialize the log4j system properly.
   [jrc] log4j:WARN See
   http://logging.apache.org/log4j/1.2/faq.html#noconfig
   for more info.
   [jrc] File :
   C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrxml ... OK.

BUILD SUCCESSFUL
Total time: 5 seconds

檔案 jasper_report_template.jasper 在檔案系統中生成（在本例中為 C:\tools\jasperreports-5.0.1\test 目錄）。此檔案與透過呼叫 net.sf.jasperreports.engine.JasperCompileManager.compileReportToFile() 以程式設計方式生成的檔案相同。我們可以預覽此 jasper 檔案，執行 **ant viewDesign**。

列印頁面
上一頁
下一頁
廣告