热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

DOM4J介绍与代码示例

DOM4J是dom4j.org出品的一个开源XML解析包。Dom4j是一个易用的、开源的库,用于XML,XPath和XSLT。它应用于Java平台,采用了Java集合框架并完全支持
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注释的行为;

项目结构

技术分享

maven代码

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0modelVersion>

  <groupId>lqygroupId>
  <artifactId>Dom4jTestartifactId>
  <version>0.0.1-SNAPSHOTversion>
  <packaging>jarpackaging>

  <name>Dom4jTestname>
  <url>http://maven.apache.orgurl>

  <properties>
    <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
  properties>

  <dependencies>
    <dependency>
      <groupId>junitgroupId>
      <artifactId>junitartifactId>
      <version>3.8.1version>
      <scope>testscope>
    dependency>
    <dependency>
        <groupId>dom4jgroupId>
        <artifactId>dom4jartifactId>
        <version>1.6.1version>
    dependency>
    <dependency>
        <groupId>jaxengroupId>
        <artifactId>jaxenartifactId>
        <version>1.1.4version>
    dependency>
  dependencies>
project>

1.创建XML文档

package lqy.Dom4jTest;

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.OutputFormat;
import org.dom4j.io.XMLWriter;
 


/*
 * 创建XML文档
 */
public class XmlGen {
    
    /*
     * 方法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");
     */
    public Document generateDocumentByMethod() {
        
       Document document = DocumentHelper.createDocument();
       // ProcessingInstruction
       Map inMap = new HashMap();
       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;
    }
 
    
    /*
     * 方法generateDocumentByString()通过字符串转换直接构建xml文档,使用DocumentHelper.parseText()来实现.
     * document = DocumentHelper.parseText(text);
     */
    public Document generateDocumentByString() {
       String text = "" +
              "" +
              "   " +
              "sam18" +
              "lin20";
       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("students-gen.xml"));
    }
}

生成students-gen.xml如下

xml version="1.0" encoding="UTF-8"?>
xml-stylesheet type="text/xsl" href="students.xsl"?>

<students>
  
  <student sn="01">
    <name>samname>
    <age>18age>
  student>
  <student sn="02">
    <name>linname>
    <age>20age>
  student>
students>
方法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)将文档输出到文件保存,可指定字符编码,可指定格式化输出。

2.修改XML文档

package lqy.Dom4jTest;
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.Node;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;
 
/*
 * 这里使用xpath来定位待修改的元素和属性,需要jaxen的支持。
 *示例中将students-gen.xml的第一个student元素的sn属性改为001,其子元素name内容改为jeff。
 *XmlMod.java
 */
public class XmlMod {
    
    /*
     * 1.使用File定位文件资源,并基于此获得Document实例
     *SAXReader saxReader = new SAXReader();
     *Document document = saxReader.read(inputXml);
     *2.Document实例的selectNodes方法可以传入xpath,并返回一个List实例,基于此使用迭代器,完成特定的应用
     *List list = document.selectNodes("//students/student/@sn");
     */
    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());
       }
    }
 
    /*
     * selectSingleNode如果有多个只取第一个
     */
    public void modifyDocument2(File inputXml){
        SAXReader saxReader = new SAXReader();
        try {
            Document document = saxReader.read(inputXml);
            Node nodeAttr=document.selectSingleNode("//students/student/@sn");
            System.out.println(nodeAttr.getText());
            nodeAttr.setText("nodeAttr");
            
            Node nodeEle=document.selectSingleNode("//students/student");
            System.out.println(nodeEle.getText());
            nodeEle.setText("nodeEle");    
            
               XMLWriter output = new XMLWriter(new FileWriter(new File(
                       "students-modified2.xml")));
                output.write(document);            
                output.close();        
        } catch (Exception e) {
            e.printStackTrace();
        }
        
        
    }
    
    
    
    
    public static void main(String[] argv) {
       XmlMod dom4jParser = new XmlMod();
       //dom4jParser.modifyDocument(new File("students-gen.xml"));
       dom4jParser. modifyDocument2(new File("students-gen.xml"));
    }
}

生成students-modified.xml

