---
title: "iReport和JasperReport"
author: "javaeyeren"
date: "2009-03-20T14:30:00Z"
tags: []
slug: "ireport-jasperreport"
draft: false
lastmod: "2009-03-20T14:30:00Z"
id: 601298
url: "https://javaeyeren.iteye.com/blog/601298"
---

**一、介绍**

1）它可以PDF，HTML，XML等多种形式产生报表或动态报表，在新版本还支持CSV，XLS，RTF等格式的报表；  
2）它按预定义的XML文档来组织数据，来源多（如：关系数据库，Java容器对象（collection，arrays）等）；  
报表的填充过程：  
先产生报表设计对象-&gt;序列化该对象-&gt;存储在磁盘或网络-&gt;产生XML文件（表格数据）。  
表单的设计过程就是用定义于XML文件中的Java表达式来实现报表的设计。  
3）它带数据一致性验证；  
4）报表引擎必须先接受数据（通过参数等多种形式）来产生报表，更多的是来自数据源，引擎直接接收用于填充表格的数据源对象，或者通过自身提供的JDBC连接对象来处理数据库的数据；  
5）报表最终要产生一个新的对象来进行填充操作，从而产生打印文档对象，这也是存储在磁盘或网络传输介质的序列化对象；  
6）内置浏览器能直接查看结果，以PDF，HTML，XML导出；  
7）重要的类：  
net.sf.jasperreports.engine.design.JasperDesign  
其实例是用于报表产生的原始类；  
net.sf.jasperreports.engine.design.JasperReport  
表现了报表设计对象，是作为报表的编译过程的结果而被实例化，是向报表中填充数据的准备。

**二、结构**

JasperReports用XML文件来定义，约定用jrxml作为文件的后缀名。

**1****）主要元素：**  
&lt;jasperReport&gt; 根元素  
&lt;title&gt; 报表的标题  
&lt;pageHeader&gt; 页眉  
&lt;detail&gt; 正文  
&lt;pageFooter&gt; 页脚  
&lt;band&gt; 定义报表部件，以上所有元素都包含一个band元素作为其唯一子元素。  
除了根元素，其余元素是可选的。

