文档章节

common digester-入门

gzh412163
 gzh412163
发布于 2014/06/20 14:01
字数 1876
阅读 81
收藏 0


Commons-Digester简介




一.历史

Digester本来仅仅是Jakarta Struts中的一个工具,用于处理struts-config.xml配置文件。显然,将XML文件转换成相应的Java对象是一项很通用的功能,这个工具理应具有更广泛的用途,所以很快它就在Jakarta Commons项目(用于提供可重用的Java组件库)中有了一席之地。



二.几个要点

简言之,Digester由"事件"驱动,通过调用预定义的规则操作对象栈,将XML文件转换为Java对象。工作原理如下:

Digester底层采用SAX解析XML文件,所以很自然的,对象转换由"事件"驱动,即在识别出特定XML元素时(实际被细分为begin、body、end、finish四个时点),将执行特定的动作,比如创建特定的Java对象,或调用特定对象的方法等。此处的XML元素根据匹配模式(matching pattern)识别,而相关操作由规则(rule)定义。在转换过程中,Digester维持了一个对象栈,可以看作对象转换的工作台,用来存放转换中生成的、或是为转换临时创建的Java对象。对输入XML文件作了一趟完整的扫描后,对象栈的栈顶元素即为目标对象。由于Digester屏蔽了SAX解析的细节,使用者仅需关注转换操作本身,大大简化了转换操作。


对使用者而言,Digester的核心在于匹配模式与规则(matching pattern + rule)。


匹配规则示例如下:
   <a>          -- Matches pattern "a"
     <b>        -- Matches pattern "a/b"
       <c/>     -- Matches pattern "a/b/c"
       <c/>     -- Matches pattern "a/b/c"
     </b>
     <b>        -- Matches pattern "a/b"
       <c/>     -- Matches pattern "a/b/c"
       <c/>     -- Matches pattern "a/b/c"
       <c/>     -- Matches pattern "a/b/c"
     </b>
   </a>


Digester提供了一些编程中经常用到的规则(rule),以下五类九个rule较为常用:

A:对象创建
1.ObjectCreateRule   当begin()方法被调用时, 此rule创建相应Java对象, 并将其push到Digester的对象栈上。当end()方法被调用时, 栈顶对象将被pop, Digester内所有对该对象的引用都将失效。
2.FactoryCreateRule     创建Java对象的另一种选择。当待创建的Java对象没有无参构造函数,或需要在创建时需要进行额外的设置时,需要用此rule。


B:属性设置
3.SetPropertiesRule     当begin()方法被调用时, Digester使用标准的Java反射API,将栈顶对象的属性设置为XML元素的同名属性值。
4.SetPropertyRule     当begin()方法被调用时, Digester调用栈顶对象某指定属性的设置方法,设置其值。


C:父子关系管理
5.SetNextRule     当end()方法被调用时, Digester将栈顶元素设置进次栈顶元素中(调用相应的设置方法)。
6.SetTopRule     当end()方法被调用时, Digester将次栈顶元素设置进栈顶元素中(调用相应的设置方法)。


D:任意方法调用
7.CallMethodRule     当end()方法被调用时, Digester将调用栈顶元素指定名称的方法。除了方法名外,此rule还需要配置参数数目,参数类型。参数值一般通过CallParamRule得到。
8.CallParamRule     此rule内嵌于CallParamRule中,按顺序(相对于0)定义了CallParamRule中参数值的来源,可选的来源包括当前XML元素的属性或内容。


E:其它
9.NodeCreateRule     将XML文件树的一部分转换为DOM节点,并push到Digester的对象栈上。


在基本使用中,使用者通过调用Digester类的相关方法,来创建匹配模式与规则的映射序列。比如,调用addSetProperties(String pattern),向Digester中加入SetPropertiesRule。




三.如何使用?

基本步骤如下:
1.创建Digester对象实例。
2.设置该Digester对象的配置属性(可选)。
3.将需要的初始对象push到该Digester对象的对象栈上(可选)。
4.需要注册所有的XML元素匹配模式与处理规则之间的映射关系。
5.用digester.parse()解析的XML文档对象,得到目标对象。



下面是一个简单示例:
1.foo.xml   数据源文件
2.Foo.java   目标Java对象
3.Bar.java   目标Java对象
4.Entry.java   调用Digester的入口类

