最近，準備學習一下Spring的相關知識，雖然知道，javaweb使用properties檔案和xml檔案作為配置檔案，其中properties檔案是由java本身提供的相關類和方法進行解析的，而xml也需要解析。至於具體使用什麼解析方法，不是很清楚，學習java基礎的時候，好像知道xml常用的解析方式為dom4j和SAX解析，對於這兩種解析方式不再贅述，本文簡單探討一下使用jdom解析XML的相關知識。

1.概述

JDOM是兩位著名的 Java 開發人員兼作者，Brett Mclaughlin 和 Jason Hunter 的創作成果， 2000 年初在類似於Apache協議的許可下，JDOM作為一個開放原始碼專案正式開始研發了。它已成長為包含來自廣泛的 Java 開發人員的投稿、集中反饋及錯誤修復的系統，並致力於建立一個完整的基於 Java 平臺的解決方案，通過 Java 程式碼來訪問、操作並輸出 XML 資料。
雖然許多Java 開發人員每天都在使用 XML，Sun 卻在將 XML 整合進 Java 平臺方面落後了。因為在 XML 成為從商家對商家整合到 Web 站點內容流水化等方面的關鍵技術之前，Java 2 平臺就已經非常流行了。Sun已經使用JSR過程使之成為現存 XMLAPI的鼻祖，這一點已被廣泛接受。目前最顯著的是加入了JAXP（用於 XML語法分析的 Java API），其中包含了三個軟體包：
·org.w3c.dom ，W3C 推薦的用於 XML 標準規劃文件物件模型的 Java 工具
·org.xml.sax，用於對 XML 進行語法分析的事件驅動的簡單 API
·javax.xml.parsers ，工廠化工具，允許應用程式開發人員獲得並配置特殊的語法分析器工具 JDOM 能夠替換org.w3c.dom軟體包來有計劃地操作 XML 文件
JDOM是一個開源專案，它基於樹型結構，利用純JAVA的技術對XML文件實現解析、生成、序列化以及多種操作。
JDOM 直接為JAVA程式設計服務。它利用更為強有力的JAVA語言的諸多特性（方法過載、集合概念以及對映），把SAX和DOM的功能有效地結合起來。
Jdom是用Java語言讀、寫、操作XML的新API函式。Jason Hunter 和 Brett McLaughlin公開發布了它的1.0版本。在直覺、簡單和高效的前提下，這些API函式被最大限度的優化。在接下來的篇幅裡將介紹怎麼用Jdom去讀寫一個已經存在的XML文件。
在使用設計上儘可能地隱藏原來使用XML過程中的複雜性。利用JDOM處理XML文件將是一件輕鬆、簡單的事。
JDOM在2000年的春天被Brett McLaughlin和Jason Hunter開發出來，以彌補DOM及SAX在實際應用當中的不足之處。
這些不足之處主要在於SAX沒有文件修改、隨機訪問以及輸出的功能，而對於DOM來說，JAVA程式設計師在使用時來用起來總覺得不太方便。
DOM的缺點主要是來自於由於Dom是一個介面定義語言（IDL）,它的任務是在不同語言實現中的一個最低的通用標準，並不是為JAVA特別設計的。JDOM的最新版本為JDOM Beta 9。最近JDOM被收錄到JSR-102內，這標誌著JDOM成為了JAVA平臺組成的一部分。
在 JDOM 中，XML 元素就是 Element 的例項，XML 屬性就是 Attribute 的例項，XML 文件本身就是 Document 的例項。
因為 JDOM 物件就是像Document、Element 和 Attribute 這些類的直接例項，因此建立一個新 JDOM 物件就如在 Java 語言中使用 new 操作符一樣容易。JDOM 的使用是直截了當的。
JDOM 使用標準的 Java 編碼模式。只要有可能，它使用 Java new 操作符而不故弄玄虛使用複雜的工廠化模式，使物件操作即便對於初學使用者也很方便。

2.簡介

JDOM是由以下幾個包組成的
org.jdom包含了所有的xml文件要素的java類
org.jdom.adapters包含了與dom適配的java類
org.jdom.filter包含了xml文件的過濾器類
org.jdom.input包含了讀取xml文件的類
org.jdom.output包含了寫入xml文件的類
org.jdom.transform包含了將jdomxml文件介面轉換為其他xml文件介面
org.jdom.xpath包含了對xml文件xpath操作的類

3.API

1.Document

(1)Document的操作方法：