**2****）其编辑工具iReport在Eclipse3.2下的安装过程**  
菜单“帮助”-&gt;“软件更新”-&gt;“查找并安装”-&gt;“搜索要安装的新功能部件”--(下一步)--&gt;“新建远程站点”，输入以下内容：  
名称：JasperForge  
URL：[http://www.jasperforge.org/update](http://www.jasperforge.org/update)  
\--(确定)--&gt;“下一步”--&gt;直至完成。

**3****）以JasperReports1.3.0版本为例，一个JasperReports项目需要如下jar包**：  
包名 说明  
jasperreports-1.3.0.jar JasperReports API  
commons-beanutils-1.7.jar JavaBeans Utility classes  
commons-collections-2.1.jar Collections framework extension classes  
commons-digester-1.7.jar classes for processing XML documents  
commons-logging-1.0.2.jar Logging classes  
poi-2.0-final-20040126.jar Jarkarta POI API to generate an Excel Document  
itext-1.3.1.jar PDF library  
xml-apis.jar XML parser API

**三、iReport介绍**

**1****）iReport是为JasperReports设计的强大的，直观的，易于使用的可视化报表设计器，为win32平台编写。允许用户可视化地编辑XML JasperDesign文件，可以和其它数据库进行JDBC通信。**  
再设计模板时可以以HTML，PDF，XML方式预览，用它生成的文件有.jrxml和.jasper两种文件。  
.jrxml：是可视化编辑的xml文件；  
.jasper：经编译后生成的类文件，即报表模板文件。

**2****）iReport的输出格式**  
其预览输出格式有：PDF，HTML，CSV。JAVA2D，EXCEL，纯文本，JRView。  
注意：JRViewer是直接以C/S方式作为报表的输出格式，在JFrame框架下输出。

**3****）报表的动态对象变量、参数、字段**  
字段Fields：是从数据库抽取出来的，在报表中出现的数据库内容。$F  
参数Parameters：你写的应用需要提供给报表的入口。 $P  
变量Variables：报表中一些逻辑运算的表现。 $V  
每个对象的定义格式如下： $V{variablesName}

**4****）运行时需要.jasper文件；编译：把.jrxml-&gt;.jasper文件。**  
静态运行：静态文本来运行，和数据源无关；  
动态运行：带数据源运行。

**5****）报表的结构**  
title、pageHeader、columnHeader、detail、columnFooter、pageFooter、summary、groupHeader、groupfooter。

**6****）在iReport中创建数据库连接**  
（1）菜单DourceSource -&gt; Connections/DataSources -&gt; ...new -&gt;  
（2）菜单Build -&gt; Set active connection -&gt; 选择 -&gt; ... -&gt; OK

**7****）在iReport中创建文件**  
iReport工具是一个可视编辑器帮助创建JasperReports文件。JasperReports是一个基于Java报表的引擎。  
当你在iReport中创建一个报表，你实际上是对配置文件进行操作，告诉JasperReports应该怎样建立Report。  
三种文件：  
.jasper文件：编译的二进制文件；  
.jrxml文件：报表的配置文件；  
.pdf文件：生成的pdf文件。

**8****）报表格式化**  
在iReport上选择报表的一个区域，将呈现蓝色高亮显示；  
可用鼠标拖曳来改变区域的尺寸，当误操作时，用undo来恢复；  
如选择框变红，则有错误，report将不能编译；  
改变字体或调整尺寸，菜单“View”-&gt;“Element properties”-&gt;分三个选择：  
（1）Common选择：尺寸，前景色/背景色，透明度，打印条件，位置属性等；  
（2）Font选择：字体、大小、类型，PDF字体，加粗，斜体，下划线，水平位置，垂直位置，PDF编码。  
注意：两种字体：  
Font Name：将显示在iReport设计器和JasperReports运行中；  
PDF font Name：将显示在编译后的PDF文件中。  
（3）Static Text：静态文本。  
想浏览元素时，看“View”-&gt;“Elements browser”；  
一次选择多个域，按“shift”键再用鼠标点击；  
菜单“View”-&gt;“Report Properties”报表属性：  
报表尺寸，单位，页边距，报表名，纵向Portrait/横向Landscape，列宽，Spacing，标题作为新页，Summary作为新页，XML编码（UTF-8）。

**9****）使用Groups**  
菜单“View”-&gt;“Report query” 可以查询和修改SQL语句。

**10****）为report增加参数**  
（1）菜单“View”-&gt;“Report Query”，修改SQL语句，如：加上 WHERE LAST\_NAME=$P{LAST\_NAME}  
注意：参数用$P{}来封装。  
（2）定义参数  
菜单“View”-&gt;“Reports Parameters”  
新建参数，如参数名为“LAST\_NAME”，再指定参数的类型（如：String）  
还可设定“缺省值”和参数的“描述”  
运行报表（缺省），还可以传递参数方式：[http://server/showReport?LAST\_NAME=smith](http://server/showReport?LAST_NAME=smith)  
菜单“Build”-&gt;“Execute report（using active conn.）”

**11****）创建子报表**  
例子：一个报表包含另一个报表  
（1）建立两个报表；  
（2）扩展master报表，增加一个subreport元素；  
（3）双击subreport元素，设置其属性。在Subreport（other）栏中，  
Subreport Expression填入“c:\\test2.jasper”(第二个表即子表的文件名），点击“Add”，增加/修改：“Subreport parameter name”和Default value expression值；（COUNTRY $F{COUNTRY}）  
（4）对子表“Report query”-&gt;添加'where COUNTRY=${COUNTRY}'  
（5）增加“Report parameters”，（COUNTRY，java.lang.String)  
（6）编译detail report；  
（7）运行master report。

**iReport****支持Groovy脚本语言，可无需懂Java。**

**1、配置XML文件**  
jasperreports的XML配置文件局域jasperreport.dtd文件而来。

1）根元素jasperReport  
其子元素有：报告的字体reportFont，参数parameter，查询字符串queryString，字段field，变量variable，组group，标题title，页眉pageHeader，列眉columnHeader，表明细detail，列脚columnFooter，页脚pageFooter。  
属性有：列宽columnWidth，列间距columnSpacing，左边距leftMargin，顶边距topMargin，底边距bottomMargin。

2）报表层字体含义reportFonts  
无子元素；  
属性有：名字name，是否缺省isFault，字体名fontName，字体大小size，是否粗体isBold，是否斜体isItalic，是否带下划线isUnderline，isStrikeThrough，PDF字体名pdfFontName，PDF编码pdfEncoding，是否嵌入PDF（isPdfEmbedded）。

3）用于产生报表的对象参数parameter。引用P${name}  
其子元素有：ParameterDescription，defaultValueExpression  
属性有：name，class

4）从数据库检索数据的查询SQL语句 queryString

5）包含于report中的数据库表列字段 field。 引用F${name}  
其子元素有：variableExpression，initialValueExpression  
属性有：name，class

6）用在XML文件中的变量 Variable 引用V${name}  
其子元素有：variableExpression，initialValueExpression  
属性有：name，class

7）报表标题 title  
其子元素有：band  
无属性

8）页眉 pageHeader  
其子元素有：band  
无属性

9）报表的列名 columnHeader  
其子元素有：band  
无属性

10）指定的列值detail  
其子元素有：band  
无属性

11）列尾columnFooter  
其子元素有：band  
无属性

12）页脚pageFooter  
其子元素有：band  
无属性  
注：在report中，一个band表示一个report节点。一个band元素包括：staticText（静态文本）和textElement（文本元素）两个元素。  
常见报表模型：列表、分组、主从、嵌套、交叉、图形、套打、分栏、填报。

**2****、创建报表**

1）建立输入源  
InputStream input = new FileInputStream(new File("c:\\\\JasperReports\\\\catalog.xml"));  
JasperDesign design=JRXmlLoader.load(Input);

2）创建对象  
JasperReport report = JasperCompileManager.compileReport(design);

3）获得JDBC连接从数据库检索数据  
InitialContext initialContext = new InitialContext();  
DataSource ds = (DataSource)initialContext.lookup("java:comp/env/jdbc/OracleDBConnectionDS");  
Connection conn = ds.getConnection();

4）产生可预览、打印、输出为其它格式的JasperPrint文件  
JasperPrint print = JasperFillManager.fillReport(report, parameters, conn);

5）参数处理  
Map parameters = new HashMap();  
parameters.put("ReportTitle", "PDF JasperReport");

6）输出成XML，PDF，HTML，CSV，XLS（Excel）的任一种文件。  
OutputStream output = new FileOutputStream(new File("c:/JasperReports/catalog.pdf"))  
JasperExportManager.exportReportToPdfStream(print,output);

**3****、JasperReports的安装配置**

1）JDK的安装，注意JAVA\_HOME环境变量；  
2）要支持中文，需itext-1.3.1.jar和iTextAsian.jar包，加入CLASSPATH环境变量中；  
3）安装iReport，用iReport-1.3.0-windows-installer.exe安装；  
4）JasperReport不需任何配置，将其jar包（jasperreports-1.3.0.jar）放入CLASSPATH；  
5）数据库的JDBC驱动包，例如Sybase的驱动包为jconn6.jar，加入到CLASSPATH。

**4****、iReport的安装配置**

iReport如果不用其安装文件iReport-1.3.0-windows-installer.exe安装，则需要配置。  
iReport需Sun公司的JDK下的tools.jar，需拷贝到iReport的lib目录下。  
iReport初始化配置的组成：  
（1）建立报表；  
（2）选择语言；  
（3）加入到CLASSPATH。

**四、Report Structure 报告的结构**

本章描述报告的结构，可用的report对象和它们的属性。这基本上是JasperReports的快速参考。

**1****、Expressions 表达式**  
表达式是JasperReports的核心特征。它是一个重要的机制，允许操纵和显示报告数据，执行各种计算，自定义报告的外观和报告对象的可视性。

1）一个典型的表达式  
$F{LastName} + " " + $F{LastName}  
一个JasperReports的表达式是以Java表达式为基础的，再加上一些附加的语法，它允许引用参数、变量和字段等。  
比如说要引用一个名叫DATA的参数时，语法应为$P{PARAM\_NAME}。  
对变量和字段来说，其引用语法分别为$V{VAR\_NAME}和$F{FIELD\_NAME}。  
注意：在JasperReports的groovy脚本语言中，也同样可以用$F，$P，$V引用参数、变量和字段。

2）表达式的语法  
（1）$F{FIELD} 引用名为FIELD的字段；  
（2）$V{VAR} 引用名为VAR的变量；  
（3）$P{PARAM} 引用名为PARAM的参数；  
（4）$P!{PARAM} 引用名为PARAM的参数；这个特殊的语法仅能用于report的查询中。它允许插入参数的内容到查询字符串中。例如，它能被用于创建一个带通过参数来指定WHERE条件的动态查询。  
$R{keyName} 在resource bundle中检索带keyName关键字的字符串。  
注意：表达式是用Java或Groovy写成的，这意外着可以用Java强大的功能，如调用方法，允许构建无限复杂的表达式。还要注意，表达式的结果总是一个对象。

3）更多的表达式  
（1）new Integer(Math.max($V{Price1},$V{Price2}))  
（2）(new SimpleDateFormat("dd/MM/yyyy")).format($F{OrderDate})  
（3）$F{SpecialOffer}.booleanValue()? $F{SpecialPrice} : $F{Price}

**2****、内建的函数**  
JasperReports提供了一套内建的函数用于report表达式中。这些函数尽管是内建的工具，还是可以在普通操作中执行它。  
注意：目前这套函数很有限，在未来会得到扩展。

1)例：使用内建函数  
msg("Total cost is {0}", $F{TOTAL})  
msg("Matched {0} products out of {1}", $F{MATCHED}, $P{TOTAL})

2)内建的函数  
（1）String str(String key);  
从和report相联系的resource bundle中得到给出的key的一个字符串。这个函数的功能和使用$R{key}语法等价。  
（2）String msg(String pattern, Object arg0);  
建立一个带给定的pattern和给定参数来指定其格式的java.util.MessageFormat对象。  
（3）String msg(String pattern, Object arg0, Object arg1);  
同上；  
（4）String msg(String pattern, Object arg0, Object arg1, Object arg2);  
同上。

