报告脚本

---

我们在前面的章节中已经看到，报表上显示的数据通常是从报表参数和报表字段中获取的。可以使用报表变量及其表达式来处理此数据。在某些情况下，使用报表表达式或变量无法轻松实现复杂的功能。此类示例可能是复杂的字符串操作、映射的构建、内存中的对象列表或使用第 3 方 Java API 的日期操作。对于这种情况，JasperReports 为我们提供了一种简单而强大的方法来使用Scriptlet来完成此操作。

Scriptlet 是每次报告事件发生时执行的 Java 代码序列。报表变量的值可以通过 scriptlet 影响。

脚本声明

我们可以通过两种方式声明 scriptlet -

• 使用 <scriptlet>元素。该元素具有name属性和class属性。class属性应指定类的名称，该类扩展了JRAbstractScriptlet类。该类必须在报告填充时在类路径中可用，并且必须有一个空的构造函数，以便引擎可以即时实例化它。

• 在报告模板（JRXML）中使用元素<jasperReport>的属性scriptletClass 。通过使用 scriptlet 的完全限定名称（包括整个包名称）设置此属性，我们表明我们要使用 scriptlet。使用此属性创建的 scriptlet 实例的作用类似于 scriptlet 列表中的第一个 scriptlet，并具有预定义名称 REPORT。

小脚本类

scriptlet 是一个 java 类，它必须扩展以下类之一 -

• net.sf.jasperreports.engine.JRAbstractScriptlet - 此类包含许多必须在每个实现中重写的抽象方法。JasperReports 在适当的时候自动调用这些方法。开发人员必须实现所有抽象方法。

• net.sf.jasperreports.engine.JRDefaultScriptlet - 此类包含 JRAbstractScriptlet 中每个方法的默认空实现。开发人员只需要实现他/她的项目所需的那些方法。

下表列出了上述类中的方法。在报告填充阶段，报告引擎将在适当的时间调用这些方法。

每个报告可以指定任意数量的 scriptlet。如果没有为报表指定 scriptlet，引擎仍会创建单个 JRDefaultScriptlet 实例并使用内置 REPORT_SCRIPTLET 参数注册它。

我们可以向 scriptlet 添加所需的任何其他方法。报表可以通过使用内置参数 REPORT_SCRIPTLET 来调用这些方法。

全局脚本

我们可以通过另一种方式将 Scriptlet 与报告关联起来，即通过全局声明 Scriptlet。这使得脚本适用于给定 JasperReports 部署中填写的所有报告。通过将 scriptlet 作为扩展添加到 JasperReports 中，这一点变得很容易。scriptlet 扩展点由net.sf.jasperreports.engine.scriptlets.ScriptletFactory接口表示。JasperReports 将在运行时加载通过扩展可用的所有 scriptlet 工厂。然后，它将向每个人询问他们想要应用于当前正在运行的报告的 scriptlet 实例列表。当请求 scriptlet 实例列表时，引擎会提供一些上下文信息，工厂可以使用这些信息来决定哪些 scriptlet 实际应用于当前报告。

报告理事

调控器只是全局 scriptlet 的扩展，使我们能够解决报表引擎在生成报表时在运行时进入无限循环的问题。在设计时无法检测到无效的报告模板，因为大多数时候，进入无限循环的条件取决于运行时输入引擎的实际数据。报告调控器帮助确定某个报告是否已进入无限循环，并且他们可以阻止它。这可以防止运行报告的计算机资源耗尽。

JasperReports 有两个简单的报表调控器，它们可以根据指定的最大页数或指定的超时间隔停止报表执行。他们是 -

• net.sf.jasperreports.governors.MaxPagesGovernor - 这是一个全局脚本，正在寻找两个配置属性来决定它是否适用于当前正在运行的报告。配置属性是 -

  • net.sf.jasperreports.governor.max.pages.enabled=[true|false]

  • net.sf.jasperreports.governor.max.pages=[整数]

• net.sf.jasperreports.governors.TimeoutGovernor - 这也是一个全局脚本，它正在寻找以下两个配置属性来决定它是否适用。

  配置属性是 -

  • net.sf.jasperreports.governor.timeout.enabled=[true|false]

  • net.sf.jasperreports.governor.timeout=[毫秒]

两个调控器的属性都可以在 jasperreports.properties 文件中进行全局设置，或者在报告级别设置为自定义报告属性。这很有用，因为不同的报告可能有不同的估计大小或超时限制，还因为您可能希望打开所有报告的调控器，同时关闭某些报告，反之亦然。

例子

让我们编写一个 scriptlet 类 ( MyScriptlet )。文件 C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\MyScriptlet.java 的内容如下 -

package com.tutorialspoint;

import net.sf.jasperreports.engine.JRDefaultScriptlet;
import net.sf.jasperreports.engine.JRScriptletException;


public class MyScriptlet extends JRDefaultScriptlet {

