dom4j 最常用最简单的用法

要使用dom4j读写XML文档,需要先下载dom4j包,dom4j官方网站在 http://www.dom4j.org/
目前最新dom4j包下载地址:http://nchc.dl.sourceforge.net/sourceforge/dom4j/dom4j-1.6.1.zip

解开后有两个包,仅操作XML文档的话把dom4j-1.6.1.jar加入工程就可以了,如果需要使用XPath的话还需要加入包jaxen-1.1-beta-7.jar.

以下是相关操作:

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

二.节点相关

1.获取文档的根节点.
Element rootElm = document.getRootElement();
2.取得某节点的单个子节点.
Element memberElm=root.element("member");// "member"是节点名
3.取得节点的文字
String text=memberElm.getText();
也可以用:
String text=root.elementText("name");这个是取得根节点下的name字节点的文字.

4.取得某节点下名为"member"的所有字节点并进行遍历.
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是其父节点

三.属性相关.

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

四.将文档写入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();

五.字符串与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快速找到节点.

读取的XML文档示例

 

[html] view plain copy
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <projectDescription>  
  3.   <name>MemberManagement</name>  
  4.   <comment></comment>  
  5.   <projects>  
  6.     <project>PRJ1</project>  
  7.     <project>PRJ2</project>  
  8.     <project>PRJ3</project>  
  9.     <project>PRJ4</project>  
  10.   </projects>  
  11.   <buildSpec>  
  12.     <buildCommand>  
  13.       <name>org.eclipse.jdt.core.javabuilder</name>  
  14.       <arguments>  
  15.       </arguments>  
  16.     </buildCommand>  
  17.   </buildSpec>  
  18.   <natures>  
  19.     <nature>org.eclipse.jdt.core.javanature</nature>  
  20.   </natures>  
  21. </projectDescription>  


使用XPath快速找到节点project.

 