【foo.xml】
<?xml version="1.0" encoding="GBK"?>
<foo name="The Parent">
     <bar id="123" title="The First Child"/>
     <bar id="456" title="The Second Child"/>
</foo>

【Foo.java】
package org.easev.digester;

import java.util.HashMap;
import java.util.Iterator;

public class Foo {

     private String name;

     public void setName(String name) {
         this.name = name;
     }

     public String getName() {
         return name;
     }

     private HashMap bars = new HashMap();

     public void addBar(Bar bar) {
         bars.put(String.valueOf(bar.getId()), bar);
     }

     public Bar findBar(int id) {
         return (Bar) bars.get(String.valueOf(id));
     }

     public Iterator getBars() {
         return bars.keySet().iterator();
     }
}

【Bar.java】
package org.easev.digester;

public class Bar {

     private int id;

     public int getId() {
         return id;
     }

     public void setId(int id) {
         this.id = id;
     }

     private String title;

     public String getTitle() {
         return title;
     }

     public void setTitle(String title) {
         this.title = title;
     }
}

【Entry.java】
package org.easev.digester;

import java.io.File;
import java.util.Iterator;

import org.apache.commons.digester.Digester;

public class Entry {

     public static void main(String[] args) throws Exception {
         //相对路径定义与包名相关
         File input = new File("org/easev/digester/foo.xml");
         Digester digester = new Digester();
         digester.setValidating(false);

         //完整类名定义,包名改变时需做相应变化
         digester.addObjectCreate("foo", "org.easev.digester.Foo");
         digester.addSetProperties("foo");
         digester.addObjectCreate("foo/bar", "org.easev.digester.Bar");
         digester.addSetProperties("foo/bar");
         digester.addSetNext("foo/bar", "addBar", "org.easev.digester.Bar");

         Foo foo = (Foo) digester.parse(input);

         //测试装载是否成功
         Iterator iter = foo.getBars();
         while (iter.hasNext()) {
             System.out.println((String) iter.next());
         }
     }

}

匹配模式没有什么文章好做,那么下面要讨论的就必然是规则了。在基本的使用方式下,Digester虽然使用XML文件定义Java对象的状态,提高了系统的灵活性,但是匹配模式与规则的映射序列(装载逻辑)仍然通过硬编码来定义,这种方式不易修改与重用。所以Digester还提供了一种高级的使用方式,用一个XML文件定义Java对象的状态(数据源文件),用另一个XML文件定义装载数据源文件的装载逻辑。


这样,对象的装载过程分成了两步:
1.装载逻辑的"装载",其结果表现为定义了rule的Digester;
2.根据上一步得到的Digester,装载目标对象。

套用上面的一个例子,增加了rule.xml,并改写了Entry.java

【rule.xml】
<?xml version='1.0'?>
<!DOCTYPE digester-rules 
   PUBLIC "-//Jakarta Apache //DTD digester-rules XML V1.0//EN" 
     "">

<digester-rules>
   <pattern value="foo">
     <object-create-rule classname="org.easev.digester.Foo"/>
     <set-properties-rule/>
     <pattern value="bar">
       <object-create-rule classname="org.easev.digester.Bar"/>
       <set-properties-rule/>
       <set-next-rule methodname="addBar"/>
     </pattern>
   </pattern>
</digester-rules>

【Entry.java】
package org.easev.digester;

import java.io.File;
import java.util.Iterator;

import org.apache.commons.digester.Digester;

public class Entry {

     public static void main(String[] args) throws Exception {
         //相对路径定义与包名相关
         File data = new File("org/easev/digester/foo.xml");
         File rule = new File("org/easev/digester/rule.xml");
         Digester digester = DigesterLoader.createDigester(rule.toURL());
         Foo foo = (Foo) digester.parse(data);
        
         //测试装载是否成功
         Iterator iter = foo.getBars();
         while (iter.hasNext()) {
             System.out.println((String) iter.next());
         }
     }

}

我们可以看到,使用Digester的代码变得相当简洁,而要付出的代价就是为装载逻辑写一个配置文件。



四.其他的替代技术