**3****、Report 报告**  
Report是表现为报告模板的根对象。在报告执行期间，report模板和数据组合成最终的文档。  
报告的属性有：  
（1）Report Name 报告名；  
（2）Units 报告的单位；有：像素Pixels，毫米Millimeters，厘米Centimeters和英寸Inches。  
（3）Language 报告表达式使用的语言；目前有Java和Groovy两种。  
（4）Orientation 页的方向；其可能值为水平Protrait和纵向Landscape。  
（5）Page Width 以报告单位指定的页宽；  
（6）Page Height 以报告单位指定的页高；  
（7）Page Size 报告的尺寸，即为page width和page height。  
（8）Left Margin 以报告单位指定的左边页边距；  
（9）Right Margin 以报告单位指定的右边页边距；  
（10）Top Margin 以报告单位指定的顶部页边距；  
（11）Bottom Margin 以报告单位指定的底部页边距；  
（12）Column Count 报告中的列数；  
（13）Column Spacing 以报告单位指定的列边距；  
（14）Column Width 以报告单位指定的列宽；  
（15）Print Order 填充列的顺序；有垂直Vertical和水平Horizontal两种。  
（16）Float Column Footer 浮动列脚，指出是否在列底部或明细表最后或组脚进行打印；  
（17）Default Font 缺省字体；  
（18）Default Style 缺省风格；  
（19）Scriptlet Class 脚本类，它必须是JRAbstractScriptlet类的子类。如果省略，将创建一个JRDefaultScriptlet的实例。  
（20）Summary New Page 新页的概要；  
（21）Title New Page 新页的标题；  
（22）When No Data Print 无数据时的打印，有三个选择：No Pages 表示0页；Blank Page 空白页；All Sections No Detail 除了detail section，其它的都打印。  
（23）Query 查询，用来检索数据到报告中。  
（24）Query Language 查询语言，有五个值：SQL 用于JDBC数据源的查询语言；HBM Hibernate用于Hibernate数据源的查询语言；XPath 用于XML数据源的查询语言；EJBQL用于支持Java持久层（Persistence）API的数据源的查询语言；MDX 用于Mondrian数据源的查询语言。  
（25）Imports java输入的列表，例如：java.util.\*和java.text.SimpleDateFormat格式。用于简化report的表达式。  
（26）Resource Bundle 为report提供了本地的系列字符串。在报告中，本地字符串能用$R{key}引用。  
（27）When Resource Missing Print 允许自定义引擎在resource bundle中处理丢失的resource。有4种选择：Null 丢失的resource不打印；Empty 丢失的resource为空；Key 用$R{key}指定的key来打印； Error 用错误来中断报告的执行。