[java] view plain copy
  1. public static void main(String[] args){  
  2.     SAXReader reader = new SAXReader();  
  3.       
  4.     try{  
  5.       Document  doc = reader.read(new File("sample.xml"));  
  6.         
  7.       List projects=doc.selectNodes("/projectDescription/projects/project");  
  8.         
  9.       Iterator it=projects.iterator();  
  10.         
  11.       while(it.hasNext()){  
  12.         Element elm=(Element)it.next();         
  13.         System.out.println(elm.getText());  
  14.       }  
  15.         
  16.     }  
  17.     catch(Exception ex){  
  18.        ex.printStackTrace();  
  19.     }  


附带例子

 

[java] view plain copy
  1. package dom4j;  
  2.   
  3. import java.io.FileOutputStream;  
  4. import java.io.FileWriter;  
  5.   
  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. /** 
  13.  * dom4j框架学习 使用dom4j框架创建xml文档并输出保存 
  14.  *  
  15.  */  
  16. public class Dom4JTest1 {  
  17.   
  18.     public static void main(String[] args) throws Exception {  
  19.         // 第一种方式：创建文档，并创建根元素  
  20.         // 创建文档:使用了一个Helper类  
  21.         Document document = DocumentHelper.createDocument();  
  22.   
  23.         // 创建根节点并添加进文档  
  24.         Element root = DocumentHelper.createElement("student");  
  25.         document.setRootElement(root);  
  26.   
  27.         // 第二种方式:创建文档并设置文档的根元素节点  
  28.         Element root2 = DocumentHelper.createElement("student");  
  29.         Document document2 = DocumentHelper.createDocument(root2);  
  30.   
  31.         // 添加属性  
  32.         root2.addAttribute("name", "zhangsan");  
  33.         // 添加子节点:add之后就返回这个元素  
  34.         Element helloElement = root2.addElement("hello");  
  35.         Element worldElement = root2.addElement("world");  
  36.   
  37.         helloElement.setText("hello Text");  
  38.         worldElement.setText("world text");  
  39.   
  40.         // 输出  
  41.         // 输出到控制台  
  42.         XMLWriter xmlWriter = new XMLWriter();  
  43.         xmlWriter.write(document);  
  44.   
  45.         // 输出到文件  
  46.         // 格式  
  47.         OutputFormat format = new OutputFormat("    ", true);// 设置缩进为4个空格，并且另起一行为true  
  48.         XMLWriter xmlWriter2 = new XMLWriter(  
  49.                 new FileOutputStream("student.xml"), format);  
  50.         xmlWriter2.write(document2);  
  51.   
  52.         // 另一种输出方式，记得要调用flush()方法,否则输出的文件中显示空白  
  53.         XMLWriter xmlWriter3 = new XMLWriter(new FileWriter("student2.xml"),  
  54.                 format);  
  55.         xmlWriter3.write(document2);  
  56.         xmlWriter3.flush();  
  57.         // close()方法也可以  
  58.   
  59.     }  
  60. }  


[java] view plain copy
    1. package dom4j;  
    2.   
    3. import java.io.File;  
    4. import java.io.UnsupportedEncodingException;  
    5. import java.net.URL;  
    6. import java.util.Iterator;  
    7. import java.util.List;  
    8.   
    9. import javax.xml.parsers.DocumentBuilder;  
    10. import javax.xml.parsers.DocumentBuilderFactory;  
    11.   
    12. import org.dom4j.Document;  
    13. import org.dom4j.Element;  
    14. import org.dom4j.io.DOMReader;  
    15. import org.dom4j.io.SAXReader;  
    16.   
    17. /** 
    18.  * dom4j框架学习： 读取并解析xml 
    19.  *  
    20.  *  
    21.  */  
    22. public class Dom4JTest2 {  
    23.     public static void main(String[] args) throws Exception {  
    24.         SAXReader saxReader = new SAXReader();  
    25.         String inputfile = fileToPath("students.xml");  
    26.         Document document = saxReader.read(new File(fileToPath(inputfile)));  
    27.   
    28. //      document.getRootElement().asXML();//去掉头部  
    29.         // 获取根元素  
    30.         Element root = document.getRootElement();  
    31.         System.out.println("Root: " + root.getName());  
    32.   
    33.         // 获取所有子元素  
    34.         List<Element> childList = root.elements();  
    35.         System.out.println("total child count: " + childList.size());  
    36.   
    37.         // 获取特定名称的子元素  
    38.         List<Element> childList2 = root.elements("hello");  
    39.         System.out.println("hello child: " + childList2.size());  
    40.   
    41.         // 获取名字为指定名称的第一个子元素  
    42.         Element firstWorldElement = root.element("world");  
    43.         // 输出其属性  
    44.         System.out.println("first World Attr: "  
    45.                 + firstWorldElement.attribute(0).getName() + "="  
    46.                 + firstWorldElement.attributeValue("name"));  
    47.   
    48.         System.out.println("迭代输出-----------------------");  
    49.         // 迭代输出  
    50.         for (Iterator iter = root.elementIterator(); iter.hasNext();) {  
    51.             Element e = (Element) iter.next();  
    52.             System.out.println(e.attributeValue("name"));  
    53.   
    54.         }  
    55.   
    56.         System.out.println("用DOMReader-----------------------");  
    57.         DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();  
    58.         DocumentBuilder db = dbf.newDocumentBuilder();  
    59.         // 注意要用完整类名  
    60.         org.w3c.dom.Document document2 = db.parse(new File("students.xml "));  
    61.   
    62.         DOMReader domReader = new DOMReader();  
    63.   
    64.         // 将JAXP的Document转换为dom4j的Document  
    65.         Document document3 = domReader.read(document2);  
    66.   
    67.         Element rootElement = document3.getRootElement();  
    68.   
    69.         System.out.println("Root: " + rootElement.getName());  
    70.   
    71.     }  
    72.   
    73.     public static String fileToPath(String filename) throws UnsupportedEncodingException{  
    74.         URL url = Dom4JTest2.class.getResource(filename);  
    75.         return java.net.URLDecoder.decode(url.getPath(),"UTF-8");  
    76.     }  
    77. } 
posted @ 2017-11-20 15:16  辰~风  阅读(232)  评论(0)  编辑  收藏  举报