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;
}
……
|