JasperReports - รวบรวมการออกแบบรายงาน

เราได้สร้างเทมเพลต JasperReport (ไฟล์ JRXML) ในบทที่แล้ว ไม่สามารถใช้ไฟล์นี้เพื่อสร้างรายงานได้โดยตรง จะต้องคอมไพล์เป็นรูปแบบไบนารีดั้งเดิมของ JasperReport เรียกว่าJasperไฟล์. ในการคอมไพล์เราแปลงวัตถุ JasperDesign เป็นวัตถุ JasperReport -

อินเตอร์เฟส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และนำเข้าbaseBuild.xmlในไฟล์ build.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

หากต้องการก้าวต่อไปให้เพิ่มเป้าหมายใหม่ viewDesignไปยังไฟล์ build.xml ด้านบนซึ่งจะช่วยให้เราสามารถดูตัวอย่างรายงานที่รวบรวมได้ ด้านล่างนี้คือ build.xml ฉบับแก้ไข -

ไฟล์นำเข้า - baseBuild.xml ถูกเลือกจากบทEnvironment Setupและควรอยู่ในไดเร็กทอรีเดียวกับ 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 ดังต่อไปนี้ -

รวบรวมผ่านงาน ANT

เนื่องจากการคอมไพล์เทมเพลตรายงานเป็นเหมือนงานเวลาออกแบบมากกว่างานรันไทม์ไลบรารี JasperReport จึงมีงาน ANT แบบกำหนดเอง ในบางสถานการณ์เมื่อสร้างไฟล์ JRXML ที่รันไทม์เราไม่สามารถใช้งาน ANT นี้ได้ งาน ANT ที่กำหนดเองที่เรียกว่า JRC และมีการดำเนินการโดยคลาส: net.sf.jasperreports.ant.JRAntCompileTask ไวยากรณ์และลักษณะการทำงานคล้ายกับบิวท์อินมาก<javac> งาน ANT

การรวบรวมเทมเพลต

มาเพิ่มเป้าหมายใหม่ compilereportdesingไปยัง 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:\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 directory) ไฟล์นี้เหมือนกับไฟล์ที่สร้างโดยทางโปรแกรมโดยเรียก net.sf.jasperreports.engine.JasperCompileManager.compileReportToFile () เราสามารถดูไฟล์ jasper นี้ได้ant viewDesign.