DOM4J介紹與代碼示例

DOM4J 是 dom4j.org 出品的一個開源 XML 解析包。 Dom4j 是一個易用的、開源的庫，用於 XML ， XPath 和 XSLT 。它應用於 Java 平臺，採用了 Java 集合框架並徹底支持 DOM ， SAX 和 JAXP 。

DOM4J 下載 jar 包： http://downloads.sourceforge.net/dom4j/dom4j- 1.6.1 .jar

JAXEN （對 XPath 的支持）： http://dist.codehaus.org/jaxen/distributions/jaxen- 1.1.1 .zip

1.DOM4J 主要接口

DOM4J 主要接口都在 org.dom4j 這個包裏定義。

 

 

-Node 爲全部的 dom4j 中 XML 節點定義了多態行爲；

 

-Branch 爲可以包含子節點的節點如 XML 元素 (Element) 和文檔 (Docuemnts) 定義了一個公共的行爲；

|-Element 定義 XML 元素；

|-Document 定義了 XML 文檔；

 

-DocumentType 定義 XML DOCTYPE 聲明；

-Entity 定義 XML entity ；

-Attribute 定義了 XML 的屬性；

-ProcessingInstruction 定義 XML 處理指令；

 

-CharacterData 是一個標識藉口，標識基於字符的節點。如 CDATA ， Comment, Text ；

|- CDATA 定義了 XML CDATA 區域；

|-Text 定義 XML 文本節點；

|- Comment 定義了 XML 註釋的行爲；

2. 建立 XML 文檔

示例 xml ： students.xml

<? xml version="1.0" encoding="UTF-8"?> <? xml-stylesheet type="text/xsl" href="students.xsl"?> < students >     <!--A Student Catalog-->     < student sn="01">        < name > sam </ name >        < age > 18 </ age >     </ student >     < student sn="02">        < name > lin </ name >        < age > 20 </ age >     </ student > </ students >

 

下面是用 dom4j 建立上述文檔，經過兩種方式建立，一種是調用 dom4j 提供的方法，一種是經過字符串轉換。

XmlGen.java