Element root=new Element("GREETING");
Document doc=new Document(root);
root.setText("HelloJDOM!");
或者簡單的使用Document doc=new Document(new Element("GREETING").setText("HelloJDOM!t"));
這點和DOM不同。Dom則需要更為複雜的程式碼，如下：
DocumentBuilderFactory factory=DocumentBuilderFactory.newInstance();
DocumentBuilder builder=factory.newDocumentBuilder();
Documentdoc=builder.newDocument();
Element root=doc.createElement("root");
Text text=doc.createText("Thisistheroot");
root.appendChild(text);
doc.appendChild(root);
注意事項：JDOM不允許同一個節點同時被2個或多個文件相關聯，要在第2個文件中使用原來老文件中的節點的話。首先需要使用detach()把這個節點分開來。

(2)從檔案、流、系統ID、URL得到Document物件：

DOMBuilder builder=new DOMBuilder();
Document doc=builder.build(newFile("jdom_test.xml"));
SAXBuilder builder=new SAXBuilder();
Document doc=builder.build(url);
在新版本中DOMBuilder已經Deprecated掉DOMBuilder.builder(url)，用SAX效率會比較快。
這裡舉一個小例子，為了簡單起見，使用String物件直接作為xml資料來源：
PublicjdomTest(){
String textXml=null;
textXml="";
textXml=textXml+ "aaabbbcccddd";
textXml=textXml+"";
SAXBuilder builder=new SAXBuilder();
Document doc=null;
Reader in=new StringReader(textXml);
try {
doc=builder.build(in);
Element root=doc.getRootElement();
List ls=root.getChildren();//注意此處取出的是root節點下面的一層的Element集合
for ( Iterator iter=ls.iterator(); iter.hasNext(); ){
Element el=(Element)iter.next();
if (el.getName().equals("to")){
System.out.println(el.getText());
}
}
} catch(IOException ex) {
ex.printStackTrace();
} catch(JDOMException ex) {
ex.printStackTrace();
}
}

(3)DOM的document和JDOM的Document之間的相互轉換

DOMBuilder builder=new DOMBuilder();
org.jdom.Document jdomDocument=builder.build(domDocument);
DOMOutputter converter=newDOMOutputter();//workwiththeJDOMdocument…
org.w3c.dom.Document domDocument=converter.output(jdomDocument);
//workwiththeDOMdocument…

2.XML輸出

XMLOutPutter類：
JDOM的輸出非常靈活,支援很多種io格式以及風格的輸出
Document doc=newDocument(...);
XMLOutputter outp=newXMLOutputter();
outp.output(doc,fileOutputStream);//Rawoutput
outp.setTextTrim(true);//Compressedoutput
outp.output(doc,socket.getOutputStream());
outp.setIndent("");//Prettyoutput
outp.setNewlines(true);
outp.output(doc,System.out);
詳細請參閱最新的JDOMAPI手冊

3.Element

(1)瀏覽Element樹

Element root=doc.getRootElement();//獲得根元素element
List allChildren=root.getChildren();//獲得所有子元素的一個list
List namedChildren=root.getChildren("name");//獲得指定名稱子元素的list
Element child=root.getChild("name");//獲得指定名稱的第一個子元素
JDOM給了我們很多很靈活的使用方法來管理子元素（這裡的List是java.util.List）
List allChildren=root.getChildren();
allChildren.remove(3);//刪除第四個子元素
allChildren.removeAll(root.getChildren("jack"));//刪除叫“jack”的子元素
root.removeChildren("jack");//便捷寫法
allChildren.add(new Element("jane"));//加入
root.addContent(new Element("jane"));//便捷寫法
allChildren.add(0,new Element("first"));

(2)移動Elements:

在JDOM裡很簡單
Element movable=new Element("movable");
parent1.addContent(movable);//place
parent1.removeContent(movable);//remove
parent2.addContent(movable);//add
在Dom裡
Element movable=doc1.createElement("movable");
parent1.appendChild(movable);//place
parent1.removeChild(movable);//remove

parent2.appendChild(movable);//出錯!

糾錯性

JDOM的Element建構函式（以及它的其他函式）會檢查element是否合法。

而它的add/remove方法會檢查樹結構，檢查內容如下：
1.在任何樹中是否有迴環節點
2.是否只有一個根節點
3.是否有一致的名稱空間（Namespaces）

(3)Element的text內容讀取

