Java語言編程中更新XML文檔的常用方法
內容：
直接讀寫XML文檔
使用XMLDocument類
使用TransformerFactory和Transformer類
使用Xalan XML Serializer
結論
參考文獻
附件
關於作者
黃理 (mailto:[email protected])
學生
2002 年 3 月
本文簡要的討論了Java語言編程中更新XML文檔的四種常用方法,並且分析這四種方法的優劣。其次,本文還對如何控制Java程序輸出的XML文檔的格式做了展開論述。
JAXP是Java API for XML Processing的英文字頭縮寫,中文含義是:用於XML文檔處理的使用Java語言編寫的編程接口。JAXP支持DOM、SAX、XSLT等標准。為了增強JAXP使用上的靈活性,開發者特別為JAXP設計了一個Pluggability Layer,在Pluggability Layer的支持之下,JAXP既可以和具體實現DOM API、SAX API 的各種XML解析器(XML Parser,例如Apache Xerces)聯合工作,又可以和具體執行XSLT標准的XSLT處理器(XSLT Processor,例如apache Xalan)聯合工作。應用Pluggability Layer的好處在於:我們只需要熟悉JAXP各個編程接口的定義即可,而不需要對所采用的具體的XML解析器、XSLT處理器有很深入的了解。比如在某個Java程序中,通過JAXP調用XML解析器apache Crimson對XML文檔進行處理,如果我們希望使用別的XML解析器(比如Apache Xerces),以便提高該程序的性能,那麼原程序代碼可能不需要任何改變,直接就可以使用(你所需要做的事情只是將包含Apache Xerces代碼的jar文件加入到環境變量CLASSPATH中,而將包含apache Crimson代碼的jar文件在環境變量CLASSPATH中刪除)。
目前JAXP已經應用的十分普遍了,可以說是Java語言中處理XML文檔的標准API。有些初學者在學習使用JAXP的過程中,經常會提出這樣的問題:我編寫的程序對DOM Tree做了更新,但是當程序退出以後,原始的XML文檔並沒有改變,還是老樣子,如何實現對原始XML文檔和DOM Tree的同步更新呢?咋一看來,在JAXP中似乎沒有提供相應的接口/方法/類,這是很多初學者都感到困惑的問題。本文的主旨就在於解決這個問題,簡單的介紹幾種常用的同步更新原始XML文檔和DOM Tree的方法。為了縮小討論的范圍,本文所涉及的XML解析器僅包括Apache Crimson和Apache Xerces,而XSLT處理器僅僅使用apache Xalan。
方法一:直接讀寫XML文檔
這也許是最笨最原始的辦法了。當程序獲取DOM Tree之後,應用DOM模型的Node接口的各個方法對DOM Tree進行更新,下一步應該對原始的XML文檔進行更新了。我們可以運用遞歸的辦法或者是應用TreeWalker類,遍歷整個DOM Tree,與此同時,將DOM Tree的每一個節點/元素依次寫入到預先打開的原始XML文檔中,當DOM Tree被遍歷完全之後,DOM Tree和原始的XML文檔就實現了同步更新。實際中,這個方法極少使用,不過如果你要編程實現自己的XML解析器,這種方法還是有可能用得上的。
方法二:使用XMLDocument類
使用XmlDocument類?JAXP中分明沒有這個類呀!是不是作者搞錯了?沒有錯!就是使用XmlDocument類,確切的說,是使用XMLDocument類的write()方法。
在上文已經提到過,JAXP可以和各種各樣的XML解析器聯合使用,這次我們選用的XML解析器是Apache Crimson。XmlDocument(org.apache.crimson.tree.XmlDocument)是apache Crimson的一個類,並不包含於標准的JAXP中,難怪在JAXP的文檔中找不到XmlDocument類的芳蹤呢。現在問題出來了,如何應用XmlDocument類來實現更新XML文檔的功能?在XMLDocument類中提供了下面三個write()方法(根據Crimson最新的版本------apache Crimson 1.1.3):
public void write (OutputStream out) throws IOException
public void write (Writer out) throws IOException
public void write (Writer out, String encoding) throws IOException
上述三個write()方法的主要作用就是輸出DOM Tree中的內容到特定的輸出介質中,比如文件輸出流、應用程序控制台等等。那麼又如何使用上述三個write()方法呢?請看下面的Java程序代碼片斷:
String name="fancy";
DocumentBuilder parser;
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
try
{
parser = factory.newDocumentBuilder();
Document doc = parser.parse("user.XML");
Element newlink=doc.createElement(name);
doc.getDocumentElement().appendChild(newlink);
((XmlDocument)doc).write(new FileOutputStream(new File("xuser1.XML")));
}
catch (Exception e)
{
//to log it
}
在上面的代碼中,首先創建了一個Document對象doc,獲取完整的DOM Tree,然後應用Node接口的appendChild()方法,在DOM Tree的最後追加了一個新節點(fancy),最後調用XmlDocument類的write(OutputStream out)方法,把DOM Tree中的內容輸出到xuser.xml中(其實也可以輸出到user.xml,更新原始的XML文檔,在這裡為了便於做對比,故而輸出到xuser.xml文件中)。需要注意的是不能直接對Document對象doc直接調用write()方法,因為JAXP的Document接口並沒有定義任何write()方法,所以必須將doc由Document對象強制轉換為XMLDocument對象,然後才能調用write()方法,在上面的代碼中使用的是write(OutputStream out)方法,這個方法使用缺省的UTF-8編碼輸出DOM Tree中的內容到特定的輸出介質中,如果DOM Tree中包含中文字符,那麼輸出的結果有可能是亂碼,亦即存在所謂的"漢字問題",解決的辦法是使用write (Writer out, String encoding)方法,顯式指定輸出時的編碼,例如將第二個參數設為"GB2312",這時即不存在"漢字問題",輸出結果能夠正常顯示中文字符。
完整的例子請參考下列文件: AddRecord.java(見附件)、user.XML(見附件)。該例子的運行環境為:Windows XP Professional、JDK 1.3.1。為了能夠正常編譯運行AddRecord.Java這個程序,你需要到網址http://XML.apache.org/dist/crimson/去下載apache Crimson,並將所獲取的crimson.jar文件加入到環境變量CLASSPATH中。
注意:
Apache Crimson的前身是Sun Project X Parser,後來不知何故,由X Parser演變為Apache Crimson,至今Apache Crimson的很多代碼都是從X Parser中直接移植過來的。比如上文用到的XmlDocument類,它在X Parser中是com.sun.xml.XmlDocument,到了Apache Crimson中搖身一變,就變成了org.apache.crimson.tree.XmlDocument類,其實它們的絕大部分代碼是一樣的,可能就package語句和import語句以及文件開頭的一段lIEnce有所不同而已。早期的JAXP是和X Parser捆綁在一起的,因此一些老的程序使用了com.sun.xml包,如果你現在重新編譯它們,有可能不能通過,肯定就是因為這個原因。後來的JAXP和Apache Crimson捆綁在一起,比如JAXP 1.1,如果你使用JAXP 1.1,那麼不需要額外下載apache Crimson,也能夠正常編譯運行上面的例子(AddRecord.java)。最新的JAXP 1.2 EA(Early Access)改弦更張,采用性能更好的Apache Xalan和Apache Xerces分別作為XSLT處理器和XML解析器,不能直接支持apache Crimson了,所以如果你的開發環境采用了JAXP 1.2 EA或者是Java XML Pack(內含JAXP 1.2 EA),那麼將無法直接編譯運行上面的例子(AddRecord.Java),你需要額外下載並安裝apache Crimson。
方法三:使用TransformerFactory和Transformer類
在JAXP中所提供的標准的更新原始XML文檔的方法就是調用XSLT引擎,亦即使用TransformerFactory和Transformer類。請看下面的Java代碼片斷:
//首先創建一個DOMSource對象,該構造函數的參數可以是一個Document對象
//doc代表更改後的DOM Tree。
DOMSource doms = new DOMSource (doc);
//創建一個File對象,代表DOM Tree所包含的數據的輸出介質,這是一個XML文件。
File f = new File ("XMLOutput.XML");
//創建一個StreamResult對象,該構造函數的參數可以取為File對象。
StreamResult sr = new StreamResult (f);
//下面調用JAXP中的XSLT引擎來實現輸出DOM Tree中的數據到XML文件中的功能。
//XSLT引擎的輸入為DOMSource對象,輸出為StreamResut對象。
try
{
//首先創建一個TransformerFactory對象,再由此創建Transformer對象。Transformer
//類相當於一個XSLT引擎。通常我們使用它來處理XSL文件,但是在這裡我們使
//用它來輸出XML文檔。
TransformerFactory tf=TransformerFactory.newInstance();
Transformer t=tf.newTransformer ();
//關鍵的一步,調用Transformer對象 (XSLT引擎)的transform()方法,該方法的第一
//個參數是DOMSource對象,第二個參數是StreamResult對象。
t.transform(doms,sr);
}
catch (TransformerConfigurationException tce)
{
System.out.println("Transformer Configuration Exception\n-----");
tce.printStackTrace();
}
catch (TransformerException te)
{
System.out.println ("Transformer Exception\n---------");
te.printStackTrace ();
}
在實際的應用中,我們可以應用傳統的DOM API從XML文檔中獲取DOM Tree,然後根據實際的需求對DOM Tree執行各種操作,得到最終的Document對象,接下來可以由此Document對象創建DOMSource對象,剩下的事情就是照搬上面的代碼了,程序運行完畢後, XMLOutput.xml就是你所需要的結果(當然了,你可以隨意更改StreamResult類構造函數的參數,指定不同的輸出介質,而不必是千篇一律的XML文檔)。
這個方法最大的好處在於可以隨心所欲的控制DOM Tree中的內容輸出到輸出介質中的格式,但是光靠TransformerFactory類和Transformer類並不能實現這個功能,還需要依賴OutputKeys類的幫助。 完整的例子請參考下列文件: AddRecord2.java(見附件)、user.xml(見附件)。該例子的運行環境為:Windows XP Professional、JDK 1.3.1。為了能夠正常編譯運行AddRecord2.java這個程序,你需要到網址http://java.sun.com/去下載安裝JAXP 1.1或者Java XML Pack(Java XML Pack已經內含JAXP了)。
OutputKeys類
javax.XML.transform.OutputKeys類和Java.util.PropertIEs類配合使用,可以控制JAXP的XSLT引擎(Transformer類)輸出XML文檔的格式。請看下面的代碼片斷:
//首先創建一個TransformerFactory對象,再由此創建Transformer對象。
TransformerFactory tf=TransformerFactory.newInstance();
Transformer t=tf.newTransformer ();
//獲取Transformser對象的輸出屬性,亦即XSLT引擎的缺省輸出屬性,這是一個
//Java.util.PropertIEs對象。
Properties properties = t.getOutputPropertIEs();
//設置新的輸出屬性:輸出字符編碼為GB2312,這樣可以支持中文字符,XSLT引擎所輸出
//的XML文檔如果包含了中文字符,可以正常顯示,不會出現所謂的"漢字問題"。
//請留意OutputKeys類的字符串常數OutputKeys.ENCODING。
propertIEs.setProperty(OutputKeys.ENCODING,"GB2312");
/更新XSLT引擎的輸出屬性。
t.setOutputProperties(propertIEs);
//調用XSLT引擎,按照輸出屬性中的設置,輸出DOM Tree中的內容到輸出介質中。
t.transform(DOMSource_Object,StreamResult_Object);
從上面的程序代碼,我們不難看出,通過設置XSLT引擎(Transformer類)的輸出屬性,可以控制DOM Tree中的內容的輸出格式,這對於我們定制輸出內容是很有幫助的。那麼JAXP的XSLT引擎(Transformer類)有那些輸出屬性可以設置呢? Javax.XML.transform.OutputKeys類定義了很多字符串常數,它們都是可以自由設置的輸出屬性,常用的輸出屬性如下所示:
public static final Java.lang.String METHOD
可以設為"XML"、"Html"、"text"等值。
public static final Java.lang.String VERSION
所遵循規范的版本號,如果METHOD設為"XML",那麼它的值應該設為"1.0",如果METHOD設為"Html",那麼它的值應該設為"4.0",如果METHOD設為"text",那麼這個輸出屬性會被忽略。
public static final Java.lang.String ENCODING
設置輸出時所采用的編碼方式,比如"GB2312"、"UTF-8"等等,如果將其設置為"GB2312",可以解決所謂的"漢字問題"。
public static final Java.lang.String OMIT_XML_DECLARATION
設置輸出到XML文檔中時是否忽略XML聲明,亦即類似於:
這樣的代碼。它可選的值有"yes"、"no"。
public static final Java.lang.String INDENT
IDENT設定XSLT引擎在輸出XML文檔時,是否自動添加額外的空格,它可選的值為"yes"、"no"。
public static final Java.lang.String MEDIA_TYPE
MEDIA_TYPE設定輸出文檔的MIME類型。
如果設定XSLT引擎的輸出屬性呢?下面我們來總結一下:
首先是獲取XSLT引擎(Transformer類)的缺省輸出屬性的集合,這需要使用Transformer類的getOutputPropertIEs()方法,返回值是一個Java.util.PropertIEs對象。
Properties properties = transformer.getOutputPropertIEs();
然後是設定新的輸出屬性,比如:
propertIEs.setProperty(OutputKeys.ENCODING,"GB2312");
propertIEs.setProperty(OutputKeys.METHOD,"Html");
propertIEs.setProperty(OutputKeys.VERSION,"4.0");
………………………………………………………
最後是更新XSLT引擎(Transformer類)的缺省輸出屬性的集合,這需要使用Transformer類的setOutputPropertIEs()方法,參數是一個Java.util.PropertIEs對象。
我們編寫了一個新的程序,其中應用了OutputKeys類,用以控制XSLT引擎的輸出屬性,該程序的架構和前一個程序(AddRecord3.java)大致相同,不過輸出結果略有不同。完整的代碼請參考下列文件: AddRecord3.java(見附件)、user.xml(見附件)。該例子的運行環境為:Windows XP Professional、JDK 1.3.1。為了能夠正常編譯運行AddRecord3.java這個程序,你需要到網址http://java.sun.com/去下載安裝JAXP 1.1或者Java XML Pack(Java XML Pack內含JAXP了)。
方法四:使用Xalan XML Serializer
方法四其實是方法三的一個變種,它需要Apache Xalan和apache Xerces的支持才能夠運行。例子代碼如下所示:
//首先創建一個DOMSource對象,該構造函數的參數可以是一個Document對象
//doc代表更改後的DOM Tree。
DOMSource domSource = new DOMSource (doc);
//創建一個DOMResult對象,臨時保存XSLT引擎的輸出結果。
DOMResult domResult = new DOMResult();
//下面調用JAXP中的XSLT引擎來實現輸出DOM Tree中的數據到XML文件中的功能。
//XSLT引擎的輸入為DOMSource對象,輸出為DOMResut對象。
try
{
//首先創建一個TransformerFactory對象,再由此創建Transformer對象。Transformer
//類相當於一個XSLT引擎。通常我們使用它來處理XSL文件,但是在這裡我們使
//用它來輸出XML文檔。
TransformerFactory tf=TransformerFactory.newInstance();
Transformer t=tf.newTransformer ();
//設置XSLT引擎的屬性(必不可少,否則會產生"漢字問題")。
Properties properties = t.getOutputPropertIEs();
propertIEs.setProperty(OutputKeys.ENCODING,"GB2312");
t.setOutputProperties(propertIEs);
//關鍵的一步,調用Transformer對象 (XSLT引擎)的transform()方法,該方法的第一
//個參數是DOMSource對象,第二個參數是DOMResult對象。
t.transform(domSource,domResult);
//創建缺省的Xalan XML Serializer,使用它將臨時存放在DOMResult對象
//(domResult)中的內容以輸出流的形式輸出到輸出介質中。
Serializer serializer = SerializerFactory.getSerializer
(OutputProperties.getDefaultMethodPropertIEs("XML"));
//設置Xalan XML Serializer的輸出屬性,這一步必不可少,否則也可能產生
//所謂的"漢字問題"。
PropertIEs prop=serializer.getOutputFormat();
prop.setProperty("encoding","GB2312");
serializer.setOutputFormat(prop);
//創建一個File對象,代表DOM Tree所包含的數據的輸出介質,這是一個XML文件。
File f = new File ("xuser3.XML");
//創建文件輸出流對象fos,請留意構造函數的參數。
FileOutputStream fos=new FileOutputStream(f);
//設置Xalan XML Serializer的輸出流。
serializer.setOutputStream(fos);
//串行化輸出結果。
serializer.asDOMSerializer().serialize(domResult.getNode());
}
catch (Exception tce)
{
tce.printStackTrace();
}
這個方法不太常用,而且似乎有點畫蛇添足,所以我們就不展開討論了。完整的例子請參考下列文件: AddRecord4.java(見附件)、user.XML(見附件)。該例子的運行環境為:Windows XP Professional、JDK 1.3.1。為了能夠正常編譯運行AddRecord4.Java這個程序,你需要到網址http://XML.apache.org/dist//去下載安裝Apache Xalan和apache Xerces。
或者是到網址http://java.sun.com/XML/download.Html去下載安裝Java XML Pack。因為最新的Java XML Pack(Winter 01 版)包含了Apache Xalan和apache Xerces技術在內。
結論:
本文簡略的討論了Java語言編程中更新XML文檔的四種方法。第一種方法是直接讀寫XML文件,這種方法十分繁瑣,而且比較容易出錯,極少使用,除非你需要開發自己的XML Parser,否則不會使用這種方法。第二種方法是使用Apache Crimson的XmlDocument類,這種方法極為簡單,使用方便,如果你選用apache Crimson作為XML解析器,那麼不妨使用這種方法,不過這種方法似乎效率不高(源於效率低下的apache Crimson),另外,高版本的JAXP或者是Java XML Pack、JWSDP不直接支持apache Crimson,亦即這種方法不通用。第三種方法是使用JAXP的XSLT引擎(Transformer類)來輸出XML文檔,這種方法也許是標准的方法了,使用起來十分靈活,特別是可以自如控制輸出格式,我們推薦采用這種方法。第四種方法是第三種方法的變種,采用了Xalan XML Serializer,引入了串行化操作,對於大量文檔的修改/輸出有優越性,可惜的是要重復設置XSLT引擎的屬性和XML Serializer的輸出屬性,比較麻煩,而且依賴於Apache Xalan和apache Xerces技術,通用性略顯不足。
除了上面討論的四種方法以外,實際上應用別的API(比如JDOM、Castor、XML4J、Oracle XML Parser V2)也有很多辦法可以更新XML文檔,限於篇幅,在這裡就不一一討論了。
參考文獻以及資料來源:
[1]The Java Web Services Tutorial, Sun Microsystems Inc.
[2]http://xml.apache.org/,apache XML Project(Crimson、Xerces、Xalan)
[3]http://www.jguru.com/,XML Forum
[4]http://forum.java.sun.com/,Java Technology & XML Forum
關於作者
黃理，北京大學四年級學生,對Java、XML技術深感興趣,有長期編程經驗。您可以通過mailto:[email protected]與他聯系。