   public void afterReportInit() throws JRScriptletException{
      System.out.println("call afterReportInit()");
      // this.setVariableValue("AllCountries", sbuffer.toString());
      this.setVariableValue("someVar", new String("This variable value 
         was modified by the scriptlet."));
   }

   public String hello() throws JRScriptletException {
      return "Hello! I'm the report's scriptlet object.";
   }

}

上述 scriptlet 类的详细信息如下 -

• 在afterReportInit方法中，我们为变量“someVar”设置一个值this.setVariableValue("someVar", new String("This 变量值已被 scriptlet 修改。"))。

• 在类的末尾，定义了一个名为“hello”的额外方法。这是一个可以添加到实际返回值而不是设置变量的 Scriptlet 中的方法示例。

接下来，我们将在现有的报告模板中添加 scriptlet 类引用（报告设计章节）。修改后的报告模板（jasper_report_template.jrxml）如下。将其保存到 C:\tools\jasperreports-5.0.1\test 目录 -

<?xml version = "1.0"?>
<!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" pageWidth = "595"
   pageHeight = "842" columnWidth = "515"
   leftMargin = "40" rightMargin = "40" topMargin = "50" bottomMargin = "50"
   scriptletClass = "com.tutorialspoint.MyScriptlet">
	
   <style name = "alternateStyle" fontName = "Arial" forecolor = "red">
      
      <conditionalStyle>
         <conditionExpression>
            <![CDATA[new Boolean($V{countNumber}.intValue() % 2 == 0)]]>
         </conditionExpression>
			
         <style forecolor = "blue" isBold = "true"/>
      </conditionalStyle>
   </style>
   
   <parameter name = "ReportTitle" class = "java.lang.String"/>
   <parameter name = "Author" class = "java.lang.String"/>

   <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>

   <variable name = "countNumber" class = "java.lang.Integer" 
      calculation = "Count">
      <variableExpression><
         ![CDATA[Boolean.TRUE]]>
      </variableExpression>
   </variable>

   <variable name = "someVar" class = "java.lang.String">
      <initialValueExpression>
        <![CDATA["This is the initial variable value."]]>
      </initialValueExpression>
   </variable>

   <title>
      <band height = "100">
         
         <line>
            <reportElement x = "0" y = "0" width = "515" height = "1"/>
         </line>
         
         <textField isBlankWhenNull = "true" bookmarkLevel = "1">
            <reportElement x = "0" y = "10" width = "515" height = "30"/>
            
            <textElement textAlignment = "Center">
              <font size = "22"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
              <![CDATA[$P{ReportTitle}]]>
            </textFieldExpression>
				
            <anchorNameExpression>
               <![CDATA["Title"]]>
            </anchorNameExpression>
         </textField>
        
         <textField isBlankWhenNull = "true">
            <reportElement  x = "0" y = "40" width = "515" height = "20"/>
            
            <textElement textAlignment = "Center">
               <font size = "10"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{Author}]]>
            </textFieldExpression>
         </textField>
         
         <textField isBlankWhenNull = "true">
            <reportElement  x = "0" y = "50" width = "515" 
               height = "30" forecolor = "#993300"/>
             
            <textElement textAlignment = "Center">
               <font size = "10"/>
            </textElement>
            
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$V{someVar}]]>
            </textFieldExpression>
				
         </textField>

      </band>
   </title>

   <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 style = "alternateStyle" 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>
   
   <summary>
      <band height = "45">
            
         <textField isStretchWithOverflow = "true">
            <reportElement x = "0" y = "10" width = "515" height = "15" />
            <textElement textAlignment = "Center"/>
               
            <textFieldExpression class = "java.lang.String">
               <![CDATA["There are " + String.valueOf($V{REPORT_COUNT}) +
                  " records on this report."]]>
            </textFieldExpression>
         </textField>
         
         <textField isStretchWithOverflow = "true">
            <reportElement positionType = "Float" x = "0" y = "30" width = "515"
               height = "15" forecolor = "# 993300" />
               
            <textElement textAlignment = "Center">
               <font size = "10"/>
            </textElement>
               
            <textFieldExpression class = "java.lang.String">
               <![CDATA[$P{REPORT_SCRIPTLET}.hello()]]>
            </textFieldExpression>
            
         </textField>
         
      </band>
   </summary>
	
</jasperReport>

修订后的报告模板的详细信息如下：

• 我们在 <jasperReport> 元素的scriptletClass属性中引用了 MyScriptlet 类。

• Scriptlet 只能访问但不能修改报告字段和参数。但是，scriptlet 可以修改报告变量值。这可以通过调用 setVariableValue() 方法来完成。此方法在 JRAbstractScriptlet 类中定义，该类始终是任何 scriptlet 的父类。在这里，我们定义了一个变量someVar，它将被 MyScriptlet 修改为值This value was generated by the scriptlet。

• 上面的报告模板在摘要区域中有一个方法调用，它说明了如何编写新方法（在 scriptlet 中）并在报告模板中使用它们。( $P{REPORT_SCRIPTLET}.hello() )