Acooldemo
//Thetextisdirectlyavailable
//Returns"\nAcooldemo\n"
String desc=element.getText();
//There'saconvenientshortcut
//Returns"Acooldemo"
String desc=element.getTextTrim();

(4)Elment內容修改

element.setText("Anewdescription");

4.補充說明

1.org.JDOM這個包裡的類是你解析xml檔案後所要用到的所有資料型別。

Attribute
CDATA
Coment
DocType
Document
Element
EntityRef
Namespace
ProscessingInstruction
Text

2.org.JDOM.transform在涉及xslt格式轉換時應使用下面的2個類

JDOMSource
JDOMResult
org.JDOM.input

3.輸入類，一般用於文件的建立工作

SAXBuilder
DOMBuilder
ResultSetBuilder

4.org.JDOM.output輸出類，用於文件轉換輸出

XMLOutputter
SAXOutputter
DomOutputter
JTreeOutputter
使用前注意事項：
1.JDOM對於JAXP以及TRax的支援
JDOM支援JAXP1.1：你可以在程式中使用任何的parser工具類,預設情況下是JAXP的parser。
制定特別的parser可用如下形式
SAXBuilderparser
=newSAXBuilder("org.apache.crimson.parser.XMLReaderImpl");
Documentdoc=parser.build("str");
//workwiththedocument...
JDOM也支援TRaX：XSLT可通過JDOMSource以及JDOMResult類來轉換（參見以後章節）
2.注意在JDOM裡文件（Document）類由org.JDOM.Document來表示。這要與w3c中的Document區別開，這2種格式如何轉換在後面會說明。
以下如無特指均指JDOM裡的Document。

5.文件解析

JDOM 不光可以很方便的建立XML文件，它的另一個用處是它能夠讀取並操作現有的 XML 資料。
JDOM的解析器在org.jdom.input.*這個包裡，其中的DOMBuilder的功能是將DOM模型的Document解析成JDOM模型的Document；SAXBuilder的功能是從檔案或流中解析出符合JDOM模型的XML樹。由於我們經常要從一個檔案裡讀取資料，因此我們應該採用後者作為解析工具。
解析一個xml文件，基本可以看成以下幾個步驟：

1.例項化一個合適的解析器物件

本例中我們使用SAXBuilder:
SAXBuilder sb = new SAXBuilder();

2.以包含XML資料的檔案為引數，構建一個文件物件myDocument

Document myDocument = sb.build(/some/directory/myFile.xml);

3.獲到根元素

Element rootElement = myDocument.getRootElement();
一旦你獲取了根元素，你就可以很方便地對它下面的子元素進行操作了，下面對Element物件的一些常用方法作一下簡單說明：
getChild("childname") 返回指定名字的子節點,如果同一級有多個同名子節點，則只返回第一個；如果沒有返回null值。
getChildren("childname") 返回指定名字的子節點List集合。這樣你就可以遍歷所有的同一級同名子節點。
getAttributeValue("name") 返回指定屬性名字的值。如果沒有該屬性則返回null,有該屬性但是值為空，則返回空字串。
getChildText("childname") 返回指定子節點的內容文字值。
getText() 返回該元素的內容文字值。

6.應用

6.1建立文件

Element rootElement = new Element("MyInfo");//所有的XML元素都是 Element 的例項。根元素也不例外：）
Document myDocument = new Document(rootElement);//以根元素作為引數建立Document物件。一個Document只有一個根，即root元素。

6.2元素

6.2.1給根元素新增屬性

Attribute rootAttri = new Attribute("comment","introduce myself");//建立名為 commnet,值為 introduce myself 的屬性。
rootElement.setAttribute(rootAttri);//將剛建立的屬性新增到根元素。
這兩行程式碼你也可以合成一行來寫，象這樣：
rootElement.setAttribute(new Attribute("comment","introduce myself"));
或者
rootElement.setAttribute("comment","introduce myself");

6.2.2新增元素和子元素

