Java XML解析之Digester的使用

Digester據說最早是為解析struts的配置文件開發的，后來慢慢的就發展成一個輕量，快速，單向(只能從xml到java對象)的一個綁定框架，在運行時實現綁定，無需定義xml文件的DTD或Schema，簡單快速。

一、使用Digester的步驟

1． 創建一個Digester的實例。完成parse后，實例可以被安全的重用，但實例不是線程安全的。

2． 設置配置屬性

3． 加入處理規則

4． 調用digester.parse()方法。

二、從一個例子說起

先看一個Digester文檔上的簡單例子

對象樹

package mypackage;

public class Foo ...{

public void addBar(Bar bar);

public Bar findBar(int id);

public Iterator getBars();

public String getName();

public void setName(String name);

}

package mypackage;

public class Bar ...{

public int getId();

public void setId(int id);

public String getTitle();

public void setTitle(String title);

}

XML文檔片段

解析代碼

Digester digester = new Digester();

digester.setValidating(false);

digester.addObjectCreate("foo", "mypackage.Foo");

digester.addSetProperties("foo");

digester.addObjectCreate("foo/bar", "mypackage.Bar");

digester.addSetProperties("foo/bar");

digester.addSetNext("foo/bar", "addBar", "mypackage.Bar");

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

從例子可以看到Digester的執行步驟是掃描xml文檔，匹配特定的xml節點，在每一個節點按照預定的處理規則操縱對象，包括創建對象，設置對象屬性，建立對象樹等。

三、節點匹配規則

-- Matches pattern "a"           -- Matches pattern "a/b"          -- Matches pattern "a/b/c"          -- Matches pattern "a/b/c"               -- Matches pattern "a/b"          -- Matches pattern "a/b/c"          -- Matches pattern "a/b/c"          -- Matches pattern "a/b/c"        可以看到匹配規則非常簡單，此外，匹配還支持通配符，像*/a就匹配任意層次內的。

一個特定的XML元素可以被匹配多次，所對應的處理規則執行的順序如下：如果是begin和body方法，按照規則被加入到Digester的順序執行，如果是end方法，則相反(參見后面處理規則)。

對於通配符匹配，當一個確定的匹配發生時(如果多個通配符匹配發生，最長的一個被認為是一個確定的匹配)，通配符匹配將被忽略。這個意思就是說，當規則A被加入到*/a時，意思是這個規則匹配任意一個元素，但是如果規則C被加入到x/a,則A對於

Rule ruleA = new ObjectCreateRule();  Rule ruleB = new SetNextRule();  Rule ruleC = new SetPropertiesRule();  digester.addRule("*/a", ruleA);  digester.addRule("*/a", ruleB);digester.addRule("x/a", ruleA);  digester.addRule("x/a", ruleB);  digester.addRule("x/a", ruleC);

四、處理規則

處理規則的目的就是定義當匹配發生時做什么事情。每一個處理規則都是org.apache.commons.digester.Rule接口的實現類。當匹配發生時Rule接口的回調方法被調用，執行相應的操作。

Rule接口的方法：

begin       當進入匹配元素時調用

body        當進入匹配元素的內容時調用

end         當離開匹配元素時調用

finish      當paser結束時調用

常見的內置處理規則

ObjectCreateRule：進入匹配元素時調用，創建一個特定的java對象。

SetPropertiesRule：進入匹配元素時調用，利用Java的反射API設置棧頂對象的屬性，要求Java對象的屬性名匹配XML元素的屬性名。

SetNextRule：離開匹配元素時調用，digester分析下一個棧頂對象，調用該對象的指定屬性的setter方法，將當前棧頂對象作為參數傳入到該方法，同時彈出當前棧頂對象。

SetTopRule：和SetNextRule含義相同，分析棧頂對象，調用該對象指定屬性的setter方法，將下一個棧頂對象作為參數傳給該方法(典型會被調用的方法是setParent)。

CallMethodRule：調用棧頂對象指定的方法。設置這個規則需要指出調用的方法名，參數個數，參數Java類型(可選)，參數值一般是匹配元素的body content，用CallParamRule指定。

CallParamRule ：標識CallMethodRule中的方法參數。參數值可能是匹配元素的某個屬性，或匹配元素的body content。

Digester的處理過程

Digester使用堆棧來存儲對象，當ObjectCreateRule被執行時，將對象壓入棧，像SetPropertiesRule，SetTopRule，CallMethodRule等規則都是對棧頂對象的操作。當SetNextRule被執行時，彈出棧頂對象，下一個棧頂對象成為棧頂對象，最后返回對象樹的根節點。

Digester詳細描述參見http://commons.apache.org/digester/commons-digester-1.8/docs/api/org/apache/commons/digester/package-summary.html#doc.Description