BIRT：基于 Eclipse 的报表

luliangok

浏览: 780577 次

最近访客更多访客>>

mianjifen_mianjifen

当流量成为永恒

i221bci

mr_zhang2011

博主相关

博客

微博

相册

留言

关于我

文章分类

全部博客 (1463)

社区版块

存档分类

级别：初级

键胡 (jianhgreat@hotmail.com), 西安交通大学硕士

2006 年 3 月 22 日

几乎在各种应用中，报表都具有其不可替代的作用。各类报表软件也是争奇斗艳，如今Eclipse也推出了自己的报表框架：BIRT。现在，让我们不妨看看它到底提供了什么样的功能，以及特点是什么。

安装介绍

对于扩展 Eclipse 的功能，首先当然就是去下载对应的 plugin，BIRT 也不能例外。BIRT 的下载地址：http://download.eclipse.org/birt/downloads/，当前版本是2.0。BIRT 依赖于 Eclipse 的其它几个 plugin（GEF 和 EMF），由于我使用的是 Eclipse WTP（这是 Eclipse 的 WEB 开发工具），在这个工具中那些 plugin 都已预装，因此直接下载 birt-report-framework-2_0_0.zip 就好了。如果没有这些 plugin，请下载。

下载之后，安装非常简单：只需解压然后将对应的features和plugins目录中的内容复制到Eclipse对应的目录下即可。且慢，这只是完成了对于BIRT的基本安装。下一步就是去下载BIRT需要的第三方软件包：

需要的jar文件复制位置（都在plugins目录下） Apache Axis iText 1.3 prototype.js v1.4.0

axis.jar axis-ant.jar commons-discovery-0.2.jar jaxrpc.jar saaj.jar wsdl4j-1.5.1.jar	org.eclipse.birt.report.viewer_version/birt/WEB-INF/Lib
itext-1.3.jar	org.eclipse.birt.report.engine.emitter.pdf_version/lib
prototype.js v1.4.0	org.eclipse.birt.report.viewer_version/birt/ajax/lib

自此，BIRT的安装大功告成。启动Eclipse，在"project wizard"中会出现一个BIRT的项目类型。

回页首

典型使用

在使用之前，了解一些关于BIRT的基本概念，将会对使用非常有益：

数据源：数据的来源，或提供者。如xml数据源、jdbc数据源等。
数据集：数据集合，它必须与数据源关联，可以理解为查询的结果。
报表以及报表项，报表可视为是针对一组数据集的表现形式，而报表项这是这个表现形式的某个具体的单元。它们之间的关系，与窗体和控件的关系非常类似。报表、数据集、数据源三者间的关系：数据源 --- 数据集 --- 报表。
报表参数：查询参数的表现形式，使用它可以构建更灵活的报表。
模板和库：主要用于复用报表设计，提高报表开发的效率。

本文中的例子都采用jdbc数据源，这是最常见的使用情形，其中涉及的数据关系是一个典型的多对多关系：

1. 简单报表

首先，让我们来看看一个"Hello World"级别的应用："列出所有用户"，以便可以快速的了解BIRT。为了完成这一任务，我们需要：

A. 通过项目向导，创建BIRT工程。工程创建完毕之后，显示BIRT的"报表设计"视图。由于此时没有报表，其它几个视图，如"数据资源管理器"，不可用。

B. 在项目上点鼠标右键，选择："new -> 报表"。在报表类型中，选择"空白报表"。

C. 创建新报表后，数据视图可用。在"数据资源管理器"中创建报表所需要的jdbc数据源。根据向导，可以方便的添加jdbc驱动、数据库url、用户名和密码。

D. 在指定的数据源上，创建数据集，这一步完成产生数据集的查询。在BIRT中支持2种数据集：基于查询语句和基于存储过程。在本例中使用前者，对应的查询语句是：select user.userid, user.username, user.addr from user。

E. 选择刚刚创建的数据集，将它拖至空白报表页上。BIRT会自动为其创建一个报表项，此处是"表"。如下图：

F. 选择预览，就可以看到报表运行的实际结果了。或在报表上点击鼠标右键，选择："报表 -> 运行报表"。

非常简单，一个显示所有用户信息的报表就完成了。在此基础之上，让我们再来完成一些其它具有挑战性的任务：

1.格式化：这是一个内容广泛的主题，常见的需求：

需求解决办法（以上为例）显示报表列头为中文设置报表外观对于报表数据列进行处理分页页眉和页脚

如：将userid显示为"用户标识"。选择"userid"，输入"用户标识"。
选择对应的报表项，通过"属性编辑器"调整。
如：将userid和username，显示成：userid：username。双击row["userid"]，出现"表达式生成器"，输入： `row["userid"]+"："+ row["username"]`
选择"表"：在"属性编辑器"中，选择"分页符"，在"分页符间隔"中输入分页大小。
在报表设计页，选择"主页"，在其中设置页眉和页脚。