除了Digester之外,当然还有其它的方法来实现Java对象的绑定与装载:
1.java.util.Properties,简单的配置属性(比如数据库连接信息),可以写在properties文件中,调用Properties对象的load(InputStream)方法将配置中的健值对加载到Properties对象中。这种方式一般仅适用于简单的配置信息的加载。
2.JAXB,Java Architecture for XML Binding,在Java Web Services Developer Pack V 1.1中提供了一个参考实现。使用这种方式时,除了提供数据源XML文件之外,还必须提供相应的Schema文件。加载前,首先用Binding Compiler将Schema转换得到目标Java类的接口与实现,然后再调用Unmarshaller或Marshaller将数据源XML文件信息加载到Java对象中,或将设置的Java对象数据导出为XML文件。 
3.XPath 
4.JaxMe



本文转载自:http://hi.baidu.com/leilei1334/item/c9eced0f052ed36dd55a1178

共有 人打赏支持
gzh412163
粉丝 1
博文 69
码字总数 12796
作品 0
深圳
私信 提问
Tomcat的配置解析工具Apache Commons Digester

开篇  最近开始看Tomcat的源码,在catalina. createStartDigester方法中,Tomcat开发人员采用了Digester来读取conf/server.xml文件,以前读取xml文件一般采用Dom4j和SAX,因此对Digester比较...

晴天哥
10/10
0
0
Apache Commons Digester 3.0 发布

Apache Commons Digester 3.0 几乎重写了整个 Digester 实现,包括一个统一的加载器、可重用的 Digester 配置以及使用 EDSL 定义的表达式规则、改进了错误报告信息等。 除此之外,还包括以下...

红薯
2011/07/07
1K
0
Apache Commons Digester 3.2 发布

Digester 3.2 发布了,Digester 是一个基于规则的XML文档解析库,主要用于XML到Java对象的映射。Struts就是用Digester来处理XML配置文件的。而且Digester还包含一个写好的RSS解析器。 该版本主...

红薯
2011/12/15
2.4K
3
XML文档解析器--Digester

Digester基于规则的XML文档解析,主要用于XML到Java对象的映射。Struts就是用Digester来处理XML配置文件的。而且Digester还包含一个写好的RSS解析器。 Maven: <dependency> <groupId>org.apa...

匿名
2008/09/09
12.5K
0
tomcat6.0.x启动过程-tomcat 6.x 源码阅读

2013-09-07 周末来啊,宅的日子又到了...我们知道tomcat的基本是容器,通过容器来完成servlet容器的设计。从上一篇blog中看到了tomcat的结构框架图,图中容器嵌套,组件组合,tomcat如何设置...

douglaswei
2013/09/07
0
2

没有更多内容

加载失败,请刷新页面

加载更多

传播正能量——《海南英才》阅读的读后感2200字

传播正能量——《海南英才》阅读的读后感2200字: 新华社记者12月8日从公安部获悉,针对自媒体“网络水军”敲诈勒索等违法犯罪活动突出问题,今年以来,公安部组织各地公安机关依法深入开展侦...

原创小博客
15分钟前
1
0
Confluence 6 对一个空间进行归档后产生的影响

空间 如果一个空间被归档: 将不会在查找结果中显示,除非你选择 在归档空间中查找(Search archived spaces)。如果没有归档空间的话,这个功能是隐藏的。 页面和内容将不会在 Confluence 的...

honeymose
17分钟前
2
0
java框架学习日志-2

上篇文章(java框架学习日志-1)虽然跟着写了例子,也理解为什么这么写,但是有个疑问,为什么叫控制反转?控制的是什么?反转又是什么? 控制其实就是控制对象的创建。 反转与正转对应,正转...

白话
今天
4
0
Integer使用双等号比较会发生什么

话不多说,根据以下程序运行,打印的结果为什么不同? Integer a = 100;Integer b = 100;System.out.println(a == b);//print : trueInteger a = 200;Integer b = 200;System.out.pr...

兜兜毛毛
昨天
10
0
CockroachDB

百度云上的CockroachDB 云数据库 帮助文档 > 产品文档 > CockroachDB 云数据库 > 产品描述 开源NewSQL – CockroachDB在百度内部的应用与实践 嘉宾演讲视频及PPT回顾:http://suo.im/5bnORh ...

miaojiangmin
昨天
6
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部