利用Digester把XML转换为Java对象

在一个比较完整的应用系统里,经常需要有一些配置文件。简单的属性使用.properties文件即可,但要配置一些复杂对象,则应该考虑使用xml文件。一般用来读取xml文件的工具包有dom、sax和jdom等,但用过的人都知道,它们属于比较底层的api,写起来代码量很大,而且如果修改了xml文件的格式,代码也要做大幅度的改动。jakarta commons项目里的digester包,可以轻松实现xml文件到java对象的转换,看下面这个例子。

在一个项目里,需要提供一些统计图,但图的内容暂时未能确定。所以我决定让图可以配置,所有定义保存在一个名为charts.xml(或国际化后的文件名如charts_zh_cn.xml,这里只考虑缺省语言)的文件内,下面是该文件的部分内容:

xml version="1.0" encoding="utf-8" ?>

charts>

chart id="barchart1" >

title>统计图一title>

legendvisible>falselegendvisible>

tooltipsvisible>truetooltipsvisible>

type>bartype>

labelx>时间labelx>

labely>数据labely>

width>500width>

height>360height>

hql>select count(c),c.department.name from edu.pku.pub.aims.model.business.client c group by c.departmenthql>

description>description>

chart>

charts>

可以看出,我为每个图定义了id、title、legendvisible等等属性,这些属性的意义都很明显,它们将影响统计图的数据和在页面中的表现。在程序里,我需要把这个文件里的定义读到一个注册表类chartregistry里,该注册表维护一个java.util.list类型的registry变量,其中每个元素是一个chartconfig类。现在digester该显示它的价值了。

为了方便使用digester,我们让chartconfig也具有统计图的每个属性(id、title、legendvisible等等),名称与charts.xml里的元素的属性(子元素)一一对应,并且都具有getter和setter方法,也就是说,chartconfig是一个bean类。在chartregistry类里定义一个deregister()方法,它的作用是用digester读入并解析指定的xml文件,代码如下;还有一个register()方法用来把chartconfig对象加到registry里。

public void deregister(url url) throws ioexception,saxexception{

inputstream is = new fileinputstream(url.getfile());

digester digester = new digester();

digester.push(this);

digester.setvalidating(false);

digester.addobjectcreate("charts/chart", chartconfig.class);

digester.addsetproperties("charts/chart");

digester.addbeanpropertysetter("charts/chart/legendvisible");

digester.addbeanpropertysetter("charts/chart/tooltipsvisible");

digester.addbeanpropertysetter("charts/chart/title");

digester.addbeanpropertysetter("charts/chart/type");

digester.addbeanpropertysetter("charts/chart/labelx");

digester.addbeanpropertysetter("charts/chart/labely");

digester.addbeanpropertysetter("charts/chart/width");

digester.addbeanpropertysetter("charts/chart/height");

digester.addbeanpropertysetter("charts/chart/hql");

digester.addbeanpropertysetter("charts/chart/description");

digester.addsetnext("charts/chart","register");

digester.parse(is);

collections.sort(registry);

}

基本上来说,digester和sax解析xml的过程很像,它的原理就是制定一些规则,在遍历每个节点时检查是否有匹配的规则,如果有就执行对应的操作。例如,上面的代码中,“digester.addobjectcreate("charts/chart", chartconfig.class);”这一句的作用是告诉digester:如果遇到匹配“charts/chart”形式的节点,就执行一个“对象创建”操作,创建什么对象呢,应该创建class为“chartconfig.class”的对象;类似的,addsetproperties()是告诉digester将指定节点的属性全部映射到对象的属性,在这个例子里指的就是id属性;addbeanpropertysetter()是将子节点转换为对象的属性,这个方法还可以有第二个参数,当对象的属性名和子节点的名字不一样时用来指定对象的属性名;addsetnext()是说在遇到匹配节点后,对当前对象的父对象执行一个方法,参数是当前参数,对这个例子来说就是执行chartconfig.register(chartconfig)方法。因此这样构造得到的digester会把charts.xml里的每个元素转换为一个chartconfig对象,并register到chartregistry里。

顺利得到了chartregister对象,我就可以在程序里根据它的内容构造统计图了(统计图一般使用jfreechart来生成,这里就不赘述了)。与digester具有类似功能的工具包其实还有不少,例如caster、jato等等,我没有实际使用过它们,但因为我对用过的jakarta其他项目都很满意(例如beanutils、httpclient,品牌效应?),所以一开始就选择了digester:简单方便。

======================================================
在最后，我邀请大家参加新浪APP，就是新浪免费送大家的一个空间，支持PHP+MySql，免费二级域名，免费域名绑定 这个是我邀请的地址，您通过这个链接注册即为我的好友，并获赠云豆500个，价值5元哦！短网址是http://t.cn/SXOiLh我创建的小站每天访客已经达到2000+了，每天挂广告赚50+元哦，呵呵，饭钱不愁了，\(^o^)/