Jasper Reports 简明教程

JasperReports - Designs

JasperReport 中的 JRXML 模板(或 JRXML 文件)是标准 XML 文件,具有 .jrxml 扩展名。所有 JRXML 文件都包含标签 <jasperReport> 作为根元素。这反过来又包含许多子元素(所有这些都是可选的)。JasperReport 框架可以处理不同类型的数据源。在本教程中,我们将演示如何通过将 Java 数据对象集合(使用 Java bean)传递到 JasperReport Engine 来生成基本报表。最终报表将显示包含姓名和所在国家/地区的人员列表。

本章中介绍了以下步骤来描述如何设计 JasperReport:

  1. 创建 JRXML 报表模板。

  2. 预览 XML 报表模板。

Creating a JRXML Report Template

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

以下是上述报表模板中主要字段的详细信息:

  1. <queryString> - 此项为空(因为我们通过 Java Bean 传递数据)。通常包含检索报表结果的 SQL 语句。

  2. <field name> - 此元素用于将数据从数据源或查询映射到报表模板中。 name 在报表正文中重复使用,并区分大小写。

  3. <fieldDescription> - 此元素将字段名称与 XML 文件中的相应元素映射。

  4. <staticText> - 此项定义不依赖于任何数据源、变量、参数或报表表达式的静态文本。

  5. <textFieldExpression> - 此项定义结果字段的外观。

  6. $F{country} - 此项是一个变量,其中包含标签 <field name> 中预定义字段结果的值。

  7. <band> - 带区包含报表中显示的数据。

一旦报告设计准备就绪,将其保存到 C:\ 目录。

Previewing the XML Report Template

JasperReports JAR 文件中提供了一个实用工具类 net.sf.jasperreports.view.JasperDesignViewer,它有助于在无需编译或填充的情况下预览报告设计。此实用工具是一个独立的 Java 应用程序,因此可以使用 ANT 执行。

让我们编写 ANT 目标 viewDesignXML 来查看 JRXML。因此,让我们在 C:\tools\jasperreports-5.0.1\test 目录下创建并保存 build.xml (应放置在放置 JRXML 的同一目录中)。以下是 build.xml 文件−

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

   <import file = "baseBuild.xml" />
   <target name = "viewDesignXML" description = "Design viewer is
      launched to preview the JXML report design.">

      <java classname = "net.sf.jasperreports.view.JasperDesignViewer" fork = "true">
         <arg value = "-XML" />
         <arg value = "-F${file.name}.jrxml" />
         <classpath refid = "classpath" />
      </java>
   </target>

</project>

接下来,让我们打开命令提示符并转到放置 build.xml 的目录。执行命令 ant (因为 viewDesignXML 是默认目标)。输出如下所示−

C:\tools\jasperreports-5.0.1\test>ant
Buildfile: C:\tools\jasperreports-5.0.1\test\build.xml

viewDesignXML:
[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.

可以忽略 Log4j 警告,并且作为上述执行的结果,“JasperDesignViewer” 窗口打开,显示我们的报告模板预览。

jasper design viewer

正如我们所看到的,仅显示用于获取数据的报告表达式,因为 JasperDesignViewer 无法访问实际数据源或报告参数。通过关闭窗口或在命令行窗口中按 Ctrl-c 终止 JasperDesignViewer。