本文轉自:https://www.cnblogs.com/liuchaogege/p/5869044.html 1 dom4j介紹 dom4j是一個Java的XML API,類似於jdom,用來讀寫XML文件的。dom4j是一個非常非常優秀的Java XML API,具有性能優異、功能強大和極端易用 ...
本文轉自:https://www.cnblogs.com/liuchaogege/p/5869044.html
1 dom4j介紹
dom4j是一個Java的XML API,類似於jdom,用來讀寫XML文件的。dom4j是一個非常非常優秀的Java XML API,具有性能優異、功能強大和極端易用使用的特點,同時它也是一個開放源代碼的軟體,可以在SourceForge上找到它。在IBM developerWorks上面可以找到一篇文章,對主流的Java XML API進行的性能、功能和易用性的評測,dom4j無論在那個方面都是非常出色的。如今你可以看到越來越多的Java軟體都在使用dom4j來讀寫XML,特別值得一提的是連Sun的JAXM也在用dom4j。這是必須使用的jar包, Hibernate用它來讀寫配置文件。 dom4j主要介面都在org.dom4j這個包里定義: Attribute Attribute定義了XML的屬性 Branch Branch為能夠包含子節點的節點如XML元素(Element)和文檔(Docuemnts)定義了一個公共的行為, CDATA CDATA 定義了XML CDATA 區域 CharacterData CharacterData是一個標識藉口,標識基於字元的節點。如CDATA,Comment, Text. Comment Comment 定義了XML註釋的行為 Document 定義了XML文檔 DocumentType DocumentType 定義XML DOCTYPE聲明 Element Element定義XML 元素 ElementHandler ElementHandler定義了 Element 對象的處理器 ElementPath 被 ElementHandler 使用,用於取得當前正在處理的路徑層次信息 Entity Entity定義 XML entity Node Node為所有的dom4j中XML節點定義了多態行為 NodeFilter NodeFilter 定義了在dom4j節點中產生的一個濾鏡或謂詞的行為(predicate) ProcessingInstruction ProcessingInstruction 定義 XML 處理指令. Text Text 定義XML 文本節點. Visitor Visitor 用於實現Visitor模式. XPath XPath 在分析一個字元串後會提供一個XPath 表達式2 使用dom4j創建xml文檔
Document document = DocumentHelper.createDocument(); 通過這句定義一個XML文檔對象。 Element root = document.addElement("根節點名稱"); 通過這句定義一個XML元素,這裡添加的是根節點。 Element有幾個重要的方法: addComment : 添加註釋 addAttribute : 添加屬性 addElement : 添加子元素 最後通過XMLWriter生成物理文件,預設生成的XML文件排版格式比較亂,可以通過OutputFormat類格式化輸出,預設採用createCompactFormat()顯示比較緊湊,最好使用createPrettyPrint()。 實例代碼1 package cn.mars.app.txn.whpf; 2 3 import java.io.FileOutputStream; 4 5 import org.dom4j.Attribute; 6 import org.dom4j.Document; 7 import org.dom4j.DocumentHelper; 8 import org.dom4j.Element; 9 import org.dom4j.io.OutputFormat; 10 import org.dom4j.io.XMLWriter; 11 12 public class Dom4jTest { 13 14 public static void main(String[] args) { 15 // 創建文檔。 16 Document document = DocumentHelper.createDocument(); 17 // 設置文檔DocType,這裡為了舉例,添加hibernate的DocType 18 document.addDocType("hibernate-configuration", "-//Hibernate/Hibernate Configuration DTD 3.0//EN", 19 "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"); 20 // 文檔增加節點,即根節點,一個文檔只能有一個根節點,多加出錯 21 Element root = document.addElement("skills"); 22 // 添加註釋 23 root.addComment("第一個技能"); 24 // 根節點下添加節點 25 Element first = root.addElement("skill"); 26 // 節點添加屬性 27 first.addAttribute("name", "獨孤九劍"); 28 // 節點下添加節點 29 Element info = first.addElement("info"); 30 // 節點設置內容數據 31 info.setText("為獨孤求敗所創,變化萬千,凌厲無比。其傳人主要有風清揚、令狐沖。"); 32 33 // 同理增加其他節點,內容,屬性等 34 Element second = root.addElement("skill"); 35 second.addAttribute("name", "葵花寶典"); 36 Element info2 = second.addElement("info"); 37 info2.setText("宦官所創,博大精深,而且凶險至極。練寶典功夫時,首先要自宮凈身。"); 38 39 // 創建節點 40 Element third = DocumentHelper.createElement("skill"); 41 // 將節點加入到根節點中 42 root.add(third); 43 // 創建屬性,第一個參數指定了擁有者,也可以為null,指定擁有者 44 Attribute name = DocumentHelper.createAttribute(third, "name", "北冥神功"); 45 // 將屬性加入到節點上 46 third.add(name); 47 // 創建子節點並加入到節點中 48 Element info3 = DocumentHelper.createElement("info"); 49 info3.setText("逍遙派的頂級內功之一,能吸人內力轉化為自己所有,威力無窮。"); 50 third.add(info3); 51 52 try { 53 // 創建格式化類 54 OutputFormat format = OutputFormat.createPrettyPrint(); 55 // 設置編碼格式,預設UTF-8 56 format.setEncoding("UTF-8"); 57 // 創建輸出流,此處要使用Writer,需要指定輸入編碼格式,使用OutputStream則不用 58 FileOutputStream fos = new FileOutputStream("d:/skills.xml"); 59 // 創建xml輸出流 60 XMLWriter writer = new XMLWriter(fos, format); 61 // 生成xml文件 62 writer.write(document); 63 writer.close(); 64 } catch (Exception e) { 65 e.printStackTrace(); 66 } 67 } 68 }
輸出文件內容:
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> 3 4 <skills> 5 <!--第一個技能--> 6 <skill name="獨孤九劍"> 7 <info>為獨孤求敗所創,變化萬千,凌厲無比。其傳人主要有風清揚、令狐沖。</info> 8 </skill> 9 <skill name="葵花寶典"> 10 <info>宦官所創,博大精深,而且凶險至極。練寶典功夫時,首先要自宮凈身。</info> 11 </skill> 12 <skill name="北冥神功"> 13 <info>逍遙派的頂級內功之一,能吸人內力轉化為自己所有,威力無窮。</info> 14 </skill> 15 </skills>
3 使用dom4j解析xml文件
3.1 構建dom4j樹
org.dom4j.io提供了兩個類:SAXReader和DOMReader,DOMReader只能一個現有的w3c DOM樹構建dom4j樹,即只能從一個org.w3c.dom.Document中構建org.dom4j.Document樹,而SAXReader則使用SAX解析器,從不同的輸入源構建dom4j樹,如可以從xml文件中讀取並構建dom4j樹。 實例代碼:使用SAXReader解析1 SAXReader reader = new SAXReader(); 2 Document document = reader.read(new File("d:/skills.xml"));
實例代碼:使用DOMReader解析
1 DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); 2 DocumentBuilder db = dbf.newDocumentBuilder(); 3 File file = new File("d:/skills.xml"); 4 org.w3c.dom.Document domDocument = db.parse(file); 5 DOMReader reader = new DOMReader(); 6 org.dom4j.Document document = reader.read(domDocument);
3.2 獲取節點
獲得dom4j樹之後,可以根據dom4j樹獲取節點。首先獲取根節點,然後根據根節點獲取其子節點。 實例代碼:訪問根節點1 Element root = document.getRootElement();
實例代碼:訪問所有子節點
List skills = root.elements(); for (Iterator<?> it = skills.iterator(); it.hasNext();) { Element e = (Element) it.next(); }
實例代碼:訪問指定名稱的節點,如訪問名稱為“skill”的全部節點
1 List skills = root.elements("skill"); 2 for (Iterator<?> it = skills.iterator(); it.hasNext();) { 3 Element e = (Element) it.next(); 4 //TODO 5 }
實例代碼:訪問指定名稱的第一個節點
1 Element skill = root.element("skill");
實例代碼:迭代某個元素的所有子元素,如迭代root
1 for(Iterator<Element> it = root.elementIterator();it.hasNext();){ 2 Element e = it.next(); 3 //TODO 4 }
3.3 獲取屬性
獲取節點後,可以根據節點獲取屬性,獲得方式與獲取節點類似。 實例代碼:獲取指定名稱的元素1 Element skill = root.element("skill"); 2 Attribute attr1 = skill.attribute("name");實例代碼:按照屬性順序獲取屬性
1 Element skill = root.element("skill"); 2 Attribute attr2 = skill.attribute(0);實例代碼:獲取某節點下全部屬性1
1 Element skill = root.element("skill"); 2 List<Attribute> list = skill.attributes(); 3 for (Iterator<Attribute> it = list.iterator(); it.hasNext();) { 4 Attribute attr = it.next(); 5 // TODO 6 }實例代碼:獲取某節點下全部屬性2
1 Element skill = root.element("skill"); 2 for (Iterator<Attribute> it = skill.attributeIterator(); it.hasNext();) { 3 Attribute attr = it.next(); 4 // TODO 5 }
3.4 使用XPath獲取節點和屬性
Dom4j 中集成了對XPath的支持。在選擇節點時,可以直接使用XPath 表達式。這種方式更加方便,簡潔,官方文檔中推薦使用該種方式。 實例代碼:要選擇所有的<skill>元素的name屬性1 List list = document.selectNodes("//skills/skill/@name"); 2 for (Iterator it = list.iterator(); it.hasNext();) { 3 Attribute attr = (Attribute) it.next(); 4 //TODO 5 }註意:為了能夠編譯執行上述使用XPath表達式的代碼,需要配置dom4j 安裝包中自帶的jaxen包,你也可以從http://sourceforge.net/products/jaxen/上下載jaxen。jaxen是 一個用java開發的XPath引擎,用於配合各種基於XML的對象模型,如DOM,dom4j和JDOM。在dom4-1.6.1 目錄下,有一個lib 子目錄,其中有個jaxen-1.1-beta-6.jar文件,需要在classpath環境變數中配置該文件的全路徑名。
4 使用dom4j修改xml文件
修改xml文件,需要先獲取dom4j樹(即Document),通常欲修改節點需要先獲得該節點或其父節點,欲修改屬性,需要先獲得該屬性所在的節點和該屬性。 增加操作:參照前文。 刪除操作: 實例代碼:刪除某節點1 Element root = document.getRootElement(); 2 Element skill = root.element("skill"); 3 root.remove(skill);實例代碼:刪除指定名稱的屬性
1 Element skill = root.element("skill"); 2 skill.remove(skill.attribute("name"));修改操作: 實例代碼:修改節點名稱和節點值
1 Element skill = root.element("skill"); 2 skill.setName("new_skill"); 3 skill.setText("你好");實例代碼:修改屬性值
1 Attribute attr = skill.attribute("name"); 2 attr.setText("newName");屬性名稱無法修改,欲修改屬性名稱,可以先刪除舊屬性,再增加新屬性
5 常用方法
5.1 Element元素API
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樹的根節點5.2 Attribute屬性API
getQName() 屬性的QName對象 getNamespace() 屬性所屬的Namespace對象 getNamespacePrefix() 屬性所屬的Namespace對象的prefix getNamespaceURI() 屬性所屬的Namespace對象的URI getName() 屬性的local name getQualifiedName() 屬性的qualified name getValue() 屬性的值5.3 字元串轉化
實例代碼:把節點,屬性,文檔等轉化成字元串,使用asXML()方法。1 String docXmlText = document.asXML(); 2 String rootXmlText = root.asXML();實例代碼:把字元串轉換為文檔,註意引號需要轉義
1 String skillString = "<skill name="xxx">神龍擺尾</skill>"; 2 Document d = DocumentHelper.parseText(skillString);
5.4 命名空間(Namespace)操作
dom4j的名稱空間信息api常用的方法有8個。 dom4j在Element和Attribute 介面中定義了獲取名稱空間信息的方法,這些方法和JDOM中的方法相同。如下所示: public java.lang.String getNamespacePrefix()該方法返回元素(屬性)的名稱空間首碼 public java.lang.String getNamespaceURI()該方法返回元素(屬性)的名稱空間 URIpublic java.lang.String getName()該方法返回元素(屬性)的本地名 public java.lang.String getQualifiedName()該方法返回元素(屬性)的限定名 public Namespace getNamespace()該方法返回元素本身的名稱空間 public java.util.List additionalNamespaces()返回某元素上附加的名稱空間聲明列表,列表中的每一個對象都是Namespace類型。 這個類的方法提供了兩個方法分別獲得名稱空間首碼和本地名。如下: public java.lang.String getPrefix()該方法返回名稱空間首碼。 public java.lang.String getURI()該方法返回名稱空間的URI。6 Qname介紹
Qname在使用dom4j的時候,經常見到,一般自己解析的xml很少使用這種複雜格式。 1. 來歷:qname是qualified name的簡寫 2. 構成:由名字空間(namespace)首碼(prefix)以及冒號(:),還有一個元素名稱構成 3. 舉例:1 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 2 xmlns="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" 3 version="1.0"> 4 <xsl:template match="foo"> 5 <hr/> 6 </xsl:template> 7 </xsl:stylesheet>xsl是名字空間首碼,template是元素名稱,xsl:template 就是一個qname。 4.總結:qname無非是有著特定格式的xml元素,其作用主要是增加了名字空間,比如有同樣的元素名稱,而名字空間不同的情況。