xml version="1.0" encoding="UTF-8"?>
xml-stylesheet type="text/xsl" href="students.xsl"?><students>
    
  <student sn="001">
    <name>jeffname>
    <age>18age>
  student>
  <student sn="02">
    <name>linname>
    <age>20age>
  student>
students>

生成students-modified2.xml

xml version="1.0" encoding="UTF-8"?>
xml-stylesheet type="text/xsl" href="students.xsl"?><students>
    
  <student sn="nodeAttr"><name>samname><age>18age>nodeElestudent>
  <student sn="02">
    <name>linname>
    <age>20age>
  student>
students>
1.使用File定位文件资源,并基于此获得Document实例
SAXReader saxReader = new SAXReader();
Document document = saxReader.read(inputXml);
2.Document实例的selectNodes方法可以传入xpath,并返回一个List实例,基于此使用迭代器,完成特定的应用
List list = document.selectNodes("//students/student/@sn");

3.遍历XML文档

这里提供两种遍历方法,一种是基于迭代的遍历,一种是基于Visitor模式的遍历。这里介绍迭代的
package lqy.Dom4jTest;

import java.io.File;
import java.util.Iterator;

import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;

/*
 * 方法traversalDocumentByIterator()提供一种基于迭代的遍历实现,每个Element通过elementIterator()和attributeIterator()取代其子元素和属性的迭代器。
 */
public class XmlIterator {

    private File inputXml;
    
    public XmlIterator(File inputXml) {
       this.inputXml = inputXml;
    }

    public static void main(String[] argv) {
        XmlIterator dom4jParser = new XmlIterator(new File("students-gen.xml"));
        dom4jParser.traversalDocumentByIterator();
     }
    
    
    
    public Element getRootElement() {
        return getDocument().getRootElement();
     }
    
    public Document getDocument() {
        SAXReader saxReader = new SAXReader();
        Document document = null;
        try {
            document = saxReader.read(inputXml);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return document;
     }
    
    /*
     * 该方法只是枚举了两层,如果一直挖的话要用递归方法
     */
    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());
            }
        }
     }
    
    
    
    
}

输出

技术分享

4.通过Element找到节点

package lqy.Dom4jTest;

import java.io.File;
import java.util.Iterator;
import java.util.List;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.io.SAXReader;

public class XmlReadByElement {

    /**
     * @param args
     * @throws Exception 
     */
    public static void main(String[] args) throws Exception {

        XmlReadByElement.getOneEle();
        XmlReadByElement.getEles();
        XmlReadByElement.getAttrs();
        XmlReadByElement.getOneAttr();
    }
    
    
    public static Document getDocument() throws Exception{
        SAXReader reader = new SAXReader();
        Document  document = reader.read(new File("students-read.xml"));
        return document;
    }
    
    //要顺序一个一个往下找
    public static void getOneEle() throws Exception{
        Document  document=getDocument();
        Element rootElm = document.getRootElement();
        Element e=rootElm.element("lqy");
        System.out.println("arrt:"+e.attributeValue("aa"));
        Element e2=e.element("login");
        System.out.println("text:"+e2.getText());
        
        
    }
    
    public static void getEles() throws Exception{
        Document  document=getDocument();
        Element rootElm = document.getRootElement();
        List eList=rootElm.elements("student");
        Iterator it=eList.iterator();
        while(it.hasNext()){
            Element elm=(Element)it.next();
            System.out.println("arrt:"+elm.attributeValue("sn"));
        }

    }
    
    
    public static void getOneAttr() throws Exception{
        Document  document=getDocument();
        Node node1=document.selectSingleNode("//students/lqy/login");
        Element elm=(Element)node1;
        System.out.println("attr:"+elm.attributeValue("sn"));
        
    }
    
    public static void getAttrs() throws Exception{
        Document  document=getDocument();
        List list = document.selectNodes("//students/student");
        Iterator it=list.iterator();
        while(it.hasNext()){
            Element elm=(Element)it.next();
            System.out.println("attr:"+elm.attributeValue("sn"));
        }

    }
   

}

students-read.xml

xml version="1.0" encoding="UTF-8"?>
xml-stylesheet type="text/xsl" href="students.xsl"?>