2.排序：一种变通的做法是：将数据集排序之后，如在对应的SQL语句中使用order by，再显示。除此之外，也可以在报表设计时来完成：

A. 选择表，此时属性编辑器下方会出现与表相关的选择页。

B. 选择"排序"，在对应的页面中选择"添加"按钮之后，出现：

C. 选择需要进行排序的列，以及排序方式。

3.计算列：通过"数据集编辑器"来完成。进入"数据集编辑器后"，选择"计算列"：输入对应的"列名称"、"数据类型"和"表达式"。

4.报表参数：它为报表的产生带来了极大的灵活性。报表参数一定是与含参数的查询对应的，否则失去了意义。现在，将以上需求改为列出"用户标识大于某一输入的所有用户"：

A. 编辑数据集，修改SQL：select user.userid,user.username,user.addr from user where user.userid>?。

B. 在数据集编辑窗体内选择"参数"，然后输入对应的"名称"、"数据类型"、"方向"和"默认值"（必须给出默认值）。其中"方向"表示"输入"或"输出"。对于参数，一般选"输入"。完毕之后：

C. 在"数据资源管理器"视图，创建报表参数："用户标识"。

D. 选择"表"，在"属性编辑器"中选择"绑定"。此时，会出现刚才在数据集中定义的参数"id"。在"值"列，选择报表参数"用户标识"：

E. 运行报表时，此时会出现报表参数的输入框，填写值后即出现报表结果。

本例虽然只定义了一个报表参数，但是BIRT并没有这样的限制。我们可以创建多个参数，做法很简单：首先，查询有多个参数；定义数据集的参数时，按照查询中参数出现的顺序定义；最后，添加需要的报表参数。

5.分组：以上为例：将用户按地址分组。

A. 选择"表"，点击鼠标右键，选择"插入组"。这里有两个选择："在上面"和"在下面"。

B. 选择任意一种，弹出分组资料窗体。填写其中的："名称"和"分组依据"。在本例中，"分组依据"是addr列。

C. 选择预览，或运行报表，查看结果。

2. 子报表

子报表是另一种最常见的报表，以上为例：列出所有用户，并列出每个用户所购买的项目，以及项目数。为了完成这种父子关系的报表，需要：

A. 创建新报表和数据源。

B. 创建数据集user，使用SQL：select user.userid,user.username,user.addr from user。

C. 创建数据集items，使用SQL：

select item.itemid,item.itemdesc,item.price,user_item.count from item,user_item
where item.itemid= user_item.itemid
  and user_item.userid= ?

同时在数据集items上创建参数user，它对应SQL中的参数。

D. 从"Palette"视图拖入"列表"到报表中，在"属性编辑器"的"绑定"页中，选择数据集为user。它用来显示主表的信息，在本例中是用户信息。

E. 从"Palette"视图拖入"网格"到"列表"的"明细数据"中，设置网格为1行2列，它用来存放"用户姓名"和"用户地址"。在"数据资源管理器"视图，选择数据集user，将username和addr分别拖入网格的2列中。

F. 在"数据资源管理器"视图，选择数据集items，将它拖入"列表"的"明细数据"中，位于刚刚插入的网格下方。此时，BIRT会生成数据集items对应的"表"。

G. 选择刚刚生成的"表"，在"属性编辑器"的"绑定"页中，会出现在items中定义的参数。修改它的值：row["userid"]。于是，父子报表就发生了联系。

H. 选择预览，或运行报表，就可以看到结果了。

很遗憾，到目前为止，另一种最常见的报表"交叉表"还不被BIRT支持。但是，BIRT的官方网站已明确表示，将在未来的版本中支持它。

3. 统计图表

俗话说，"一图顶千言"。没有图的报表是枯燥，且缺乏表现力的。在本例中，我们将使用图表来表示：每个用户的消费总数。

A. 创建新报表和数据源。

B. 创建数据集chart，使用SQL：

select user.username,round(sum(item.price*user_item.count),2)
from item, user_item, user
where item.itemid= user_item.itemid
  and user.userid= user_item.userid
group by user.username

C. 从"Palette"视图拖入"图表"到报表中，此时会弹出"编辑图表"窗体。

D. 在"选择图表类型"页，选择图表类型为"条形图"。在"选择数据"页，使用数据集chart，同时选中username列，将其拖入"类别x系列"。对于统计列，同样将其拖入"类别y系列"。在"图表格式"页，分别为x和y系列，填写相应的显示名称。

E. 选择预览，或运行报表，即可看到统计图表。

4. 使用脚本

可以使用脚本，是BIRT的一大特色。在BIRT中，数据源、数据集和报表项，都可以书写脚本。具体做法：选择数据源、数据集和报表项任意一种对象，然后选择"脚本"页面。如选择数据源user后，对应的脚本输入页面：