报表填写的java代码保持不变。文件C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\JasperReportFill.java的内容如下 -

package com.tutorialspoint;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JasperFillManager;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;

public class JasperReportFill {
   @SuppressWarnings("unchecked")
   public static void main(String[] args) {
      String sourceFileName = 
         "C://tools/jasperreports-5.0.1/test/jasper_report_template.jasper";

      DataBeanList DataBeanList = new DataBeanList();
      ArrayList<DataBean> dataList = DataBeanList.getDataBeanList();

      JRBeanCollectionDataSource beanColDataSource = new 
         JRBeanCollectionDataSource(dataList);

      Map parameters = new HashMap();
      /**
       * Passing ReportTitle and Author as parameters
       */
      parameters.put("ReportTitle", "List of Contacts");
      parameters.put("Author", "Prepared By Manisha");

      try {
         JasperFillManager.fillReportToFile(
         sourceFileName, parameters, beanColDataSource);
      } catch (JRException e) {
         e.printStackTrace();
      }
   }
}

POJO 文件C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBean.java的内容如下 -

package com.tutorialspoint;

public class DataBean {
   private String name;
   private String country;

   public String getName() {
      return name;
   }

   public void setName(String name) {
      this.name = name;
   }

   public String getCountry() {
      return country;
   }

   public void setCountry(String country) {
      this.country = country;
   }
}

文件C:\tools\jasperreports-5.0.1\test\src\com\tutorialspoint\DataBeanList.java的内容如下 -

package com.tutorialspoint;

import java.util.ArrayList;

public class DataBeanList {
   public ArrayList<DataBean> getDataBeanList() {
      ArrayList<DataBean> dataBeanList = new ArrayList<DataBean>();

      dataBeanList.add(produce("Manisha", "India"));
      dataBeanList.add(produce("Dennis Ritchie", "USA"));
      dataBeanList.add(produce("V.Anand", "India"));
      dataBeanList.add(produce("Shrinath", "California"));

      return dataBeanList;
   }

   /**
    * This method returns a DataBean object,
    * with name and country set in it.
    */
   private DataBean produce(String name, String country) {
      DataBean dataBean = new DataBean();
      dataBean.setName(name);
      dataBean.setCountry(country);
      
      return dataBean;
   }
}

报告生成

我们将使用常规 ANT 构建过程来编译并执行上述文件。文件 build.xml（保存在目录 C:\tools\jasperreports-5.0.1\test 下）的内容如下所示。

导入文件 - baseBuild.xml 取自“环境设置”一章，并且应放置在与 build.xml 相同的目录中。

<?xml version = "1.0" encoding = "UTF-8"?>
<project name = "JasperReportTest" default = "viewFillReport" basedir = ".">
   <import file = "baseBuild.xml" />
   
   <target name = "viewFillReport" depends = "compile,compilereportdesing,run"
      description = "Launches the report viewer to preview 
      the report stored in the .JRprint file.">
      
      <java classname = "net.sf.jasperreports.view.JasperViewer" fork = "true">
         <arg value = "-F${file.name}.JRprint" />
         <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 -Dmain-class=com.tutorialspoint.JasperReportFill（viewFullReport 是默认目标）：

C:\tools\jasperreports-5.0.1\test>ant -Dmain-class=com.tutorialspoint.JasperReportFill
Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml

clean-sample:
   [delete] Deleting directory C:\tools\jasperreports-5.0.1\test\classes
   [delete] Deleting: C:\tools\jasperreports-5.0.1\test\jasper_report_template.jasper
   [delete] Deleting: C:\tools\jasperreports-5.0.1\test\jasper_report_template.jrprint

compile:
   [mkdir] Created dir: C:\tools\jasperreports-5.0.1\test\classes
   [javac] C:\tools\jasperreports-5.0.1\test\baseBuild.xml:28:
   warning: 'includeantruntime' was not set, defaulting to bu
   [javac] Compiling 4 source files to C:\tools\jasperreports-5.0.1\test\classes

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.

run:
   [echo] Runnin class : com.tutorialspoint.JasperReportFill
   [java] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.extensions.ExtensionsEnvironment).
   [java] log4j:WARN Please initialize the log4j system properly.
   [java] call afterReportInit()
   [java] call afterReportInit()

viewFillReport:
   [java] log4j:WARN No appenders could be found for logger
   (net.sf.jasperreports.extensions.ExtensionsEnvironment).
   [java] log4j:WARN Please initialize the log4j system properly.

BUILD SUCCESSFUL
Total time: 18 minutes 49 seconds

作为上述编译的结果，JasperViewer 窗口将打开，如下面给出的屏幕所示 -

这里我们看到 MyScriptlet 类显示两条消息 -

• 在标题部分 -该变量值已由 scriptlet 修改
• 在底部 -你好！我是报告的 scriptlet 对象。