<students>
  
  <student sn="01">
    <name>samname>
    <age>18age>
  student>
  <student sn="02">
    <name>linname>
    <age>20age>
  student>
    <lqy aa="123123123">
    <login sn="03">luologin>
    <pass>123456pass>
  lqy>
students>

输出结果

技术分享

5.通过XPath找到节点

package lqy.Dom4jTest;

import java.io.File;
import java.util.Iterator;
import java.util.List;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.io.SAXReader;

public class XmlReadByXPath {

    /**
     * @param args
     * @throws Exception 
     */
    public static void main(String[] args) throws Exception {

        XmlReadByXPath.getOneEleByXPath();
        XmlReadByXPath.getElesByXPath();
        XmlReadByXPath.getAttrsByXPath();
        XmlReadByXPath.getOneAttrByXPath();
    }
    
    
    public static Document getDocument() throws Exception{
        SAXReader reader = new SAXReader();
        Document  document = reader.read(new File("students-read.xml"));
        return document;
    }
    
    public static void getOneEleByXPath() throws Exception{
        Document  document=getDocument();
        Node node1=document.selectSingleNode("//students/lqy/login");
        String nodeText1=node1.getText();
        System.out.println("nodeText1:"+nodeText1);
        
        //假如多个只返回第一个
        Node node2=document.selectSingleNode("//students/student/name");
        String nodeText2=node2.getText();
        System.out.println("nodeText2:"+nodeText2);
        
        Node node3=document.selectSingleNode("//students/student/@sn");
        short nodeText3=node1.ATTRIBUTE_NODE;
        System.out.println("nodeText3:"+nodeText3);
        
    }
    
    public static void getElesByXPath() throws Exception{
        Document  document=getDocument();
        List list = document.selectNodes("//students/student/name");
        Iterator it=list.iterator();
        while(it.hasNext()){
            Element elm=(Element)it.next();
             System.out.println("elm:"+elm.getText());
        }

    }
    
    
    public static void getOneAttrByXPath() throws Exception{
        Document  document=getDocument();
        Node node1=document.selectSingleNode("//students/lqy/login");
        Element elm=(Element)node1;
        System.out.println("attr:"+elm.attributeValue("sn"));
        
    }
    
    public static void getAttrsByXPath() throws Exception{
        Document  document=getDocument();
        List list = document.selectNodes("//students/student");
        Iterator it=list.iterator();
        while(it.hasNext()){
            Element elm=(Element)it.next();
            System.out.println("attr:"+elm.attributeValue("sn"));
        }

    }
    
    

}

输出结果

技术分享

6.XML转换成String

package lqy.Dom4jTest;

import java.io.File;
import java.util.Iterator;
import java.util.List;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.io.SAXReader;

public class XMLToString {

    /**
     * @param args
     * @throws Exception 
     */
    public static void main(String[] args) throws Exception {
        SAXReader reader = new SAXReader();
        Document  document = reader.read(new File("students-read.xml"));        
        String docXmlText=document.asXML();
        System.out.println(docXmlText);
        System.out.println("------------------docXmlText-------------------");
        Element root=document.getRootElement();   
        String rootXmlText=root.asXML();
        System.out.println(rootXmlText);
        System.out.println("------------------rootXmlText-------------------");
        Element memberElm=root.element("lqy");
        String memberXmlText=memberElm.asXML();
        System.out.println(memberXmlText);
        System.out.println("------------------memberXmlText-------------------");

    }
        

}

 输出

 技术分享

参考

1.http://zhangjunhd.blog.51cto.com/113473/126310

2.http://www.blogjava.net/junglesong/archive/2008/02/21/181196.html

DOM4J介绍与代码示例


