Jakarta Commons Digester 简介和具体使用方法

核心提示：1. Digester 就是让你配置一个 xml 转到 java Object 对应的程序, 当一些 XML中特定的属性将会触发一些被称为 rules 的动作, 有一些属性是已经被定义好了,当然你也可以建立自己所需要的. 而 Digester 也包含了以下高级的特性 : *能够嵌入你原本的对应方式, 而不会影响

　　1. Digester 就是让你配置一个 xml 转到 java Object 对应的程序, 当一些 XML
中特定的属性将会触发一些被称为 rules 的动作, 有一些属性是已经被定义好了,
当然你也可以建立自己所需要的. 而 Digester 也包含了以下高级的特性 :

*能够嵌入你原本的对应方式, 而不会影响你的需求.
*自定义(Customized)的 namespace-aware 的执行, 以至于你可以定义 rules 恰当独特的 XML
命名空间.
*将所有的 Rules 放入 RuleSets 可以简单方便地重复使用在其它需要相同类型的项目之中.


2. 使用 Digester 之前, 你必须先拥有一些 libraries 在你的 classpath,
Commons-Digester, Commons-BeanUtils, Commons-Collections, Commons-Logging,
及符合 SAX ( Simple API for XML ) 2.1 的 XML parser 或 JAXP ( Java API for
XML Parsing ) 1.2.1. 我是建议可以去抓 crimson 及 xerces 等等. 当前版本为：1.5
3. Digester 的处理过程 (Rule, XPath, Object Stack)
*建立一个新的对象 // 附注: 假如有两个一上相同属性名称, 因为堆叠会盖掉, 建议不采用
void addObjectCreate(java.lang.String pattern, java.lang.String className, java.lang.String attributeName)


*建立调用 Method
void addCallMethod(java.lang.String pattern, java.lang.String methodName, int paramCount)


*建立调用 Method 传入的参数
void addCallParam(java.lang.String pattern, int paramIndex)


*XML 解析
java.lang.Object parse(java.lang.String uri) throws java.io.IOException, org.xml.sax.SAXException
使用 Digester 内建的规则
ObjectCreate
SetNext
SetPRoperties
SetProperty
CallMethod
FactoryCreate
4. 使用自定义的规则
当你打开原码目录中, org/apache/commons/digester/　下有一个 digester-rules.dtd .
这个 DTD 文件就是在定义 Digester 该如何解析你传入的 XML　文件, 你也可以自己定义相关的
patterns ,　写在 digester-rules.xml 中, 让 Digester　可以根据你的需要去解析数据.
这样做可以减少程序中, 必须非凡写 addObjectCreate, addCallMethod 等等 method.
不过, 我还没有见到目前有任何 project 采用这种做法.

<?xml version="1.0"?>
<!DOCTYPE digester-rules SYSTEM "digester-rules.dtd">

<digester-rules>
<object-create-rule pattern="*/foo" classname="Foo"/>
<set-properties-rule pattern="*/foo"/>
</digester-rules>

5. Struts ActionServlet 中用到的范例
protected void initServlet() throws ServletException {

//.......　省略　.................

// Prepare a Digester to scan the web application deployment descriptor
Digester digester = new Digester();
digester.push(this);
digester.setNamespaceAware(true);
digester.setValidating(false);

//.......　省略　.................
// Register our local copy of the DTDs that we can find
for (int i = 0; i < registrations.length; i += 2) {
URL url = this.getClass().getResource(registrations[i+1]);
if (url != null)
digester.register(registrations[i], url.toString());
}

// Configure the processing rules that we need
// 设置相关的元素和执行规则(rules)的对应
digester.addCallMethod("web-app/servlet-mapping","addServletMapping", 2);
digester.addCallParam("web-app/servlet-mapping/servlet-name", 0);
digester.addCallParam("web-app/servlet-mapping/url-pattern", 1);

InputStream input= null;
try {
// 获取 /WEB-INF/ 下的 web.xml　来作解析

input =
getServletContext().getResourceAsStream("/WEB-INF/web.xml");
digester.parse(input);

} catch (Throwable e) {
log.error(internal.getMessage("configWebXml"), e);
} finally {
if (input != null) {
try {
input.close();
} catch (IOException e) {
;
}
}
}

//.......　省略　.................

/**
* Remember a servlet mapping from our web application deployment
* descriptor, if it is for this servlet.
*
* @param servletName The name of the servlet being mapped
* @param urlPattern The URL pattern to which this servlet is mapped
*/
//当 Digester　在 parse　时将执行 addServletMapping 这个 method
public void addServletMapping(String servletName, String urlPattern) {

if (log.isDebugEnabled()) {
log.debug("Process servletName=" + servletName +
", urlPattern=" + urlPattern);
}
if (servletName == null) {
return;
}
if (servletName.equals(this.servletName)) {
this.servletMapping = urlPattern;
}

}
}

相关书目或相关文章
*Jakarta Commons:
http://jakarta.apache.org/commons/index.Html
*Jakarta Commons Digester:
http://jakarta.apache.org/commons/digester.html
*Simplify XML file processing with the Jakarta Commons Digester :
http://jakarta.apache.org/commons/digester/api/index.html
假如你的英文还可以，可以看看这篇文章：
http://www.javaworld.com/javaworld/jw-10-2002/jw-1025-opensourceprofile.html