用JDom簡(jiǎn)單整合Java與XML
發(fā)表時(shí)間:2024-06-17 來源:明輝站整理相關(guān)軟件相關(guān)文章人氣:
[摘要]概述: Jdom是用Java語(yǔ)言讀、寫、操作XML的新API函數(shù)。Jason Hunter 和 Brett McLaughlin公開發(fā)布了它的測(cè)試版本。在直覺、簡(jiǎn)單和高效的前提下,這些API函數(shù)被最大限度的優(yōu)化。在接下來的篇幅里,Hunter 和 McLaughlin介紹怎么用Jdom去讀寫一...
概述:
Jdom是用Java語(yǔ)言讀、寫、操作XML的新API函數(shù)。Jason Hunter 和 Brett McLaughlin公開發(fā)布了它的測(cè)試版本。在直覺、簡(jiǎn)單和高效的前提下,這些API函數(shù)被最大限度的優(yōu)化。在接下來的篇幅里,Hunter 和 McLaughlin介紹怎么用Jdom去讀寫一個(gè)已經(jīng)存在的XML文檔。
Jdom是一個(gè)開源的api,它以直接易懂的方式向java程序員描述XML文檔和文檔的內(nèi)容。就象名字揭示的那樣,Jdom是為java優(yōu)化的。為使用XML文檔提供一個(gè)低消耗的方法。Jdom的使用者可以不必掌握太多的XML的知識(shí)就可以完成想要的操作。
Jdom可以和已有的XML技術(shù)如Simple API for XML (SAX)和 Document Object Model (DOM)相互協(xié)作.然而,它并不是簡(jiǎn)單的從這些api中提取出一些。Jdom從這些已存在的技術(shù)中吸收了好的方面,自己建立了一套新的類和接口,用一個(gè)Jdom用戶的話來說就是:“這些接口是我從一開始閱讀org.w3c.dom就期待的”;Jdom可以讀入SAX或是DOM的內(nèi)容,也可以輸出SAX或DOM可以接收的格式。這個(gè)能力可以使Jdom很好的和已有的用SAX或DOM建立的系統(tǒng)之間整合。
Jdom的原則
第一條并且是最重要的一條就是Jdom的api函數(shù)被設(shè)計(jì)成對(duì)java程序員來說是簡(jiǎn)單易懂的。其他的XML解析函數(shù)被設(shè)計(jì)成語(yǔ)言通用的(支持相同的api函數(shù)在java,c++,甚至是javascript中)。Jdom利用了java的優(yōu)秀的特征,如:方法重載、回收機(jī)制,和后臺(tái)處理等。
為了能夠簡(jiǎn)單易用,這些函數(shù)不得不以程序員喜歡的形式來描繪XML文檔。例如:程序員想的到的一個(gè)元素的文本內(nèi)容是什么樣子的呢?
<element>This is my text content</element>
在一些api中,元素的文本內(nèi)容僅被當(dāng)作是一個(gè)元素的孩子節(jié)點(diǎn)。從技術(shù)角度來說,這個(gè)設(shè)計(jì)需要下面的代碼才能訪問到元素的內(nèi)容:
String content = element.getFirstChild().getValue();
Jdom用一種更簡(jiǎn)單易用的方法來取得元素的內(nèi)容:
String text = element.getText();
Jdom盡可能的減少程序員的工作量。依據(jù)拇指規(guī)則,Jdom應(yīng)該用20%或是更少的努力來完成80%或是更多的java/xml方面的問題。這并不是說Jdom只是支持80%的XML規(guī)范(實(shí)際上我們希望Jdom100%的支持XML規(guī)范)。這個(gè)拇指規(guī)則是說有些東西可以加進(jìn)去,但是沒有必要。這些api函數(shù)應(yīng)該保持簡(jiǎn)潔。
Jdom的第二條原則是說Jdom應(yīng)該是快速的和輕量級(jí)的。調(diào)入和執(zhí)行文檔應(yīng)該快速,內(nèi)存的消耗應(yīng)該盡量小。Jdom的設(shè)計(jì)明顯是遵循這個(gè)原則。例如,就算在開始的時(shí)候,不太協(xié)調(diào)的操作已經(jīng)比DOM快,但是比SAX顯的粗糙。盡管這樣,Jdom還是有許多SAX沒有的優(yōu)點(diǎn)。
你需要Jdom嗎?
那么,你需要Jdom嗎?這真是一個(gè)很好的問題。已經(jīng)有了存在的標(biāo)準(zhǔn),為什么還要去發(fā)明一個(gè)新的呢?答案是Jdom解決了現(xiàn)有的標(biāo)準(zhǔn)解決不了的問題。
DOM完全在內(nèi)存中描述一個(gè)元素樹。它是一個(gè)大的api,被設(shè)計(jì)操作幾乎所有可能的XML任務(wù)。它也必須有相同的api去支持不同的語(yǔ)言。因?yàn)檫@些限制,對(duì)那些習(xí)慣使用java的特征,如方法重載、簡(jiǎn)單的set,get方法的java程序員來說,就很不習(xí)慣。DOM還需要大量的內(nèi)存和較高的主頻,這使它很難和許多輕量級(jí)的web應(yīng)用一起工作。
SAX沒有在內(nèi)存中建立一個(gè)元素樹,它用事情發(fā)展的方式來描述。例如:它報(bào)告每個(gè)讀到的開始標(biāo)記和結(jié)束標(biāo)記。這種處理方式使它成為一個(gè)輕量級(jí)的快速讀取的api。然而,這種事件處理方式對(duì)服務(wù)器端的java程序員來說不夠直觀。SAX也不支持修改XML文檔和隨機(jī)讀取。
Jdom試圖組合DOM和SAX的優(yōu)點(diǎn)。它被設(shè)計(jì)成一個(gè)可以在小內(nèi)存上快速執(zhí)行輕量級(jí)api 。Jdom也支持隨機(jī)讀取整個(gè)文檔,但是令人驚奇的是它并不需要把整個(gè)文檔讀到內(nèi)存中。這個(gè)api支持未來的當(dāng)需要時(shí)才讀入信息的次輕量級(jí)操作。還有,Jdom通過標(biāo)準(zhǔn)的構(gòu)造器和set方法支持XML文檔的修改。
獲取XML文檔
Jdom用org.Jdom.Document類的一個(gè)實(shí)例來描述一個(gè)XML文檔。這個(gè)文檔類是一個(gè)輕重量級(jí)的,它可以包括文檔類型、多處理指令的對(duì)象、一個(gè)根元素和注釋對(duì)象。你可以不需要構(gòu)造器而從草稿構(gòu)造一個(gè)文檔。
Document doc = new Document(new Element("rootElement"));
本文后面我們會(huì)討論從草稿構(gòu)造一個(gè)XML文檔是多么的容易。但是現(xiàn)在,我們從一個(gè)已存在的文件、一個(gè)流、或是一個(gè)URL路徑中構(gòu)造我們的文檔。
SAXBuilder builder = new SAXBuilder();Document doc = builder.build(url);
你可以用org.Jdom.input包中提供的構(gòu)造類從任何數(shù)據(jù)源中構(gòu)造文檔。最近,有兩種構(gòu)造方式:SAXBuilder 和 DOMBuilder。SAXBuilder用sax解析器從文件中構(gòu)造文檔。SAXBuilder偵聽sax事件并從內(nèi)存中建立一個(gè)相應(yīng)的文檔。這種方式非?欤ɑ旧虾蛃ax一樣快),這也是我們推薦的方式。DOMBuilder是另一種可選的方式,它從一個(gè)存在的org.w3c.dom.Document對(duì)象中建立Jdom文檔。它允許Jdom輕松的和構(gòu)建DOM樹的工具實(shí)現(xiàn)接口。
Jdom的速度有值得期待的提高的潛力通過一個(gè)延期的構(gòu)造器的完成。這個(gè)構(gòu)造器檢查XML數(shù)據(jù)源,但當(dāng)請(qǐng)求的時(shí)候才對(duì)它解析。例如:文檔的屬性當(dāng)不訪問時(shí)是不需要解析的。
構(gòu)造器仍在發(fā)展,可以通sql查詢、ldap查詢和其他的數(shù)據(jù)格式來夠造Jdom文檔。所以,一旦進(jìn)到內(nèi)存中,文檔就和建造它的工具沒有關(guān)系了。
SAXBuilder 和 DOMBuilder構(gòu)造器允許用戶指明他們是否應(yīng)該輪換,以便確定哪個(gè)解析器時(shí)間執(zhí)行解析的任務(wù)。
public SAXBuilder(String parserClass, boolean validation);public DOMBuilder(String adapterClass, boolean validation);
默認(rèn)的是用apache的開源 Xerces解析器并且是關(guān)閉輪換的。你應(yīng)該注到DOMBuilder不象一個(gè)解析類,倒更象一個(gè)適配類。這是因?yàn)椴皇撬械腄OM解析器都是相同的api。為了仍讓用戶選擇喜歡的解析器,Jdom使用一個(gè)對(duì)所有的dom解析器適用的公共的api的適配類。這個(gè)適配類支持所有流行的dom解析器,包括Apache 的 Xerces, Crimson,IBM 的 XML4J, Sun 的 Project X, 和Oracle 的 parsers V1 and V2.每一個(gè)解析器通過正確的調(diào)用別的解析器的方法執(zhí)行標(biāo)準(zhǔn)的接口。這有點(diǎn)象jaxp,除了它支持jaxp所不支持的新的解析器。
輸出XML文檔
你可以用幾種不同的標(biāo)準(zhǔn)輸出工具輸出一個(gè)XML文檔。org.Jdom.output.XMLOutputter也許是最常用方法。它將xml文檔寫入一個(gè)特定的OutputStream.
SAXOutputter工具是另一個(gè)選擇。它產(chǎn)生基于Jdom xml文檔的sax事件,你可以把這些送到等待這些sax事件的應(yīng)用程序那里。相同的方式,DOMOutputter產(chǎn)生一個(gè)dom文檔,這樣你就可以把它送給可以接收dom文檔的應(yīng)用程序。輸出xml文檔的代碼看起來象下邊的樣子:
XMLOutputter outputter = new XMLOutputter();
outputter.output(doc, System.out);
XMLOutputter用參數(shù)定制輸出的格式。第一個(gè)參數(shù)是行縮進(jìn)的格式;第二個(gè)參數(shù)是你是否想另起一行。因?yàn)闄C(jī)器到機(jī)器的原因,為了速度考慮你可以放棄行縮進(jìn)和另起新行。
XMLOutputter outputter = new XMLOutputter("", false);
outputter.output(doc, System.out);
。ㄗg注:這樣的話自己看起來會(huì)很不好看,而且每一次重新寫入的時(shí)候都會(huì)使這個(gè)xml文件變大,所以我建議還是要縮進(jìn)和另起一行,支持中文的帶換行和縮進(jìn)的格式如下:
XMLOutputter outp = new XMLOutputter(“”,true,"GB2312");
outp.setTextTrim(true);
outp.output(doc, System.out);
可以參見以前我寫的Jdom的文章http://www.csdn.net/Develop/read_article.asp?id=20720)
下面是讀入一個(gè)xml文檔,并把它又輸出的例子:
import java.io.*;
import org.Jdom.*;
import org.Jdom.input.*;
import org.Jdom.output.*;
public class PrettyPrinter {
public static void main(String[] args) {
// Assume filename argument
String filename = args[0];
try {
// Build the document with SAX and Xerces, no validation
SAXBuilder builder = new SAXBuilder();
// Create the document
Document doc = builder.build(new File(filename));
// Output the document, use standard formatter
XMLOutputter fmt = new XMLOutputter();
fmt.output(doc, System.out);
} catch (Exception e) {
e.printStackTrace();
}
}
}
讀取文檔類型
現(xiàn)在,讓我們來看一下怎么讀取文檔的詳細(xì)內(nèi)容。許多XML文檔都有的一個(gè)東西是文檔類型,在Jdom中用DocType類來描述。萬一你不是XML方面的專家(嘿,不用灰心,你就是我們所要面向的聽眾),一個(gè)文檔類型的聲明看起來象下邊的樣子:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
DOCTYPE后邊的第一個(gè)詞揭示文檔被強(qiáng)制類型的名字,PUBLIC后邊的詞是文檔類型的公共屬性,最后一個(gè)詞是文檔類型的系統(tǒng)屬性。文檔屬性可以上通過文檔的getDocType()方法獲得,DocType類提供了一組獲得文檔類型聲明的方法。
DocType docType = doc.getDocType();
System.out.println("Element: " + docType.getElementName());
System.out.println("Public ID: " + docType.getPublicID());
System.out.println("System ID: " + docType.getSystemID());
讀取文檔數(shù)據(jù)
每一個(gè)XML文檔必須有一個(gè)根元素。這個(gè)元素是訪問所有XML文檔內(nèi)部信息的起始點(diǎn)。例如:這個(gè)文檔片段用<web-app>作為根元素:
<web-app id="demo">
。糳escription>Gotta fit servlets in somewhere!</description>
<distributable/>
</web-app>
根元素的實(shí)例可以在文檔中直接獲得。
Element webapp = doc.getRootElement();
這樣,你就可以訪問這個(gè)元素的屬性(如上邊的id)內(nèi)容和子節(jié)點(diǎn)元素。
訪問子節(jié)點(diǎn)
XML文檔是樹型結(jié)構(gòu)的,任何一個(gè)元素都有可能包含任何數(shù)量的子元素。例如:<web-app>元素有<description>和 <distributable>作為子節(jié)點(diǎn)元素。你可以通過很多方法獲得一個(gè)元素的子元素,getChild()如果沒有子元素的話返回NULL。
List getChildren(); // return all children
List getChildren(String name); // return all children by name
Element getChild(String name); // return first child by name
示例:
// Get a List of all direct children as Element objects
List allChildren = element.getChildren();
out.println("First kid: " + ((Element)allChildren.get(0)).getName());
// Get a list of all direct children with a given name
List namedChildren = element.getChildren("name");
// Get a list of the first kid with a given name
Element kid = element.getChild("name");
當(dāng)文檔結(jié)構(gòu)事先知道的情況下,getchild()方法很容易快速的獲得嵌套的元素。給出一個(gè)XML文檔:
<?xml version="1.0"?>
<linux:config>
。糶ui>
。紈indow-manager>
<name>Enlightenment</name>
。紇ersion>0.16.2</version>
。/window-manager>
。!-- etc -->
。/gui>
。/linux:config>
下邊的代碼直接獲得window manager 的名字
String windowManager = rootElement.getChild("gui")
.getChild("window-manager")
.getChild("name")
.getText();
如果文檔不可用要小心NullPointerExceptions異常。為了實(shí)現(xiàn)簡(jiǎn)單的文檔導(dǎo)航,未來的Jdom可能會(huì)支持xpath。子節(jié)點(diǎn)可以通過getParent()獲得父節(jié)點(diǎn)。
獲取文檔屬性
屬性是元素?fù)碛械牧硪唤M信息。html程序員對(duì)他是很熟悉的。下邊的<table>元素有width和border屬性。
<table width="100%" border="0"> </table>
這些屬性可以在元素中直接獲得。
String width = table.getAttributeValue("width");
你也可以用屬性實(shí)例來重新獲得這些屬性。這個(gè)能力幫助Jdom支持一些高級(jí)概念,例如名字空間中的屬性。(參考文章后邊關(guān)于名字空間的內(nèi)容)
Attribute widthAttrib = table.getAttribute("width");
String width = widthAttrib.getValue();
為了方便你還可以獲得這些屬性的原始數(shù)據(jù)類型。
int width = table.getAttribute("border").getIntValue();
你可以轉(zhuǎn)化這些數(shù)據(jù)到任何的原始數(shù)據(jù)類型。如果這些屬性不能轉(zhuǎn)換成原始數(shù)據(jù)類型就拋出一個(gè)DataConversionException異常。如果屬性不存在getAttribute()返回一個(gè)null;
提取文檔內(nèi)容
我們?yōu)橛煤?jiǎn)單的方法獲得文檔內(nèi)容而激動(dòng),下邊我們看一下用element.getText()方法提取文檔的文本內(nèi)容是多么容易。這個(gè)是標(biāo)準(zhǔn)方法,適用于象下邊這樣的文檔:
<name>Enlightenment</name>
但是有些時(shí)候這些文檔包含注釋,文本內(nèi)容和子元素。在一些高級(jí)的文檔中,它甚至包含一些處理指令:
<table>
。!-- Some comment -->
Some text
。紅r>Some child</tr>
。?pi Some processing instruction?>
</table>
你可以總是通過下邊的方式獲得文本內(nèi)容和子節(jié)點(diǎn):
String text = table.getText(); // "Some text"
Element tr = table.getChild("tr"); // <tr> child
這使得標(biāo)準(zhǔn)使用很簡(jiǎn)單。有些時(shí)候例如輸出,獲得一個(gè)文檔所有內(nèi)容的順序是很重要的。為了這個(gè)原因,你可以使用一個(gè)特殊的方法叫g(shù)etMixedContent()。它返回一個(gè)list內(nèi)容可能包含注釋,字符串,元素和處理指令的實(shí)例。Java程序員可以使用instanceof 來獲得內(nèi)容。下邊的代碼打印一個(gè)文檔內(nèi)容的摘要:
List mixedContent = table.getMixedContent();
Iterator i = mixedContent.iterator();
while (i.hasNext()) {
Object o = i.next();
if (o instanceof Comment) {
// Comment has a toString()
out.println("Comment: " + o);
}
else if (o instanceof String) {
out.println("String: " + o);
}
else if (o instanceof ProcessingInstruction) {
out.println("PI: " + ((ProcessingInstriction)o).getTarget());
}
else if (o instanceof Element) {
out.println("Element: " + ((Element)o).getName());
}
}