最近的工作常常要和XML格式的文檔或字符串打交道,發(fā)現用JDOM來(lái)做真是方便??梢詫?shí)現XML應用程序的快速開(kāi)發(fā)。
在 JDOM 中,XML 元素就是 Element 的實(shí)例,XML 屬性就是 Attribute 的實(shí)例,XML 文檔本身就是 Document 的實(shí)例。
因為 JDOM 對象就是像 Document、Element 和 Attribute 這些類(lèi)的直接實(shí)例,因此創(chuàng )建一個(gè)新 JDOM 對象就如在 Java 語(yǔ)言中使用 new 操作符一樣容易。JDOM 的使用是直截了當的。
JDOM 使用標準的 Java 編碼模式。只要有可能,它使用 Java new 操作符而不故弄玄虛使用復雜的工廠(chǎng)化模式,使對象操作即便對于初學(xué)用戶(hù)也很方便。
本文分兩步對JDOM的應用加以介紹:XML創(chuàng )建 和 XML解析
一、XML文檔創(chuàng )建
我們由零開(kāi)始利用JDOM生成一個(gè)XML文檔。最后的結果(樣本文檔)看起來(lái)象這樣:
<?xml version="1.0" encoding="UTF-8"?>
<MyInfo comment="introduce myself">
<name>kingwong</name>
<sex value="male"/>
<contact>
<telephone>87654321</telephone>
</contact>
</MyInfo>
1.以 MyInfo 為根元素創(chuàng )建文檔
Element rootElement = new Element("MyInfo");//所有的XML元素都是 Element 的實(shí)例。根元素也不例外:)
Document myDocument = new Document(rootElement);//以根元素作為參數創(chuàng )建Document對象。一個(gè)Document只有一個(gè)根,即root元素。
2.給根元素添加屬性
Attribute rootAttri = new Attribute("comment","introduce myself");//創(chuàng )建名為 commnet,值為 introduce myself 的屬性。
rootElement.setAttribute(rootAttri);//將剛創(chuàng )建的屬性添加到根元素。
這兩行代碼你也可以合成一行來(lái)寫(xiě),象這樣:
rootElement.setAttribute(new Attribute("comment","introduce myself"));
或者
rootElement.setAttribute("comment","introduce myself");
3.添加元素和子元素
JDOM里子元素是作為 content(內容)添加到父元素里面去的,所謂content就是類(lèi)似上面樣本文檔中<name></name>之間的東東,即kingwong。羅嗦了點(diǎn)是吧:)
Element nameElement = new Element("name");//創(chuàng )建 name 元素
nameElement.addContent("kingwong");//將kingwong作為content添加到name元素
rootElement.addContent(nameElement);//將name元素作為content添加到根元素
這三行你也可以合為一句,象這樣:
rootElement.addContent((Content)(new Element("name").addContent("kingwong")));//因為addContent(Content child)方法返回的是一個(gè)Parent接口,而Element類(lèi)同時(shí)繼承了Content類(lèi)和實(shí)現了Parent接口,所以我們把它造型成Content。
我們用同樣的方法添加帶屬性的子元素<sex value="male"/>
rootElement.addContent(new Element("sex").setAttribute("value","male"));//注意這里不需要轉型,因為addAttribute(String name,String value)返回值就是一個(gè) Element。
同樣的,我們添加<contract />元素到根元素下,用法上一樣,只是稍微復雜了一些:
rootElement.addContent((Content)(new Element("contact").addContent((Content)(new Element("telephone").addContent("87654321")))));
如果你對這種簡(jiǎn)寫(xiě)形式還不太習慣,你完全可以分步來(lái)做,就象本節剛開(kāi)始的時(shí)候一樣。事實(shí)上如果層次比較多,寫(xiě)成分步的形式更清晰些,也不容易出錯。
4.刪除子元素
這個(gè)操作比較簡(jiǎn)單:
rootElement.removeChild("sex");//該方法返回一個(gè)布爾值
到目前為止,我們學(xué)習了一下JDOM文檔生成操作。上面建立了一個(gè)樣本文檔,可是我們怎么知道對不對呢?因此需要輸出來(lái)看一下。我們將JDOM生成的文檔輸出到控制臺,使用 JDOM 的 XMLOutputter 類(lèi)。
5. 將 JDOM 轉化為 XML 文本
XMLOutputter xmlOut = new XMLOutputter(" ",true);
try {
xmlOut.output(myDocument,System.out);
} catch (IOException e) {
e.printStackTrace();
}
XMLOutputter 有幾個(gè)格式選項。這里我們已指定希望子元素從父元素縮進(jìn)兩個(gè)空格,并且希望元素間有空行。
new XMLOutputter(java.lang.String indent, boolean newlines)這個(gè)方法在最新版本中已經(jīng)不建議使用。JDOM有一個(gè)專(zhuān)門(mén)的用來(lái)定義格式化輸出的類(lèi):org.jdom.output.Format,如果你沒(méi)有特殊的要求,有時(shí)候使用里面的幾個(gè)靜態(tài)方法(應該可以說(shuō)是預定義格式)如 getPrettyFormat()就可以了。我們把上面的輸出格式稍微改一下,就象這樣:
XMLOutputter xmlOut = new XMLOutputter(Format.getPrettyFormat());
6.將JDOM文檔轉化為其他形式
XMLOutputter 還可輸出到 Writer 或 OutputStream。為了輸出JDOM文檔到一個(gè)文本文件,我們可以這樣做:
FileWriter writer = new FileWriter("/some/directory/myFile.xml");
outputter.output(myDocument, writer);
writer.close();
XMLOutputter 還可輸出到字符串,以便程序后面進(jìn)行再處理:
Strng outString = xmlOut.outputString(myDocument);
當然,在輸出的時(shí)候你不一定要輸出所有的整個(gè)文檔,你可以選擇元素進(jìn)行輸出:
xmlOut.output(rootElement.getChild("name"),System.out);
一句話(huà),JDOM非常靈活方便!如果你想進(jìn)一步研究JDOM,請到官方網(wǎng)站去看一看:http://www.jdom.org
本節示例源碼:
package com.cyberobject.study;
import java.io.IOException;
import org.jdom.Attribute;
import org.jdom.Content;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.output.Format;
import org.jdom.output.XMLOutputter;
/**
* @author kingwong
*
* TODO To change the template for this generated type comment go to
* Window - Preferences - Java - Code Style - Code Templates
*/
public class TestJDOM {
public static void main(String[] args)
{
Element rootElement = new Element("MyInfo");
Document myDocument = new Document(rootElement);
// Attribute rootAttri = new Attribute("comment","introduce myself");
// rootElement.setAttribute(rootAttri);
rootElement.setAttribute("comment","introduce myself");
//rootElement.setAttribute(new Attribute("comment","introduce myself"));
// Element sexElement = new Element("sex");
// rootElement.addContent(sexElement);
// Element nameElement = new Element("name");
// nameElement.addContent("kingwong");
// rootElement.addContent(nameElement);
rootElement.addContent((Content)(new Element("name").addContent("kingwong")));
rootElement.addContent(new Element("sex").setAttribute("value","male"));
rootElement.addContent((Content)(new Element("contract").addContent((Content)(new Element("telephone").addContent("87654321")))));
rootElement.removeChild("sex");
XMLOutputter xmlOut = new XMLOutputter(Format.getPrettyFormat());
try {
xmlOut.output(myDocument,System.out);
//xmlOut.output(rootElement.getChild("name"),System.out);
//String outString = xmlOut.outputString(myDocument);
} catch (IOException e) {
e.printStackTrace();
}
}
}
二、XML文檔解析
JDOM 不光可以很方便的建立XML文檔,它的另一個(gè)用處是它能夠讀取并操作現有的 XML 數據。
JDOM的解析器在org.jdom.input.*這個(gè)包里,其中的DOMBuilder的功能是將DOM模型的Document解析成JDOM模型的Document;SAXBuilder的功能是從文件或流中解析出符合JDOM模型的XML樹(shù)。由于我們經(jīng)常要從一個(gè)文件里讀取數據,因此我們應該采用后者作為解析工具。
解析一個(gè)xml文檔,基本可以看成以下幾個(gè)步驟:
1.實(shí)例化一個(gè)合適的解析器對象
本例中我們使用SAXBuilder:
SAXBuilder sb = new SAXBuilder();
2.以包含XML數據的文件為參數,構建一個(gè)文檔對象myDocument
Document myDocument = sb.build(/some/directory/myFile.xml);
3.獲到根元素
Element rootElement = myDocument.getRootElement();
一旦你獲取了根元素,你就可以很方便地對它下面的子元素進(jìn)行操作了,下面對Element對象的一些常用方法作一下簡(jiǎn)單說(shuō)明:
getChild("childname") 返回指定名字的子節點(diǎn),如果同一級有多個(gè)同名子節點(diǎn),則只返回第一個(gè);如果沒(méi)有返回null值。
getChildren("childname") 返回指定名字的子節點(diǎn)List集合。這樣你就可以遍歷所有的同一級同名子節點(diǎn)。
getAttributeValue("name") 返回指定屬性名字的值。如果沒(méi)有該屬性則返回null,有該屬性但是值為空,則返回空字符串。
getChildText("childname") 返回指定子節點(diǎn)的內容文本值。
getText() 返回該元素的內容文本值。
還有其他沒(méi)有羅列出來(lái)的方法,如果需要的話(huà),可以隨時(shí)查閱JDOM的在線(xiàn)文檔:http://www.jdom.org/docs/apidocs/index.html。當然你可以在你需要的地方添加、刪除元素操作,還記得上面的創(chuàng )建XML的方法嗎?呵呵~~~
學(xué)習新東東還是從實(shí)例學(xué)起最為快捷,下面簡(jiǎn)單舉個(gè)例子,就以上面的XML樣本代碼來(lái)學(xué)習JDOM的XML解析。本例中讀取了樣本XML文件里一些屬性和content,最后我們還在contact元素里插入了一個(gè)新元素<email value="wanghua@cyberobject.com" />。盡管我們實(shí)現了對于XML的基本操作,細心的朋友可能會(huì )
有疑問(wèn):如果XML文檔的層次稍微復雜一些,如果嵌套多達幾十上百層的話(huà)(開(kāi)個(gè)玩笑),如果靠這樣從根元素一級一級地通過(guò)getChild("childname")來(lái)訪(fǎng)問(wèn)子元素的話(huà),將會(huì )非常痛苦!是的,的確是這樣,但是我們有另一個(gè)有力的工具XPath,為什么不用呢?這是后話(huà)!先賣(mài)個(gè)關(guān)子(手敲累啦,下回吧,呵呵)。
/*
* Created on 2004-8-21
*
* TODO To change the template for this generated file go to
* Window - Preferences - Java - Code Style - Code Templates
*/
package com.cyberobject.study;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.input.SAXBuilder;
import org.jdom.output.Format;
import org.jdom.output.XMLOutputter;
/**
* @author kingwong
*
* TODO To change the template for this generated type comment go to
* Window - Preferences - Java - Code Style - Code Templates
*/
public class TestJDOM2 {
public static void main(String[] args){
SAXBuilder sb = new SAXBuilder();
try
{
Document doc = sb.build("myFile.xml");
Element root = doc.getRootElement();
String str1 = root.getAttributeValue("comment");
System.out.println("Root Element‘s comment attribute is : " + str1);
String str2 = root.getChild("sex").getAttributeValue("value");
System.out.println("sex Element‘s value attribute is : " + str2);
String str3 = root.getChildText("name");
System.out.println("name Element‘s content is :" + str3);
String str4 = root.getChild("contact").getChildText("telephone");
System.out.println("contact Element‘s telephone subelement content is : " + str4 + "\n");
Element inputElement = root.getChild("contact");
inputElement.addContent(new Element("email").setAttribute("value","wanghua@cyberobject.com"));
XMLOutputter xmlOut = new XMLOutputter(Format.getPrettyFormat());
String outStr = xmlOut.outputString(root);
System.out.println(outStr);
}
catch(Exception e)
{
e.printStackTrace();
}
}
}
聯(lián)系客服