推荐阅读
  • 本文介绍了在SpringBoot中集成thymeleaf前端模版的配置步骤,包括在application.properties配置文件中添加thymeleaf的配置信息,引入thymeleaf的jar包,以及创建PageController并添加index方法。 ... [详细]
  • 本文详细介绍了Linux中进程控制块PCBtask_struct结构体的结构和作用,包括进程状态、进程号、待处理信号、进程地址空间、调度标志、锁深度、基本时间片、调度策略以及内存管理信息等方面的内容。阅读本文可以更加深入地了解Linux进程管理的原理和机制。 ... [详细]
  • Java验证码——kaptcha的使用配置及样式
    本文介绍了如何使用kaptcha库来实现Java验证码的配置和样式设置,包括pom.xml的依赖配置和web.xml中servlet的配置。 ... [详细]
  • 本文介绍了OC学习笔记中的@property和@synthesize,包括属性的定义和合成的使用方法。通过示例代码详细讲解了@property和@synthesize的作用和用法。 ... [详细]
  • 在说Hibernate映射前,我们先来了解下对象关系映射ORM。ORM的实现思想就是将关系数据库中表的数据映射成对象,以对象的形式展现。这样开发人员就可以把对数据库的操作转化为对 ... [详细]
  • 知识图谱——机器大脑中的知识库
    本文介绍了知识图谱在机器大脑中的应用,以及搜索引擎在知识图谱方面的发展。以谷歌知识图谱为例,说明了知识图谱的智能化特点。通过搜索引擎用户可以获取更加智能化的答案,如搜索关键词"Marie Curie",会得到居里夫人的详细信息以及与之相关的历史人物。知识图谱的出现引起了搜索引擎行业的变革,不仅美国的微软必应,中国的百度、搜狗等搜索引擎公司也纷纷推出了自己的知识图谱。 ... [详细]
  • 本文讲述了作者通过点火测试男友的性格和承受能力,以考验婚姻问题。作者故意不安慰男友并再次点火,观察他的反应。这个行为是善意的玩人,旨在了解男友的性格和避免婚姻问题。 ... [详细]
  • 1,关于死锁的理解死锁,我们可以简单的理解为是两个线程同时使用同一资源,两个线程又得不到相应的资源而造成永无相互等待的情况。 2,模拟死锁背景介绍:我们创建一个朋友 ... [详细]
  • 后台获取视图对应的字符串
    1.帮助类后台获取视图对应的字符串publicclassViewHelper{将View输出为字符串(注:不会执行对应的ac ... [详细]
  • 《数据结构》学习笔记3——串匹配算法性能评估
    本文主要讨论串匹配算法的性能评估,包括模式匹配、字符种类数量、算法复杂度等内容。通过借助C++中的头文件和库,可以实现对串的匹配操作。其中蛮力算法的复杂度为O(m*n),通过随机取出长度为m的子串作为模式P,在文本T中进行匹配,统计平均复杂度。对于成功和失败的匹配分别进行测试,分析其平均复杂度。详情请参考相关学习资源。 ... [详细]
  • 本文介绍了通过ABAP开发往外网发邮件的需求,并提供了配置和代码整理的资料。其中包括了配置SAP邮件服务器的步骤和ABAP写发送邮件代码的过程。通过RZ10配置参数和icm/server_port_1的设定,可以实现向Sap User和外部邮件发送邮件的功能。希望对需要的开发人员有帮助。摘要长度:184字。 ... [详细]
  • 动态规划算法的基本步骤及最长递增子序列问题详解
    本文详细介绍了动态规划算法的基本步骤,包括划分阶段、选择状态、决策和状态转移方程,并以最长递增子序列问题为例进行了详细解析。动态规划算法的有效性依赖于问题本身所具有的最优子结构性质和子问题重叠性质。通过将子问题的解保存在一个表中,在以后尽可能多地利用这些子问题的解,从而提高算法的效率。 ... [详细]
  • 本文介绍了关于apache、phpmyadmin、mysql、php、emacs、path等知识点,以及如何搭建php环境。文章提供了详细的安装步骤和所需软件列表,希望能帮助读者解决与LAMP相关的技术问题。 ... [详细]
  • 高质量SQL书写的30条建议
    本文提供了30条关于优化SQL的建议,包括避免使用select *,使用具体字段,以及使用limit 1等。这些建议是基于实际开发经验总结出来的,旨在帮助读者优化SQL查询。 ... [详细]
  • 本文介绍了指针的概念以及在函数调用时使用指针作为参数的情况。指针存放的是变量的地址,通过指针可以修改指针所指的变量的值。然而,如果想要修改指针的指向,就需要使用指针的引用。文章还通过一个简单的示例代码解释了指针的引用的使用方法,并思考了在修改指针的指向后,取指针的输出结果。 ... [详细]
author-avatar
平凡屋之换
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有