选择对应的事件，然后在下方的脚本输入框中输入脚本即可。如对于第一个例子，我们需要统计用户地址是"No.5 St."的用户数：

A. 选择数据集，然后选择"脚本"，进入数据集的脚本编辑窗口。

B. 选择事件"afterOpen"，在脚本窗口内输入：count=0;

C. 选择事件"onFetch"，在脚本窗口内输入：if( row["addr"]== "No.5 St.") count++;

D. 选择报表，在脚本窗口选择事件"onRender"，输入：this.caption=count;

E. 预览，或运行报表后，会在报表的标题输出count的数值。

另外，BIRT也支持使用java来作为报表项的事件处理程序。具体做法，请参见BIRT的帮助文档。

5. 库和模板

除了脚本使开发者可以自定义报表的行为外，BIRT还提供了库和模板机制来重用设计，加快报表的开发。在TheServerSide上有一篇相当详细的文档：Using Eclipse BIRT Report Libraries and Templates。

回页首

应用集成

BIRT与现有应用的集成非常简单，由于BIRT主要是web应用，本节以web应用为例进行说明。

1. 从Eclipse BIRT官方网站下载birt-runtime-2_0_0.zip。

2. 解压之后，只需要其中的web view example目录下的内容。

3. 复制以下第三方软件包到web view example目录：

需要的jar文件复制位置 Apache Axis iText 1.3 prototype.js v1.4.0

axis.jar axis-ant.jar commons-discovery-0.2.jar jaxrpc.jar saaj.jar wsdl4j-1.5.1.jar	WEB-INF/Lib
itext-1.3.jar	Plugins/org.eclipse.birt.report.engine.emitter.pdf/lib
prototype.js v1.4.0	ajax/lib

4. 将web view example目录发布到web容器中，如tomcat，改名：birtApp。

5. 启动tomcat，并访问birtApp。在首页中选择"View Example"，如果成功发布，系统将提示成功。

6. 发布设计完成的报表文件，在birtApp中创建reports目录，用于存放报表设计文件。

7. 在应用中通过：http://localhost:8080/birtApp/frameset?__report=报表文件路径，就可以访问报表了。

这个web应用支持2个动作：

frameset，以frameset的形式显示报表。这个界面包含一些frame，如页面导航，报表主体在其中的一个frame中显示；使用形式：
http://localhost:8080/birtApp/frameset?__report=报表文件路径&参数=........
run，报表以一个单独的html页面或pdf显示，由于这种形式没有frmaeset，因此使用者必须自己提供相应的参数，如报表参数，页号等。使用形式：
http://localhost:8080/birtApp/run?__report=报表文件路径&参数=........

对于以上2个动作，以下列出可用的参数：

选项说明 __format __isnull __locale __report 报表参数

报表输出格式：html或pdf，缺省是html。对于frameset不起作用。
指明一个参数是null，常用于字符串类型。如果提供参数且值为空： - 对于日期和数字类型，BIRT会将它们当作null处理。 - 对于字符串，BIRT会将它作为空字符串。因此，为了说明某个字符串是null，通常写为：__isnull=参数。
本地化选项，缺省是jvm的locale。
报表设计文件路径。
报表参数参数值对，形式：参数名=参数值。对于frameset，直接在地址栏中输入参数名=参数值后回车，不会影响报表结果。虽然，此时选择"运行报表"时，弹出的参数值已经改变。

虽然本节所说的是针对web应用的集成，但是这种方法同样也可与非web应用集成。此时，我们可以采取一种变通的方法：在非web应用中使用内嵌的web容器，如jetty，也可达到同样的效果。这种做法和Eclipse的做法类似。还记得在报表设计时使用"报表 -> 运行报表"吗？那个弹出的窗体，实际就是一个web页面。

回页首

结论

与一些老牌报表软件相比，BIRT可能仍显稚嫩。然而，它也不乏其独到之处，如脚本控制、库和模板。加之有世界领先的报表厂商Actuate支持，实际上BIRT的ROM（Report Object Model）就是Actuate捐献的，我们有充分的理由对BIRT的前景表示乐观。

参考资料

BIRT官方网站 http://www.eclipse.org/birt/phoenix/
BIRT and POJOs as datasources example http://tools.osmosis.gr/blog/archives/2005/06/birt_and_object.html
Using Eclipse BIRT Report Libraries and Templates http://www.theserverside.com/articles/article.tss?l=EclipseBRT

关于作者


		胡键，西安交通大学硕士，2000 年毕业后一直从事软件开发。2002 年开始使用 Java，在平时的项目开发中经常采用 OpenSource 的工具，如 Ant、Maven、Hibernate、Struts 等，目前正在研究信息集成方面的规范和技术。可以通过jianhgreat@hotmail.com与他取得联系，或访问个人 blog：http://blog.donews.com/foxgem/。