JasperReport編譯報表設計


我們在前面的章節中產生的JasperReport模板(JRXML檔案)。這個檔案不能直接用於生成報告。它必須被編譯成JasperReport的“本地二進位制"格式,稱為Jasperfile。在編制我們把JasperDesign物件轉換成JasperReport的物件:

Jasper Report Compiling

介面net.sf.jasperreports.engine.design.JRCompiler編譯過程中起著核心的一部分。這個介面有根據用於報表表示式語言,它可以只要編譯器可以實現在執行時計算它被用Java編寫的,Groovy,JavaScript的或任何其他指令碼語言的幾個實現。我們可以通過以下兩種方式編譯JRXML檔案:

  1. 提供程式設計編譯。

  2. 編譯通過ANT任務。

JRXML提供程式設計編譯

JasperReports的API提供了一個門面類net.sf.jasperreports.engine.JasperCompileManager用於編譯JasperReport。這個類包含幾個公共靜態方法編製的報告模板。模板的源可以從檔案,輸入流,記憶體中的物件。

該jrxml檔案(jasper_report_template.jrxml)的內容如下。它被儲存在目錄 C: oolsjasperreports-5.0.1 est:

<?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.yiibai;

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: oolsjasperreports-5.0.1 estsrccomyiibaiJasperReportCompile.java 並匯入baseBuild.xml在為下面的build.xml檔案。baseBuild.xml已經編譯和執行的目標:

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

   <import file="baseBuild.xml"/>

</project>

接下來,讓我們開啟命令列視窗並轉到build.xml檔案放置的目錄。最後執行的命令ant -Dmain-class=com.yiibai.JasperReportCompile 如下:

C:	oolsjasperreports-5.0.1	est>ant -Dmain-class=com.yiibai.JasperReportCompile
Buildfile: C:	oolsjasperreports-5.0.1	estuild.xml
compile:
    [javac] C:	oolsjasperreports-5.0.1	estaseBuild.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:	oolsjasperreports-5.0.1	estclasses

run:
     [echo] Runnin class : com.yiibai.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: oolsjasperreports-5.0.1 est 目錄。

預覽編譯報表模板

net.sf.jasperreports.view.JasperDesignViewer 正如在前面的章節中討論可用來預覽編譯報告模板以及JRXML模板。

為了進一步推動,讓我們新增一個新的目標viewDesign上述build.xml檔案,這將讓我們先看盾編譯報告。下面是修改後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。這裡使用與檔案集的巢狀<src>標籤中指定的原始檔夾。巢狀的源標籤允許編譯器,可通過許多不同的地點分散,在一個單一的根報表原始檔夾不進行分組報告模板。下面是修改後的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:	oolsjasperreports-5.0.1	est>ant
Buildfile: C:	oolsjasperreports-5.0.1	estuild.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.htmll#noconfig
      for more info.
      [jrc] File :
      C:	oolsjasperreports-5.0.1	estjasper_report_template.jrxml ... OK.

BUILD SUCCESSFUL
Total time: 5 seconds 

檔案jasper_report_template.jasper是在檔案系統(在我們的例子中為 C: oolsjasperreports-5.0.1 est目錄)產生的。這個檔案是相同的通過呼叫net.sf.jasperreports.engine.JasperCompileManager.compileReportToFile()程式生成一個。我們可以預覽這個 jasper檔案,執行ant viewDesign。