import java.io.File; import java.io.FileWriter; import java.io.IOException; import java.util.HashMap; import java.util.Map;   import org.dom4j.Document; import org.dom4j.DocumentException; import org.dom4j.DocumentHelper; import org.dom4j.Element; import org.dom4j.io.XMLWriter;   public class XmlGen {     public Document generateDocumentByMethod() {        Document document = DocumentHelper.createDocument();        // ProcessingInstruction        Map<String, String> inMap = new HashMap<String, String>();        inMap.put( "type" , "text/xsl" );        inMap.put( "href" , "students.xsl" );        document.addProcessingInstruction( "xml-stylesheet" , inMap);        // root element        Element studentsElement = document.addElement( "students" );        studentsElement.addComment( "An Student Catalog" );        // son element        Element stuElement = studentsElement.addElement( "student" );        stuElement.addAttribute( "sn" , "01" );        Element nameElement = stuElement.addElement( "name" );        nameElement.setText( "sam" );        Element ageElement = stuElement.addElement( "age" );        ageElement.setText( "18" );        // son element        Element anotherStuElement = studentsElement.addElement( "student" );        anotherStuElement.addAttribute( "sn" , "02" );        Element anotherNameElement = anotherStuElement.addElement( "name" );        anotherNameElement.setText( "lin" );        Element anotherAgeElement = anotherStuElement.addElement( "age" );        anotherAgeElement.setText( "20" );          return document;     }       public Document generateDocumentByString() {        String text = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +               "<?xml-stylesheet type=\"text/xsl\" href=\"students.xsl\"?>" +               "<students><!--An Student Catalog-->   <student sn=\"01\">" +               "<name>sam</name><age>18</age></student><student sn=\"02\">" +               "<name>lin</name><age>20</age></student></students>" ;        Document document = null ;        try {            document = DocumentHelper.parseText(text);        } catch (DocumentException e) {            e.printStackTrace();        }        return document;     }       public void saveDocument(Document document, File outputXml) {        try {            // 美化格式            OutputFormat format = OutputFormat.createPrettyPrint();            /*// 縮減格式            OutputFormat format = OutputFormat.createCompactFormat();*/            /*// 指定 XML 編碼             format.setEncoding("GBK");*/            XMLWriter output = new XMLWriter( new FileWriter(outputXml), format);            output.write(document);            output.close();        } catch (IOException e) {            System. out .println(e.getMessage());        }     }       public static void main(String[] argv) {        XmlGen dom4j = new XmlGen();        Document document = null ;        // document=dom4j.generateDocumentByMethod();        document = dom4j.generateDocumentByString();        dom4j.saveDocument(document, new File( "output.xml" ));     } }

方法 generateDocumentByMethod() 經過調用方法構建 xml 文檔：

1. 使用 DocumentHelper 獲得 Document 實例

Document document = DocumentHelper.createDocument();

2. 建立 Processing Instruction

document.addProcessingInstruction( "xml-stylesheet" , inMap);

3. 建立元素 Element

Element studentsElement = document.addElement( "students" );

4. 爲元素添加註釋 Comment

studentsElement.addComment( "An Student Catalog" );

5. 爲元素添加屬性

studentsElement.addComment( "An Student Catalog" );

6. 爲元素添加文本值 Text

ageElement.setText( "18" );

 

方法 generateDocumentByString() 經過字符串轉換直接構建 xml 文檔，使用 DocumentHelper.parseText() 來實現 .

document = DocumentHelper.parseText(text);

 

方法 saveDocument(Document document, File outputXml) 將文檔輸出到文件保存，可指定字符編碼，可指定格式化輸出。

3. 修改 XML 文檔

這裏使用 xpath 來定位待修改的元素和屬性，須要 jaxen 的支持。

示例中將 students-gen.xml 的第一個 student 元素的 sn 屬性改成 001 ，其子元素 name 內容改成 jeff 。

XmlMod.java

import java.io.File; import java.io.FileWriter; import java.io.IOException; import java.util.Iterator; import java.util.List;   import org.dom4j.Attribute; import org.dom4j.Document; import org.dom4j.DocumentException; import org.dom4j.Element; import org.dom4j.io.SAXReader; import org.dom4j.io.XMLWriter;   public class XmlMod {     public void modifyDocument(File inputXml) {        try {            SAXReader saxReader = new SAXReader();            Document document = saxReader.read(inputXml);            List list = document.selectNodes( "//students/student/@sn" );            Iterator iter = list.iterator();            while (iter.hasNext()) {               Attribute attribute = (Attribute) iter.next();               if (attribute.getValue().equals( "01" ))                   attribute.setValue( "001" );            }              list = document.selectNodes( "//students/student" );            iter = list.iterator();            while (iter.hasNext()) {               Element element = (Element) iter.next();               Iterator iterator = element.elementIterator( "name" );               while (iterator.hasNext()) {                   Element nameElement = (Element) iterator.next();                   if (nameElement.getText().equals( "sam" ))                      nameElement.setText( "jeff" );               }            }              XMLWriter output = new XMLWriter( new FileWriter( new File(                   "students-modified.xml" )));            output.write(document);            output.close();        }          catch (DocumentException e) {            System. out .println(e.getMessage());        } catch (IOException e) {            System. out .println(e.getMessage());        }     }       public static void main(String[] argv) {        XmlMod dom4jParser = new XmlMod();        dom4jParser.modifyDocument( new File( "students-gen.xml" ));     } }

1. 使用 File 定位文件資源，並基於此得到 Document 實例

SAXReader saxReader = new SAXReader();

Document document = saxReader.read(inputXml);

2.Document 實例的 selectNodes 方法能夠傳入 xpath ，並返回一個 List 實例，基於此使用迭代器，完成特定的應用

List list = document.selectNodes( "//students/student/@sn" );

4. 遍歷 XML 文檔

這裏提供兩種遍歷方法，一種是基於迭代的遍歷，一種是基於 Visitor 模式的遍歷。

XmlTra.java

import java.io.File; import java.util.Iterator;   import org.dom4j.Attribute; import org.dom4j.Document; import org.dom4j.DocumentException; import org.dom4j.Element; import org.dom4j.ProcessingInstruction; import org.dom4j.VisitorSupport; import org.dom4j.io.SAXReader;   public class XmlTra {     private File inputXml ;       public XmlTra(File inputXml) {        this . inputXml = inputXml;     }       public Document getDocument() {        SAXReader saxReader = new SAXReader();        Document document = null ;        try {            document = saxReader.read( inputXml );        } catch (DocumentException e) {            e.printStackTrace();        }        return document;     }       public Element getRootElement() {        return getDocument().getRootElement();     }       public void traversalDocumentByIterator() {        Element root = getRootElement();        // 枚舉根節點下全部子節點        for (Iterator ie = root.elementIterator(); ie.hasNext();) {            System. out .println( "======" );            Element element = (Element) ie.next();            System. out .println(element.getName());              // 枚舉屬性            for (Iterator ia = element.attributeIterator(); ia.hasNext();) {               Attribute attribute = (Attribute) ia.next();               System. out .println(attribute.getName() + ":"                      + attribute.getData());            }            // 枚舉當前節點下全部子節點            for (Iterator ieson = element.elementIterator(); ieson.hasNext();) {               Element elementSon = (Element) ieson.next();               System. out .println(elementSon.getName() + ":"                      + elementSon.getText());            }        }     }       public void traversalDocumentByVisitor() {        getDocument().accept( new MyVisitor());     }       /**       * 定義本身的訪問者類       */     private static class MyVisitor extends VisitorSupport {        /**          * 對於屬性節點，打印屬性的名字和值          */        public void visit(Attribute node) {            System. out .println( "attribute : " + node.getName() + " = "                   + node.getValue());        }          /**          * 對於處理指令節點，打印處理指令目標和數據          */        public void visit(ProcessingInstruction node) {            System. out .println( "PI : " + node.getTarget() + " "                   + node.getText());        }          /**          * 對於元素節點，判斷是否只包含文本內容，如是，則打印標記的名字和 元素的內容。若是不是，則只打印標記的名字          */        public void visit(Element node) {            if (node.isTextOnly())               System. out .println( "element : " + node.getName() + " = "                      + node.getText());            else               System. out .println( "--------" + node.getName() + "--------" );        }     }       public static void main(String[] argv) {        XmlTra dom4jParser = new XmlTra( new File( "students-gen.xml" ));        // dom4jParser.traversalDocumentByIterator();        dom4jParser.traversalDocumentByVisitor();     } }

方法 traversalDocumentByIterator() 提供一種基於迭代的遍歷實現，每一個 Element 經過 elementIterator() 和 attributeIterator() 取代其子元素和屬性的迭代器。

Visitor 是 GOF 設計模式之一。其主要原理就是兩種類互相保有對方的引用，而且一種做爲 Visitor 去訪問許多 Visitable 。 DOM4J 中的 Visitor 模式只須要自定一個類實現 Visitor 接口便可。

public class MyVisitor extends VisitorSupport {     public void visit(Element element) {        System. out .println(element.getName());     }       public void visit(Attribute attr) {        System. out .println(attr.getName());     } }

調用：   root.accept(new MyVisitor())

    Visitor 接口提供多種 Visit() 的重載，根據 XML 不一樣的對象，將採用不一樣的方式來訪問。上面是給出的 Element 和 Attribute 的簡單實現，通常比較經常使用的就是這兩個。 VisitorSupport 是 DOM4J 提供的默認適配器， Visitor 接口的 Default Adapter 模式，這個模式給出了各類 visit(*) 的空實現，以便簡化代碼。

    注意，這個 Visitor 是自動遍歷全部子節點的。若是是 root.accept(MyVisitor) ，將遍歷子節點。我第一次用的時候，認爲是須要本身遍歷，便在遞歸中調用 Visitor ，結果可想而知。

5. 使用 ElementHandler

XmlHandler.java

import java.io.File;   import org.dom4j.DocumentException; import org.dom4j.Element; import org.dom4j.ElementHandler; import org.dom4j.ElementPath; import org.dom4j.io.SAXReader;   public class XmlHandler {     public static void main(String[] args) {        SAXReader saxReader = new SAXReader();        File file = new File( "students.xml" );        try {            // 添加一個 ElementHandler 實例。            saxReader.addHandler( "/students/student" , new StudentHandler());            saxReader.read(file);          } catch (DocumentException e) {            System. out .println(e.getMessage());        }     }       /**       * 定義 StudentHandler 處理器類，對 <student> 元素進行處理。       */     private static class StudentHandler implements ElementHandler {        public void .Start(ElementPath path) {            Element elt = path.getCurrent();            System. out .println( "Found student: " + elt.attribut.ue( "sn" ));            // 添加對子元素 <name> 的處理器。            path.addHandler( "name" , new NameHandler());        }          public void .End(ElementPath path) {            // 移除對子元素 <name> 的處理器。            path.removeHandler( "name" );        }     }       /**       * 定義 NameHandler 處理器類，對 <student> 的 <name> 子元素進行處理。       */     private static class NameHandler implements ElementHandler {        public void .Start(ElementPath path) {            System. out .println( "path : " + path.getPath());        }          public void .End(ElementPath path) {            Element elt = path.getCurrent();            // 輸出 <name> 元素的名字和它的文本內容。            System. out .println(elt.getName() + " : " + elt.getText());        }     } }

6. 使用 XSLT 轉換 XML

這裏必須使用 JAXP 的支持。

import javax.xml.transform.Transformer; import javax.xml.transform.TransformerFactory;   import org.dom4j.Document; import org.dom4j.io.DocumentResult; import org.dom4j.io.DocumentSource;       ……     public Document styleDocument(Document document, String stylesheet)            throws Exception {          // load the transformer using JAXP        TransformerFactory factory = TransformerFactory.newInstance();        Transformer transformer = factory.newTransformer( new StreamSource(stylesheet));          // now lets style the given document        DocumentSource source = new DocumentSource(document);        DocumentResult result = new DocumentResult();        transformer.transform(source, result);          // return the transformed document        Document transformedDoc = result.getDocument();        return transformedDoc;     } ……