Digester框架屬于Jakarta Commons，它以規則和模式為基礎處理XML文檔。與SAX和DOM之類的標準API相比，Digester不涉及太多的細節問題，非常適合于對XML文檔進行簡單的處理。

在Java和XML開發中，一個常見的任務是把XML文檔轉換成對應的Java Bean對象的層次結構。人們經常用標準的SAX和DOM API來完成這個任務。雖然這兩種API都很強大和靈活，但對于某些簡單的任務來說，它們顯得操作層次太低，也就是說，涉及了太多的細節問題。Jakarta Digester框架能夠很好地滿足這類場合的需要。

Jakarta的Digester框架從Struts框架發展而來，原先被用來處理struts-config.xml配置文件，但很快人們認識到它有著更廣泛的用途，把它轉入了Jakarta Commons項目。Jakarta Commons的目標是提供一個“可重用Java組件的倉庫”。Digester最新的版本是1.3，于2002年8月13日發布。

Digester框架允許開發者指定一組動作，當解析器在XML文檔中發現某些特定的簡單模式時動作被執行。Digester框架帶有10個預定義的規則（Rule），涵蓋了unmarshalling XML（例如創建Bean或設置Bean屬性）的大多數需求（ marshalling的原意是指“配制整齊，編組列車”，marshalling是在內存中為Java對象生成XML描述文檔的過程，而unmarshalling是指把XML形式的描述轉換到可用Java代碼操作的對象的過程，我們稱之為“反配制”），但必要時用戶可以定義和實現自己的規則。

在本文的例子中，我們將反配制下面這個XML文檔：

<?xml version="1.0"?> <catalog library="somewhere"> <book> <author>Author 1</author> <title>Title 1</title> </book> <book> <author>Author 2</author> <title>His One Book</title> </book> <magazine> <name>Mag Title 1</name> <article page="5"> <headline>Some Headline</headline> </article> <article page="9"> <headline>Another Headline</headline> </article> </magazine> <book> <author>Author 2</author> <title>His Other Book</title> </book> <magazine> <name>Mag Title 2</name> <article page="17"> <headline>Second Headline</headline> </article> </magazine> </catalog>

下面是Bean的代碼。注意使用Digester框架時，Bean類必須定義成public。

import java.util.Vector; public class Catalog { private Vector books; private Vector magazines; public Catalog() { books = new Vector(); magazines = new Vector(); } public void addBook( Book rhs ) { books.addElement( rhs ); } public void addMagazine( Magazine rhs ) { magazines.addElement( rhs ); } public String toString() { String newline = System.getProperty( "line.separator" ); StringBuffer buf = new StringBuffer(); buf.append( "--- Books ---" ).append( newline ); for( int i=0; i<books.size(); i++ ){ buf.append( books.elementAt(i) ).append( newline ); } buf.append( "--- Magazines ---" ).append( newline ); for( int i=0; i<magazines.size(); i++ ){ buf.append( magazines.elementAt(i) ).append( newline ); } return buf.toString(); } } //=================================================== public class Book { private String author; private String title; public Book() {} public void setAuthor( String rhs ) { author = rhs; } public void setTitle( String rhs ) { title = rhs; } public String toString() { return "Book: Author='" + author + "' Title='" + title + "'"; } } //=================================================== import java.util.Vector; public class Magazine { private String name; private Vector articles; public Magazine() { articles = new Vector(); } public void setName( String rhs ) { name = rhs; } public void addArticle( Article a ) { articles.addElement( a ); } public String toString() { StringBuffer buf = new StringBuffer( "Magazine: Name='" + name + "' "); for( int i=0; i<articles.size(); i++ ){ buf.append( articles.elementAt(i).toString() ); } return buf.toString(); } } //=================================================== public class Article { private String headline; private String page; public Article() {} public void setHeadline( String rhs ) { headline = rhs; } public void setPage( String rhs ) { page = rhs; } public String toString() { return "Article: Headline='" + headline + "' on page='" + page + "' "; } }

1 2 下一頁>>

