JasperReports 报表变量

精华

小牛编辑

186浏览

2023-03-14

1 JasperReports 报表变量声明

报表变量是建立在报表表达式之上的特殊对象。

报告变量简化了以下任务：

报表表达式，在整个报表模板中大量使用。这些表达式只能使用报表变量声明一次。
报表变量可以根据计数、总和、平均值、最低、最高、方差等对应的表达式值进行各种计算。

如果在报表设计中定义了变量，则表达式中的新变量可以引用这些变量。因此，在报表设计中声明变量的顺序很重要。

报表变量声明

<variable name = "CityNumber" class = "java.lang.Integer" incrementType = "Group"
   incrementGroup = "CityGroup" calculation = "Count">
   <variableExpression>
      <![CDATA[Boolean.TRUE]]>
   </variableExpression>
</variable>

如上所示，<variable> 元素包含多个属性。这些属性总结如下：

name属性

与parameters和fields类似，</variable> 元素的name属性是必需的。它允许通过在报表表达式中声明的名称来引用变量。

class属性

class属性也必须用于指定变量值的类名。它的默认值是java.lang.String。这可以在报告编译时和报告填充时更改为类路径中可用的任何类。引擎负责在使用 $V{} 标记的报表表达式中进行类型转换，因此不需要手动类型转换。

calculation属性

calculation属性：填充报表时对变量执行的计算。以下小节描述了 <variable> 元素的计算属性的所有可能值。

Average -：变量值是变量表达式的每个非空值的平均值。仅对数字变量有效。
Count ：变量值是变量表达式的非空实例的计数。
First ：变量值是变量表达式的第一个实例的值。后续值将被忽略。
Highest ：变量值是变量表达式的最高值。
Lowest ：变量值是报告中变量表达式的最低值。
Nothing ：不对变量执行计算。
StandardDeviation - 变量值是与报告表达式匹配的所有非空值的标准偏差。仅对数字变量有效。
Sum ：变量值是报告表达式返回的所有非空值的总和。
System ：变量值是自定义计算（使用 JasperReports 的 scriptlets 功能自己计算该变量的值）。
Variance ：变量值是通过评估报告变量的表达式返回的所有非空值的方差。

JRIncrementerFactory工厂类

incrementGroup属性确定在填充报表上的当前记录时用于计算变量值的类。默认值是任何实现net.sf.jasperreports.engine.fill.JRIncrementerFactory 的类。引擎将使用工厂类在运行时根据为变量设置的计算属性来实例化增量器对象。

incrementType属性

incrementType决定了何时重新计算变量的值。此属性使用值，如下所示：

Column ：在每列的末尾重新计算变量值。
Group ：当 incrementGroup 指定的组更改时，重新计算变量值。
None ：每条记录都重新计算变量值。
Page ：变量值在每个页面的末尾重新计算。
Report ：变量值在报告结束时重新计算一次。

IncrementGroup属性

当resetType是Group时，这决定了变量值被重置的组的名称。此属性的值将是在 JRXML 报表模板中声明的任何组的名称。

2 JasperReports 内置报表变量

有一些内置的系统变量，可以在表达式中使用，如下所示：

变量名	描述
PAGE_NUMBER	此变量的值是其当前页码。它可用于使用 JasperReports 文本字段元素的一个特殊功能（evaluationTime属性）显示当前页码和总页数。
COLUMN_NUMBER	此变量包含当前列号。
REPORT_COUNT	此报告变量包含处理的记录总数。
PAGE_COUNT	此变量包含生成当前页面时处理的记录数。
COLUMN_COUNT	此变量包含生成当前列时处理的记录数。
GroupName_COUNT	这个变量的名字来源于它对应的组的名字，后缀是_COUNT序列。此变量包含当前组中的记录数。

3 JasperReports 报表变量的示例

本案例中，让我们修改现有的报表模板（JasperReports 模板设计章节）添加一个变量 ( countNumber )。

项目结构如下：

pom.xml文件

<dependencies>
        <!-- https://mvnrepository.com/artifact/net.sf.jasperreports/jasperreports -->
        <dependency>
            <groupId>net.sf.jasperreports</groupId>
            <artifactId>jasperreports</artifactId>
            <version>6.17.0</version>
        </dependency>
        <dependency>
            <groupId>org.codehaus.groovy</groupId>
            <artifactId>groovy-all</artifactId>
            <version>2.4.7</version>
        </dependency>
        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi</artifactId>
            <version>3.17</version>
        </dependency>
    </dependencies>

DataBean实体类：

package cn.xnip;

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

DataBeanList类：

package cn.xnip;

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

jasper_report_template.jrxml模板文件：

<?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">
	
   <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>
   
   <title>
      <band height = "70">
         
         <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>
      
      </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 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["  " + String.valueOf($V{countNumber}) +"."+$F{name}]]>
            </textFieldExpression>
         </textField>
      
      </band>
   </detail>

</jasperReport>

先编译报表文件：

package cn.xnip;

import net.sf.jasperreports.engine.*;
import net.sf.jasperreports.view.JasperViewer;

public class JasperReportFill {

   public static void main(String[] args) {
      String filePath = "D:/idea_codes/jasper_reports/jasper_report_template.jrxml";
      try {
         JasperCompileManager.compileReportToFile(filePath,"d:/jasper_report_template.jasper");
         System.out.println("编译成功");
      } catch (JRException e) {
         e.printStackTrace();
      }
   }
}

编译后在D:/盘根目录下生成jasper_report_template.jasper文件，然后再填充数据：

package cn.xnip;

import net.sf.jasperreports.engine.*;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;

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

public class JasperReportFill {

   public static void main(String[] args) {
         String sourceFileName = "d:/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();
         }
      }
}

填充数据完毕后，在D:/盘根目录下生成jasper_report_template.jrprint文件，最后使用预览程序预览：

package cn.xnip;

import net.sf.jasperreports.engine.*;
import net.sf.jasperreports.view.JasperViewer;

public class JasperReportFill {

   public static void main(String[] args) {
      String filePath = "D:/jasper_report_template.jrprint";
      try {
         JasperViewer.viewReport(filePath,false);
      } catch (JRException e) {
         e.printStackTrace();
      }
   }
}

最后输出结果如下：

从效果我们看到，每个记录的计数都是前缀。