dom4j与XML文档操作

Posted 2022-08-26 xfdhh

dom4简介

1、  DOM4J是 dom4j.org 出品的一个开源 XML 解析包。DOM4J应用于 Java 平台，采用了 Java 集合框架并完全支持 DOM，SAX 和 JAXP。

　　 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 表达式

2、这些接口之间的关系如下

　　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

XML文档

1、什么是XML？

　　可扩展标记语言，标准通用标记语言的子集，简称XML。是一种用于标记电子文件使其具有结构性的标记语言。

　　可扩展的意思是可以自定义标签，注意标签必须成对存在<school></school>

　　用来配置文件，存储数据，传输数据

2、XML结构　

　　<?xml version="1.0" encoding="UTF-8"?> 头信息 必须要存在
　　?xml：声明是一个xml文件
　　version：版本
　　encoding：编码格式

　　头信息下面是内容部分

3、xml书写规范
　　1.xml不区分大小写，但是XML大写敏感。
　　2.xml标签不能使用关键字，例如 XML version
　　3.正确嵌套
　　4.不能以数字开头
　　5.只能有一个根标签

4、读取XML文档

　　第一步：获取Document对象

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;  
  

　　第二步：获取根节点

Element root = document.getRootElement();  

　　第三步：遍历根节点下的节点

 for(Iterator it=root.elementIterator();it.hasNext();)      
      Element element = (Element) it.next();      
      // do something      
    

　　第四步：取节点的内容

String text = element.getText();

5、一些相关的方法

　　5.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");// 创建根节点     

　　5.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());          

　　5.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);     

　　5.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();

　　5.5、字符串与XML的转换      

　　　　1.将字符串转化为XML      

　　　　String text = "<members> <member>sitinspring</member> </members>";     

　　　　Document document = DocumentHelper.parseText(text);     

　　　　2.将文档或节点的XML转化为字符串.     

　　　　SAXReader 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();

Xpath

1、采用xpath查找需要引入jaxen-xx-xx.jar

2、常用的方法

  　　List list=document.selectNodes("/books/book/@show");

3、语法

　　1、选取节点

　　XPath 使用路径表达式在 XML 文档中选取节点，节点是沿着路径或者 step 来选取的。

　　常见的路径表达式：

表达式	描述
nodename	选取当前节点的所有子节点
/	从根节点选取
//	从匹配选择的当前节点选择文档中的节点，而不考虑它们的位置
.	选取当前节点
..	选取当前节点的父节点
@	选取属性

　　实例：

路径表达式	结果
bookstore	选取 bookstore 元素的所有子节点
/bookstore	选取根元素 bookstore
bookstore/book	选取bookstore 下名字为 book的所有子元素。
//book	选取所有 book 子元素，而不管它们在文档中的位置。
bookstore//book	选取bookstore 下名字为 book的所有后代元素，而不管它们位于 bookstore 之下的什么位置。
//@lang	选取所有名为 lang 的属性。

　　2、谓语

路径表达式	结果
/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、步的语法：轴名称::节点测试[谓语]

　　　　实例

例子	结果
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