Digester框架以模式（Pattern）和規則（Rule）為基礎處理輸入的XML。模式必須與XML元素匹配，包括其名字和在文檔樹內的位置。描述匹配模式的語法類似于XPath匹配模式，例如：catalog模式匹配頂層的<catalog>元素，catalog/book模式匹配直接嵌套在<catalog>元素內的<book>元素（但不匹配文檔內其他位置的<book>元素）。

所有的模式都必須指定其完整名稱——從根元素開始的完整路徑。唯一的例外是包含通配符（“*”）的模式，例如*/name模式匹配XML文檔內任何位置的<name>元素。但是根元素不必特別指出，因為所有的路徑都是從根元素開始的絕對路徑。

當Digester發現一個指定的模式，它就執行關聯的任務。由此可見，Digester框架顯然與SAX解析器有著密切的關系（實際上，Digester類實現了org.xml.sax.ContentHandler，并維護著解析棧）。所有在Digester中使用的規則必須擴展org.apache.commons.digester.Rule，后者本身提供了一些類似于SAX的ContentHandler回調函數的方法。例如，當遇到匹配元素的開始標記和結束標記時，begin()方法和end()方法將分別被調用。

一旦遇到匹配元素的內容，body()方法被調用；最后被調用的方法是finish()，這個方法在匹配元素的結束標記處理完畢之后被調用，用來執行可能需要的事后清理任務。然而，大多數時候我們不必關注這些方法，因為框架提供的標準規則很可能已經提供了所有必需的功能。

要反配制一個文檔，首先創建一個org.apache.commons.digester.Digester類的實例，如果必要的話，進行一些配置操作，指定必需的模式和規則，最后向parse()方法傳遞一個XML文件的引用。下面的DigesterDriver示范了這一處理過程（必須在命令行上指定輸入XML文檔的名稱）。

import org.apache.commons.digester.*; import java.io.*; import java.util.*; public class DigesterDriver { public static void main( String[] args ) { try { Digester digester = new Digester(); digester.setValidating( false ); digester.addObjectCreate( "catalog", Catalog.class ); digester.addObjectCreate( "catalog/book", Book.class ); digester.addBeanPropertySetter( "catalog/book/author", "author" ); digester.addBeanPropertySetter( "catalog/book/title", "title" ); digester.addSetNext( "catalog/book", "addBook" ); digester.addObjectCreate( "catalog/magazine", Magazine.class ); digester.addBeanPropertySetter( "catalog/magazine/name", "name" ); digester.addObjectCreate( "catalog/magazine/article", Article.class ); digester.addSetProperties( "catalog/magazine/article", "page", "page" ); digester.addBeanPropertySetter( "catalog/magazine/article/headline" ); digester.addSetNext( "catalog/magazine/article", "addArticle" ); digester.addSetNext( "catalog/magazine", "addMagazine" ); File input = new File( args[0] ); Catalog c = (Catalog)digester.parse( input ); System.out.println( c.toString() ); } catch( Exception exc ) { exc.printStackTrace(); } } }

在上面的代碼中，我們首先創建了Digester類的一個實例digester，然后指定它不要用DTD驗證XML文檔的合法性——這是因為我們沒有為XML文檔定義DTD。接下來，我們指定了模式和關聯的規則：ObjectCreateRule創建指定類的一個實例，并將它壓入解析棧。SetPropertiesRule把Bean屬性設置成當前XML元素的屬性值——規則的第一個參數是XML屬性的名稱，第二個參數是Bean屬性的名稱。

SetPropertiesRule獲取的是XML屬性的值，而BeanPropertySetterRule獲取的是位于當前元素內的原始字符數據值。使用BeanPropertySetterRule時不必指定要設置的Bean屬性名字，默認是當前XML元素的名稱。在上面的例子中，在匹配catalog/magazine/article/headline模式的規則定義中使用的就是默認值。最后，SetNextRule彈出解析棧頂部的對象，并把該對象傳遞給它下面對象的指定名稱的方法——通常用來把一個配置完畢的Bean插入父對象。

注意，我們可以為同一個模式注冊多個規則。如果注冊了多個規則，則這些規則按照它們被加入到Digester的次序執行，例如，如果要處理catalog/magazine/article的