JAVA與XML 之JDOM

dom|xml

在 JDOM 中，XML 元素就是 Element 的執行個體，XML 屬性就是 Attribute 的執行個體，XML 文檔本身就是 Document 的執行個體。
    因為 JDOM 對象就是像 Document、Element 和 Attribute 這些類的直接執行個體，因此建立一個新 JDOM 對象就如在 Java 語言中使用 new 操作符一樣容易。JDOM 的使用是直截了當的。
    JDOM 使用標準的 Java 編碼模式。只要有可能，它使用 Java new 操作符而不故弄玄虛使用複雜的工廠化模式，使對象操作即便對於初學使用者也很方便。
   
    本文分兩步對JDOM的應用加以介紹：XML建立 和 XML解析
一、XML文檔建立
    我們由零開始利用JDOM產生一個XML文檔。最後的結果(樣本文檔)看起來象這樣：
    <?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 為根項目建立文檔
        Element rootElement = new Element("MyInfo");//所有的XML元素都是 Element 的執行個體。根項目也不例外：）
        Document myDocument = new Document(rootElement);//以根項目作為參數建立Document對象。一個Document只有一個根，即root元素。
    2.給根項目添加屬性
        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");
    3.添加元素和子項目
        JDOM裡子項目是作為 content（內容）添加到父元素裡面去的,所謂content就是類似上面樣本文檔中<name></name>之間的東東，即kingwong。羅嗦了點是吧：）
        Element nameElement = new Element("name");//建立 name 元素
        nameElement.addContent("kingwong");//將kingwong作為content添加到name元素
 rootElement.addContent(nameElement);//將name元素作為content添加到根項目
 
 這三行你也可以合為一句，象這樣：
 rootElement.addContent((Content)(new Element("name").addContent("kingwong")));//因為addContent(Content child)方法返回的是一個Parent介面，而Element類同時繼承了Content類和實現了Parent介面，所以我們把它造型成Content。
 
        我們用同樣的方法添加帶屬性的子項目<sex value="male"/>
        rootElement.addContent(new Element("sex").setAttribute("value","male"));//注意這裡不需要轉型，因為addAttribute(String name,String value)傳回值就是一個 Element。
       
        同樣的，我們添加<contract />元素到根項目下，用法上一樣，只是稍微複雜了一些：
        rootElement.addContent((Content)(new Element("contact").addContent((Content)(new Element("telephone").addContent("87654321")))));
        如果你對這種簡寫形式還不太習慣，你完全可以分步來做，就象本節剛開始的時候一樣。事實上如果層次比較多，寫成分步的形式更清晰些，也不容易出錯。
    4.刪除子項目
        這個操作比較簡單：
        rootElement.removeChild("sex");//該方法返回一個布爾值
       
        到目前為止，我們學習了一下JDOM文檔產生操作。上面建立了一個樣本文檔，可是我們怎麼知道對不對呢？因此需要輸出來看一下。我們將JDOM產生的文檔輸出到控制台，使用 JDOM 的 XMLOutputter 類。
    5.  將 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);
        一句話，JDOM非常靈活方便！如果你想進一步研究JDOM，請到官方網站去看一看：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文檔，它的另一個用處是它能夠讀取並操作現有的 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,有該屬性但是值為空白，則返回Null 字元串。
        getChildText("childname") 返回指定子節點的內容文本值。
        getText() 返回該元素的內容文本值。
       
        還有其他沒有羅列出來的方法，如果需要的話，可以隨時查閱JDOM的線上文檔：http://www.jdom.org/docs/apidocs/index.html。當然你可以在你需要的地方添加、刪除元素操作，還記得上面的建立XML的方法嗎？呵呵~~~
       
        學習新東東還是從執行個體學起最為快捷，下面簡單舉個例子，就以上面的XML樣本代碼來學習JDOM的XML解析。本例中讀取了樣本XML檔案裡一些屬性和content，最後我們還在contact元素裡插入了一個新元素<email value="wanghua@cyberobject.com" />。儘管我們實現了對於XML的基本操作，細心的朋友可能會
有疑問：如果XML文檔的層次稍微複雜一些，如果嵌套多達幾十上百層的話（開個玩笑），如果靠這樣從根項目一級一級地通過getChild("childname")來訪問子項目的話，將會非常痛苦！是的，的確是這樣，但是我們有另一個有力的工具XPath，為什麼不用呢？這是後話！先賣個關子（手敲累啦，下回吧，呵呵）。
       
/*
 * 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();
    }
}
}