**4****、Styles 风格**  
一个report可以定义大量的风格。一旦定义了，它们能和report对象联系起来，为了给各种可视视图提供基本的配置。report允许用模块化的方式来定义模块的风格。  
风格有相关联的条件风格。条件风格允许当其表达式为真时改变风格。

1）风格的属性有：  
（1）Name 风格名；  
（2）Parent Style 父风格；  
（3）Foreground 前景色；  
（4）Background 背景色；  
（5）Mode 方式，决定是否带透明度；  
（6）Pen 画笔 有6种选择：None 无线；1 Point 正常宽度的线；2 Point 中等宽度的线；4 Point 粗线；Dotted 虚线；Thin 细线。  
（7）Fill 填充；决定对对象进行填充的模式；  
（8）Box 指定盒子的属性，如边框类型，边框颜色，是否填充。  
（9）Horizontal Alignment 水平排列；有3种选择：Left 左；Center 中；Right 右。  
（10）Vertical Alignment 垂直排列；有3种选择：Top 顶；Middle 中；Bottom 底。  
（11）Scale 比例；指定图像的比例，有3种选择：Clip 尺寸不适合时，多余部分省略；Fill Frame 图像按比例填充进Image对象中；Retain Shape 保留原形状进行填充。  
（12）Radius 指定矩形边框倒角的弧度；  
（13）Pattern 用Text Field表达式的值来指定样式；其日期类型的值用java.text.SimpleDataFormat类来定义；其数值型的值用java.text.DecimalFormat来定义。  
（14）Blank When Null 当Text Field表达式的值为null时显示空白；  
（15）Line Spacing 线距；有3种选择：Single：单倍线距；1 and 1/2：1.5倍线距；Double：双倍线距。  
（16）Rotation 旋转；有3种选择：None 不旋转；Left 左旋180度；Right 右旋180度。  
（17）Styled Text 是一个标志位，用来指定是否text对象包含了已定义风格或规则的text。  
（18）Font Name 字体名；  
（19）Font Size 字体的尺寸；  
（20）Bold 粗体；  
（21）Italic 斜体；  
（22）Underline 下划线；  
（23）Strike Through 通过标准位来取消；  
（24）PDF Font Name：PDF字体名；  
（25）PDF Encoding：PDF编码；  
（26）PDF Embedded是一个标志位，指定是否PDF字体应该嵌入到文档中。

2）条件风格的属性：  
和上面仅有一点点的不同。其不同的属性为：  
Condition Expression 条件表达式；是一个布尔型的表达式，用于判断是否应用条件表达式。

**5****、Section Properties 节属性**  
Section的种类前面已经讲了，这里只是补充讲述它的属性：  
（1）Height 以报告的单位指定的section的高度；  
（2）Print When Expression 是一个布尔表达式，决定是否打印本Section；  
（3）Split Allowed 一个标志位，指示当Section超过当前页面的尺寸时，是否允许分割它。如果为真，当前