JDOM裡子元素是作為 content（內容）新增到父元素裡面去的,所謂content就是類似上面樣本文件中之間的東東，即kingwong。囉嗦了點是吧：）
Element nameElement = new Element("name");//建立 name 元素
nameElement.addContent("kingwong");//將kingwong作為content新增到name元素
rootElement.addContent(nameElement);//將name元素作為content新增到根元素
這三行你也可以合為一句，象這樣：
r ootElement.addContent((Content)(new Element("name").addContent("kingwong")));//因為addContent(Content child)方法返回的是一個Parent介面，而Element類同時繼承了Content類和實現了Parent介面，所以我們把它造型成Content。
我們用同樣的方法新增帶屬性的子元素
rootElement.addContent(new Element("sex").setAttribute("value","male"));//注意這裡不需要轉型，因為addAttribute(String name,String value)返回值就是一個 Element。
同樣的，我們新增元素到根元素下，用法上一樣，只是稍微複雜了一些：
rootElement.addContent((Content)(new Element("contact").addContent((Content)(new Element("telephone").addContent("87654321")))));
如果你對這種簡寫形式還不太習慣，你完全可以分步來做，就象本節剛開始的時候一樣。事實上如果層次比較多，寫成分步的形式更清晰些，也不容易出錯。

6.2.3刪除子元素

這個操作比較簡單：
rootElement.removeChild("sex");//該方法返回一個布林值
到目前為止，我們學習了一下JDOM文件生成操作。上面建立了一個樣本文件，可是我們怎麼知道對不對呢？因此需要輸出來看一下。我們將JDOM生成的文件輸出到控制檯，使用 JDOM 的 XMLOutputter 類。

6.3文字轉換

JDOM 轉為 XML 文字
XMLOutputter xmlOut = new XMLOutputter(" ",true);
try {
xmlOut.output(myDocument,System.out);
} catch (IOException e) {
e.printStackTrace();
}
XMLOutputter 有幾個格式選項。這裡我們已指定希望子元素從父元素縮排兩個空格，並且希望元素間有空行。
new XMLOutputter(java.lang.String indent, boolean newlines)這個方法在最新版本中已經不建議使用。JDOM有一個專門的用來定義格式化輸出的類：org.jdom.output.Format，如果你沒有特殊的要求，有時候使用裡面的幾個靜態方法（應該可以說是預定義格式）如 getPrettyFormat()就可以了。我們把上面的輸出格式稍微改一下，就象這樣：
XMLOutputter xmlOut = new XMLOutputter(Format.getPrettyFormat());
6.將JDOM文件轉化為其他形式
XMLOutputter 還可輸出到 Writer 或 OutputStream。為了輸出JDOM文件到一個文字檔案，我們可以這樣做：
FileWriter writer = new FileWriter("/some/directory/myFile.xml");
outputter.output(myDocument, writer);
writer.close();
XMLOutputter 還可輸出到字串,以便程式後面進行再處理:
Strng outString = xmlOut.outputString(myDocument);
當然，在輸出的時候你不一定要輸出所有的整個文件，你可以選擇元素進行輸出：
xmlOut.output(rootElement.getChild("name"),System.out);

7.例項程式碼

7.1準備工作，需要引入jdom的jar，本例項使用的是jdom-2.0.6.jar

7.2需要解析的xml檔案test.xml

<?xml version="1.0" encoding="UTF-8"?>
<HD>
  <disk name="C">
    <capacity>8G</capacity>
    <directories>200</directories>
    <files>1580</files>
  </disk>

  <disk name="D">
    <capacity>10G</capacity>
    <directories>500</directories>
    <files>3000</files>
  </disk>
</HD> 

7.3xml解析使用的類Sample1.java

import java.util.*;
import org.jdom2.*;
import org.jdom2.input.SAXBuilder;
public class Sample1 {
  public static void main(String[] args) throws Exception{ 
    SAXBuilder sb=new SAXBuilder();
    
    Document doc=sb.build(Sample1.class.getClassLoader().getResourceAsStream("test.xml")); //構造文件物件
    Element root=doc.getRootElement(); //獲取根元素HD
    List list=root.getChildren("disk");//取名字為disk的所有元素
    for(int i=0;i<list.size();i++){
       Element element=(Element)list.get(i);
       String name = element.getAttributeValue("name");//獲取name屬性值
       String capacity=element.getChildText("capacity");//取disk子元素capacity的內容
       String directories=element.getChildText("directories");//取disk子元素directories的內容
       String files=element.getChildText("files");//取disk子元素files的內容
       System.out.println("磁碟資訊:");
       System.out.println("分割槽碟符:"+name);
       System.out.println("分割槽容量:"+capacity);
       System.out.println("目錄數:"+directories);
       System.out.println("檔案數:"+files);
       System.out.println("-----------------------------------");
       
    }  
  }
} 

7.4執行結果：

本文簡單講述了使用jdom解析XML的相關知識，至於使用jdom操作xml的相關使用（比如建立、修改）等留待以後具體使用到的時候再來探討了。