JasperReports - Kompilowanie projektu raportu

Wygenerowaliśmy szablon JasperReport (plik JRXML) w poprzednim rozdziale. Tego pliku nie można używać bezpośrednio do generowania raportów. Musi być skompilowany do natywnego formatu binarnego JasperReport o nazwieJasperplik. Podczas kompilacji przekształcamy obiekt JasperDesign w obiekt JasperReport -

Interfejs net.sf.jasperreports.engine.design.JRCompiler odgrywa kluczową rolę podczas kompilacji. Ten interfejs ma kilka implementacji w zależności od języka używanego do wyrażeń raportów, które mogą być napisane w Javie, Groovy, JavaScript lub dowolnym innym języku skryptowym, o ile implementacja kompilatora może go ocenić w czasie wykonywania.

Możemy skompilować plik JRXML na dwa następujące sposoby -

• Kompilacja programowa.
• Kompilacja za pomocą zadania ANT.

Programowa kompilacja JRXML

JasperReports API oferuje klasę fasady net.sf.jasperreports.engine.JasperCompileManager do kompilowania JasperReport. Ta klasa składa się z kilku publicznych statycznych metod kompilowania szablonów raportów. Źródłem szablonów mogą być pliki, strumienie wejściowe i / lub obiekty pamięci.

Zawartość pliku JRXML (jasper_report_template.jrxml) jest następująca. Jest zapisywany w kataloguC:\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>

Poniższy kod demonstruje kompilację powyższego pliku 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!!! ...");
   }
}

Kompilacja szablonów

W następnym kroku zapiszmy powyższą zawartość w pliku C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\JasperReportCompile.javai zaimportuj baseBuild.xml do pliku build.xml, jak poniżej. Plik baseBuild.xml ma już rozszerzeniecompile i run cele -

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

   <import file = "baseBuild.xml"/>

</project>

Następnie otwórzmy okno wiersza poleceń i przejdźmy do katalogu, w którym znajduje się plik build.xml. Na koniec wykonaj polecenieant -Dmain-class = com.tutorialspoint.JasperReportCompile jako -

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

W wyniku powyższej kompilacji zobaczysz, że plik szablonu jasper_report_template.jasper został wygenerowany w katalogu C: \ tools \ jasperreports-5.0.1 \ test.

Podgląd skompilowanego szablonu raportu

Net.sf.jasperreports.view.JasperDesignViewer może być używany do podglądu skompilowany szablonów raportów i szablonów JRXML.

Aby przejść dalej, dodajmy nowy cel viewDesigndo powyższego pliku build.xml, który pozwoli nam na podgląd skompilowanego raportu. Poniżej znajduje się poprawiony plik build.xml -

Plik importu - baseBuild.xml jest pobierany z rozdziału Konfiguracja środowiska i powinien być umieszczony w tym samym katalogu co 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>

Wykonajmy polecenie - ant(domyślnym celem jest viewDesign) w wierszu polecenia. Otworzy się okno JasperDesignViewer, wyświetlając plik Jasper, jak poniżej -

Kompilacja za pomocą zadania ANT

Ponieważ kompilacja szablonu raportu jest bardziej jak zadanie czasu projektowania niż zadanie w czasie wykonywania, biblioteka JasperReport ma niestandardowe zadanie ANT. W niektórych sytuacjach, gdy plik JRXML jest tworzony w czasie wykonywania, nie możemy użyć tego zadania ANT. Niestandardowe zadanie ANT nosi nazwę JRC i jest implementowane przez klasę: net.sf.jasperreports.ant.JRAntCompileTask . Jego składnia i zachowanie są bardzo podobne do wbudowanego<javac> Zadanie ANT.

Kompilacja szablonów

Dodajmy nowy cel compilereportdesingdo naszego istniejącego pliku build.xml. Tutaj folder źródłowy jest określony za pomocą zagnieżdżonego znacznika <src> z zestawami plików. Zagnieżdżony znacznik źródłowy umożliwia kompilowanie szablonów raportów, które są rozproszone w wielu różnych lokalizacjach i nie są zgrupowane w jednym głównym folderze źródłowym raportów. Poniżej znajduje się poprawiony plik 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>

Następnie otwórzmy wiersz poleceń i przejdźmy do katalogu, w którym znajduje się plik build.xml. Wykonaj polecenieant(compilereportdesing jest domyślnym celem); Dane wyjściowe są następujące -

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

Plik jasper_report_template.jasper jest generowany w systemie plików (w naszym przypadku katalog C: \ tools \ jasperreports-5.0.1 \ test). Ten plik jest identyczny z plikiem wygenerowanym programowo przez wywołanie metody net.sf.jasperreports.engine.JasperCompileManager.compileReportToFile (). Możemy wyświetlić podgląd tego pliku jasper, wykonującant viewDesign.