Dom4j完整教程
目錄
1、DOM4J簡介
DOM4J是 dom4j.org 出品的一個開源 XML 解析包。DOM4J應用於 Java 平台，采用了 Java 集合框架並完全支持 DOM，SAX 和 JAXP。
DOM4J 使用起來非常簡單。只要你了解基本的 XML-DOM 模型，就能使用。
Dom：把整個文檔作為一個對象。
DOM4J 最大的特色是使用大量的接口。它的主要接口都在org.dom4j里面定義：
| Attribute |
定義了 XML 的屬性。 |
| Branch |
指能夠包含子節點的節點。如XML元素(Element)和文檔(Docuemnts)定義了一個公共的行為 |
| CDATA |
定義了 XML CDATA 區域 |
| CharacterData |
是一個標識接口，標識基於字符的節點。如CDATA，Comment, Text. |
| Comment |
定義了 XML 注釋的行為 |
| Document |
定義了XML 文檔 |
| DocumentType |
定義 XML DOCTYPE 聲明 |
| Element |
定義XML 元素 |
| ElementHandler |
定義了Element 對象的處理器 |
| ElementPath |
被 ElementHandler 使用，用於取得當前正在處理的路徑層次信息 |
| Entity |
定義 XML entity |
| Node |
為dom4j中所有的XML節點定義了多態行為 |
| NodeFilter |
定義了在dom4j 節點中產生的一個濾鏡或謂詞的行為（predicate） |
| ProcessingInstruction |
定義 XML 處理指令 |
| Text |
定義 XML 文本節點 |
| Visitor |
用於實現 Visitor模式 |
| XPath |
在分析一個字符串后會提供一個 XPath 表達式 |
接口之間的繼承關系如下：
interface java.lang.Cloneable
interface org.dom4j.Node
interface org.dom4j.Attribute
interface org.dom4j.Branch
interface org.dom4j.Document
interface org.dom4j.Element
interface org.dom4j.CharacterData
interface org.dom4j.CDATA
interface org.dom4j.Comment
interface org.dom4j.Text
interface org.dom4j.DocumentType
interface org.dom4j.Entity
interface org.dom4j.ProcessingInstruction
2、XML文檔操作1
2.1、讀取XML文檔：
讀寫XML文檔主要依賴於org.dom4j.io包，有DOMReader和SAXReader兩種方式。因為利用了相同的接口，它們的調用方式是一樣的。
-
-
public static Document load(String filename) {
-
Document document = null;
-
try {
-
SAXReader saxReader = new SAXReader();
-
document = saxReader.read( new File(filename)); // 讀取XML文件,獲得document對象
-
} catch (Exception ex) {
-
ex.printStackTrace();
-
}
-
return document;
-
}
-
-
public static Document load(URL url) {
-
Document document = null;
-
try {
-
SAXReader saxReader = new SAXReader();
-
document = saxReader.read(url); // 讀取XML文件,獲得document對象
-
} catch (Exception ex) {
-
ex.printStackTrace();
-
}
-
return document;
-
}
-
//讀取指定的xml文件之后返回一個Document對象，這個對象代表了整個XML文檔，用於各種Dom運算。執照XML文件頭所定義的編碼來轉換。
2.2、獲取根節點
根節點是xml分析的開始，任何xml分析工作都需要從根開始
-
Xml xml =
new Xml();
-
-
Document dom = xml.load(path +
"/" + file);
-
-
Element root = dom.getRootElement();
2.3、. 新增一個節點以及其下的子節點與數據
-
Element menuElement = root.addElement(
"menu");
-
-
Element engNameElement = menuElement.addElement(
"engName");
-
-
engNameElement.setText(catNameEn);
-
-
Element chiNameElement = menuElement.addElement(
"chiName");
-
-
chiNameElement.setText(catName);
2.4、 寫入XML文件
注意文件操作的包裝類是亂碼的根源
-
public static boolean doc2XmlFile(Document document, String filename) {
-
boolean flag =
true;
-
try {
-
XMLWriter writer =
new XMLWriter(
new OutputStreamWriter(
-
new FileOutputStream(filename),
"UTF-8"));
-
writer.write(document);
-
writer.close();
-
}
catch (Exception ex) {
-
flag =
false;
-
ex.printStackTrace();
-
}
-
System.out.println(flag);
-
return flag;
-
}
Dom4j通過XMLWriter將Document對象表示的XML樹寫入指定的文件，並使用OutputFormat格式對象指定寫入的風格和編碼方法。調用OutputFormat.createPrettyPrint()方法可以獲得一個默認的pretty print風格的格式對象。對OutputFormat對象調用setEncoding()方法可以指定XML文件的編碼方法。
-
public void writeTo(OutputStream out, String encoding)
-
throws UnsupportedEncodingException, IOException {
-
OutputFormat format = OutputFormat.createPrettyPrint();
-
-
format.setEncoding(
"gb2312");
-
-
XMLWriter writer =
new XMLWriter(System.out, format);
-
-
writer.write(doc);
-
-
writer.flush();
-
-
return;
-
-
}
2. 5、 遍歷xml節點
對Document對象調用getRootElement()方法可以返回代表根節點的Element對象。擁有了一個Element對象后，可以對該對象調用elementIterator()方法獲得它的子節點的Element對象們的一個迭代器。使用(Element)iterator.next()方法遍歷一個iterator並把每個取出的元素轉化為Element類型。
-
public boolean isOnly(String catNameEn, HttpServletRequest request,
-
String xml) {
-
boolean flag =
true;
-
String path = request.getRealPath(
"");
-
Document doc = load(path +
"/" + xml);
-
Element root = doc.getRootElement();
-
for (Iterator i = root.elementIterator(); i.hasNext();) {
-
Element el = (Element) i.next();
-
if (catNameEn.equals(el.elementTextTrim(
"engName"))) {
-
flag =
false;
-
break;
-
}
-
}
-
return flag;
-
}
2.6、創建xml文件
-
public static void main(String args[]) {
-
-
String fileName =
"c:/text.xml";
-
-
Document document = DocumentHelper.createDocument();
// 建立document對象，用來操作xml文件
-
-
Element booksElement = document.addElement(
"books");
// 建立根節點
-
-
booksElement.addComment(
"This is a test for dom4j ");
// 加入一行注釋
-
-
Element bookElement = booksElement.addElement(
"book");
// 添加一個book節點
-
-
bookElement.addAttribute(
"show",
"yes");
// 添加屬性內容
-
-
Element titleElement = bookElement.addElement(
"title");
// 添加文本節點
-
-
titleElement.setText(
"ajax in action");
// 添加文本內容
-
-
try {
-
-
XMLWriter writer =
new XMLWriter(
new FileWriter(
new File(fileName)));
-
writer.write(document)
//寫入
-
-
writer.close();
-
-
}
catch (Exception e) {
-
-
e.printStackTrace();
-
-
}
-
-
}
2.7、修改節點屬性
-
public static void modifyXMLFile() {
-
-
String oldStr =
"c:/text.xml";
-
-
String newStr =
"c:/text1.xml";
-
-
Document document =
null;
-
-
//修改節點的屬性
-
-
try {
-
-
SAXReader saxReader =
new SAXReader();
// 用來讀取xml文檔
-
-
document = saxReader.read(
new File(oldStr));
// 讀取xml文檔
-
-
List list = document.selectNodes(
"/books/book/@show");
// 用xpath查找節點book的屬性
-
-
Iterator iter = list.iterator();
-
-
while (iter.hasNext()) {
-
-
Attribute attribute = (Attribute) iter.next();
-
-
if (attribute.getValue().equals(
"yes"))
-
-
attribute.setValue(
"no");
-
-
}
-
-
}
catch (Exception e) {
-
-
e.printStackTrace();
-
-
}
-
-
//修改節點的內容
-
-
try {
-
-
SAXReader saxReader =
new SAXReader();
// 用來讀取xml文檔
-
-
document = saxReader.read(
new File(oldStr));
// 讀取xml文檔
-
-
List list = document.selectNodes(
"/books/book/title");
// 用xpath查找節點book的內容
-
-
Iterator iter = list.iterator();
-
-
while (iter.hasNext()) {
-
-
Element element = (Element) iter.next();
-
-
element.setText(
"xxx");
// 設置相應的內容
-
-
}
-
-
}
catch (Exception e) {
-
-
e.printStackTrace();
-
-
}
-
-
-
-
try {
-
-
XMLWriter writer =
new XMLWriter(
new FileWriter(
new File(newStr)));
-
-
writer.write(document);
-
-
writer.close();
-
-
}
catch (Exception ex) {
-
-
ex.printStackTrace();
-
-
}
-
-
}
-
2.8、刪除節點
-
public static void removeNode() {
-
-
String oldStr =
"c:/text.xml";
-
-
String newStr =
"c:/text1.xml";
-
-
Document document =
null;
-
-
try {
-
-
SAXReader saxReader =
new SAXReader();
// 用來讀取xml文檔
-
-
document = saxReader.read(
new File(oldStr));
// 讀取xml文檔
-
-
List list = document.selectNodes(
"/books/book");
// 用xpath查找對象
-
-
Iterator iter = list.iterator();
-
-
while (iter.hasNext()) {
-
-
Element bookElement = (Element) iter.next();
-
-
// 創建迭代器，用來查找要刪除的節點,迭代器相當於指針，指向book下所有的title節點
-
-
Iterator iterator = bookElement.elementIterator(
"title");
-
-
while (iterator.hasNext()) {
-
-
Element titleElement = (Element) iterator.next();
-
-
if (titleElement.getText().equals(
"ajax in action")) {
-
-
bookElement.remove(titleElement);
-
-
}
-
-
}
-
-
}
-
-
}
catch (Exception e) {
-
-
e.printStackTrace();
-
-
}
-
-
try {
-
-
XMLWriter writer =
new XMLWriter(
new FileWriter(
new File(newStr)));
-
-
writer.write(document);
-
-
writer.close();
-
-
}
catch (Exception ex) {
-
-
ex.printStackTrace();
-
-
}
-
-
}
-
-
2、XML文檔操作2
2.1、Document對象相關
1、讀取XML文件,獲得document對象.
-
SAXReader reader =
new SAXReader();
-
Document
document = reader.read(
new File(
"input.xml"));
2、解析XML形式的文本,得到document對象.
-
String text =
"<members></members>";
-
Document document = DocumentHelper.parseText(text);
3、主動創建document對象.
-
Document document = DocumentHelper.createDocument();
-
Element root = document.addElement(
"members");
// 創建根節點
2.2、節點相關
1、獲取文檔的根節點.
Element rootElm = document.getRootElement();
2、取得某節點的單個子節點.
Element memberElm=root.element("member");// "member"是節點名
3.取得節點的文字
-
String text=memberElm.getText();
-
String text=root.elementText(
"name");這個是取得根節點下的name字節點的文字.
4.取得某節點下指定名稱的所有節點並進行遍歷.
-
List nodes = rootElm.elements(
"member");
-
for (Iterator it = nodes.iterator(); it.hasNext();) {
-
Element elm = (Element) it.next();
-
// do something
-
}
5.對某節點下的所有子節點進行遍歷.
-
for(Iterator it=root.elementIterator();it.hasNext();){
-
Element element = (Element) it.next();
-
// do something
-
}
6.在某節點下添加子節點.
Element ageElm = newMemberElm.addElement("age");
7.設置節點文字.
ageElm.setText("29");
8.刪除某節點.
parentElm.remove(childElm); // childElm是待刪除的節點,parentElm是其父節點
9.添加一個CDATA節點.
-
Element contentElm = infoElm.addElement(
"content");
-
contentElm.addCDATA(diary.getContent());
-
2.3、屬性相關.
1.取得節點的指定的屬性
-
Element root=document.getRootElement();
-
Attribute attribute=root.attribute(
"size");
// 屬性名name
2.取得屬性的文字
-
String text=attribute.getText();
-
String text2=root.element(
"name").attributeValue(
"firstname");
-
//這個是取得根節點下name字節點的firstname屬性的值.
3.遍歷某節點的所有屬性
-
Element root=document.getRootElement();
-
for(Iterator it=root.attributeIterator();it.hasNext();){
-
Attribute attribute = (Attribute) it.next();
-
String text=attribute.getText();
-
System.out.println(text);
-
}
4.設置某節點的屬性和文字.
newMemberElm.addAttribute("name", "sitinspring");
5.設置屬性的文字
-
Attribute attribute=root.attribute(
"name");
-
attribute.setText(
"sitinspring");
6.刪除某屬性
-
Attribute attribute=root.attribute(
"size");
// 屬性名name
-
root.remove(attribute);
2.4、將文檔寫入XML文件.
1.文檔中全為英文,不設置編碼,直接寫入.
-
XMLWriter writer =
new XMLWriter(
new FileWriter(
"output.xml"));
-
writer.write(document);
-
writer.close();
2.文檔中含有中文,設置編碼格式再寫入.
-
OutputFormat format = OutputFormat.createPrettyPrint();
-
format.setEncoding(
"GBK");
// 指定XML編碼
-
XMLWriter writer =
new XMLWriter(
new FileWriter(
"output.xml"),format);
-
writer.write(document);
-
writer.close();
2.5、字符串與XML的轉換
1.將字符串轉化為XML
-
String text =
"<members> <member>sitinspring</member> </members>";
-
Document document = DocumentHelper.parseText(text);
2.將文檔或節點的XML轉化為字符串.
S
-
AXReader reader =
new SAXReader();
-
Document document = reader.read(
new File(
"input.xml"));
-
Element root=document.getRootElement();
-
String docXmlText=document.asXML();
-
String rootXmlText=root.asXML();
-
Element memberElm=root.element(
"member");
-
String memberXmlText=memberElm.asXML();
-
-
3、dom4j的事件處理模型涉及的類和接口：
3.1、類：SAXReader
當解析到path指定的路徑時，將調用參數handler指定的處理器。針對不同的節點可以添加多個handler實例。或者調用默認的Handler setDefaultHandler(ElementHandler handler);
3.2、接口ElementHandler
該方法在解析到元素的開始標簽時被調用。
該方法在解析到元素的結束標簽時被調用
3.3、接口：ElementPath （假設有參數：ElementPath path）
該方法與SAXReader類中的addHandler()方法的作用相同。路徑path可以是絕對路徑（路徑以/開頭），也可以是相對路徑（假設是當前路徑的子節點路徑）。
移除指定路徑上的ElementHandler實例。路徑可以是相對路徑，也可以是絕對路徑。
該方法得到當前節點的路徑。該方法返回的是完整的絕對路徑
該方法得到當前節點。
3.3、Element類
| getQName() |
元素的QName對象 |
| getNamespace() |
元素所屬的Namespace對象 |
| getNamespacePrefix() |
元素所屬的Namespace對象的prefix |
| getNamespaceURI() |
元素所屬的Namespace對象的URI |
| getName() |
元素的local name |
| getQualifiedName() |
元素的qualified name |
| getText() |
元素所含有的text內容，如果內容為空則返回一個空字符串而不是null |
| getTextTrim() |
元素所含有的text內容，其中連續的空格被轉化為單個空格，該方法不會返回null |
| attributeIterator() |
元素屬性的iterator，其中每個元素都是Attribute對象 |
| attributeValue() |
元素的某個指定屬性所含的值 |
| elementIterator() |
元素的子元素的iterator，其中每個元素都是Element對象 |
| element() |
元素的某個指定（qualified name或者local name）的子元素 |
| elementText() |
元素的某個指定（qualified name或者local name）的子元素中的text信息 |
| getParent |
元素的父元素 |
| getPath() |
元素的XPath表達式，其中父元素的qualified name和子元素的qualified name之間使用"/"分隔 |
| isTextOnly() |
是否該元素只含有text或是空元素 |
| isRootElement() |
是否該元素是XML樹的根節點 |
3.4、類DocumentHelper
DocumentHelper 是用來生成生成 XML 文檔的工廠類
4、通過xpath查找指定的節點
采用xpath查找需要引入jaxen-xx-xx.jar，否則會報java.lang.NoClassDefFoundError: org/jaxen/JaxenException異常。
-
-
List list=document.selectNodes(
"/books/book/@show");
4.1、 xpath語法
1、選取節點
XPath 使用路徑表達式在 XML 文檔中選取節點，節點是沿着路徑或者 step 來選取的。
常見的路徑表達式：
| 表達式 |
描述 |
| nodename |
選取當前節點的所有子節點 |
| / |
從根節點選取 |
| // |
從匹配選擇的當前節點選擇文檔中的節點，而不考慮它們的位置 |
| . |
選取當前節點 |
| .. |
選取當前節點的父節點 |
| @ |
選取屬性 |
實例
| 路徑表達式 |
結果 |
| bookstore |
選取 bookstore 元素的所有子節點 |
| /bookstore |
選取根元素 bookstore |
| bookstore/book |
選取bookstore 下名字為 book的所有子元素。 |
| //book |
選取所有 book 子元素，而不管它們在文檔中的位置。 |
| bookstore//book |
選取bookstore 下名字為 book的所有后代元素，而不管它們位於 bookstore 之下的什么位置。 |
| //@lang |
選取所有名為 lang 的屬性。 |
2、謂語（Predicates）
謂語用來查找某個特定的節點或者包含某個指定的值的節點。
謂語被嵌在方括號中。
實例
常見的謂語的一些路徑表達式：
| 路徑表達式 |
結果 |
| /bookstore/book[1] |
選取屬於 bookstore 子元素的第一個 book 元素。 |
| /bookstore/book[last()] |
選取屬於 bookstore 子元素的最后一個 book 元素。 |
| /bookstore/book[last()-1] |
選取屬於 bookstore 子元素的倒數第二個 book 元素。 |
| /bookstore/book[position()<3] |
選取最前面的兩個屬於 bookstore 元素的子元素的 book 元素。 |
| //title[@lang] |
選取所有擁有名為 lang 的屬性的 title 元素。 |
| //title[@lang='eng'] |
選取所有 title 元素，要求這些元素擁有值為 eng 的 lang 屬性。 |
| /bookstore/book[price>35.00] |
選取所有 bookstore 元素的 book 元素，要求book元素的子元素 price 元素的值須大於 35.00。 |
| /bookstore/book[price>35.00]/title |
選取所有 bookstore 元素中的 book 元素的 title 元素，要求book元素的子元素 price 元素的值須大於 35.00 |
3、選取未知節點
XPath 通配符可用來選取未知的 XML 元素。
| 通配符 |
描述 |
| * |
匹配任何元素節點 |
| @* |
匹配任何屬性節點 |
| node() |
匹配任何類型的節點 |
實例
| 路徑表達式 |
結果 |
| /bookstore/* |
選取 bookstore 元素的所有子節點 |
| //* |
選取文檔中的所有元素 |
| //title[@*] |
選取所有帶有屬性的 title 元素。 |
4、選取若干路徑
通過在路徑表達式中使用“|”運算符，您可以選取若干個路徑。
實例
| 路徑表達式 |
結果 |
| //book/title | //book/price |
選取所有 book 元素的 title 和 price 元素。 |
| //title | //price |
選取所有文檔中的 title 和 price 元素。 |
| /bookstore/book/title|//price |
選取所有屬於 bookstore 元素的 book 元素的title 元素，以及文檔中所有的 price 元素。 |
5、XPath 軸
軸可定義某個相對於當前節點的節點集。
| 軸名稱 |
結果 |
| ancestor |
選取當前節點的所有先輩（父、祖父等） |
| ancestor-or-self |
選取當前節點的所有先輩（父、祖父等）以及當前節點本身 |
| attribute |
選取當前節點的所有屬性 |
| child |
選取當前節點的所有子元素。 |
| descendant |
選取當前節點的所有后代元素（子、孫等）。 |
| descendant-or-self |
選取當前節點的所有后代元素（子、孫等）以及當前節點本身。 |
| following |
選取文檔中當前節點的結束標簽之后的所有節點。 |
| namespace |
選取當前節點的所有命名空間節點 |
| parent |
選取當前節點的父節點。 |
| preceding |
選取文檔中當前節點的開始標簽之前的所有節點。 |
| preceding-sibling |
選取當前節點之前的所有同級節點。 |
| self |
選取當前節點。 |
6、路徑
位置路徑可以是絕對的，也可以是相對的。
絕對路徑起始於正斜杠( / )，而相對路徑不會這樣。在兩種情況中，位置路徑均包括一個或多個步，每個步均被斜杠分割：
/step/step/...
step/step/...
每個步均根據當前節點集之中的節點來進行計算。
軸（axis）：定義所選節點與當前節點之間的樹關系
節點測試（node-test）：識別某個軸內部的節點
零個或者更多謂語（predicate）：更深入地提煉所選的節點集
步的語法：軸名稱::節點測試[謂語]
實例
| 例子 |
結果 |
| child::book |
選取所有屬於當前節點的子元素的 book 節點 |
| attribute::lang |
選取當前節點的 lang 屬性 |
| child::* |
選取當前節點的所有子元素 |
| attribute::* |
選取當前節點的所有屬性 |
| child::text() |
選取當前節點的所有文本子節點 |
| child::node() |
選取當前節點的所有子節點 |
| descendant::book |
選取當前節點的所有 book 后代 |
| ancestor::book |
選擇當前節點的所有 book 先輩 |
| ancestor-or-self::book |
選取當前節點的所有book先輩以及當前節點（假如此節點是book節點的話） |
| child::*/child::price |
選取當前節點的所有 price 孫。 |
7、XPath 運算符
| 運算符 |
描述 |
實例 |
返回值 |
| | |
計算兩個節點集 |
//book | //cd |
返回所有帶有 book 和 ck 元素的節點集 |
| + |
加法 |
6 + 4 |
10 |
| - |
減法 |
6 - 4 |
2 |
| * |
乘法 |
6 * 4 |
24 |
| div |
除法 |
8 div 4 |
2 |
| = |
等於 |
price=9.80 |
如果 price 是 9.80，則返回 true。 如果 price 是 9.90，則返回 fasle。 |
| != |
不等於 |
price!=9.80 |
如果 price 是 9.90，則返回 true。 如果 price 是 9.80，則返回 fasle。 |
| < |
小於 |
price<9.80 |
如果 price 是 9.00，則返回 true。 如果 price 是 9.90，則返回 fasle。 |
| <= |
小於或等於 |
price<=9.80 |
如果 price 是 9.00，則返回 true。 如果 price 是 9.90，則返回 fasle。 |
| > |
大於 |
price>9.80 |
如果 price 是 9.90，則返回 true。 如果 price 是 9.80，則返回 fasle。 |
| >= |
大於或等於 |
price>=9.80 |
如果 price 是 9.90，則返回 true。 如果 price 是 9.70，則返回 fasle。 |
| or |
或 |
price=9.80 or price=9.70 |
如果 price 是 9.80，則返回 true。 如果 price 是 9.50，則返回 fasle。 |
| and |
與 |
price>9.00 and price<9.90 |
如果 price 是 9.80，則返回 true。 如果 price 是 8.50，則返回 fasle。 |
| mod |
計算除法的余數 |
5 mod 2 |
1 |