Dom4j应用中常用方法总结

一：构建 dom4j 树（表示为 Document 元素）

常用方法 :

方式一 ：直接创建所有元素： dom4j 为我们准备了工具类 DocumentHelper ，该类的所有的方法都是静态方法，用来创建 xml 文档的各个组成部分。

 

1.1.1 创建 Document 和 Element 对象：

Document doc=DocumentHelper.createDocument();

Element eltRoot=DocumentHelper.createElement(“student”);

doc.setEltRootElement(eltRoot);

 

1.1.2 或者先准备好根元素，使用有参数的构造方法创建 Document 对象。

Element eltRoot=DocumentHelper.createElement(“student”);

Document doc=DocumentHelper.createDocument(eltRoot);

 

1.2 ： 添加节点和设置节点内容：

方法： Branch 接口中定义的方法；

public Element addElemen(String  name)  // 以指定的name 为当前节点创建一个子节点,并返回新节点的引用

public void setText(String text)  // 将content设置为节点的内容

 

示例如下：

Element eltName=eltRoot.addElement(“name”);

Element eltAge=eltRoot.addElement(“age”);

eltName.setText(“ 张三”);

eltAge.setText(“18”);

 

1.3 ：添加属性

方法：public Element addAttribute(String name,String value)

 

示例如下：

eltRoot.addAttribute(“sn”,”01”);

 

方式2：

2.1 ： org.dom4j.io 提供了两个类： SAXReader 和DOMReader, 前者从一个现有的 w3c DOM 树构建 dom4j 树，而 SAXReader 则使用 SAX 解析器，从不同的输入源构建 dom4j 树。

 

2.1.1: 使用 SAXReade r 构建 dom4j 文档对象：示例如下：

 

SAXReader saxReader=new SAXRead er();

File file=new File(“student.xml”);

Document doc=saxReader.read(file);

 

2.2.1 : 使用 DOMReader 构建 dom4j 文档对象.

 

DocumentBuilderFactory dbf=new DocumentBuilderFactory.newInstance();

DocumentBuilder db=dbf.newDocumentBuilder();

File file=new File(“student.xml”);

org.w3c.dom.Document document=db.parse(file);

DOMReader domReader=new DOMReader();

org.dom4j.Document doc=domReader.read(document);

 

访问根节点：

Element root=doc.getRootElement();

访问节点：

访问所有节点:

java.util.List childrenList=elt.elements();

 

访问指定名称的所有节点

java.util.Liat childrenList=elt.elements(“student”);

 

访问指定名称第一个节点

Element eltChild=elt.element(“student”);

 

要迭代某个元素的所有子元素：

for(java.util.Iterator it=root.elementIterator();it.hasNext()){

Element element =it.hasNext();

……

}

 

Dom4j 中集成了对XPath的支持 。在选择节点时，可以直接使用 XPath 表达式，例如：

要选择例子文件 students.xml 中的所有的 <name> 元素，代码如下：

java.util.List l=root.selectNodes(“//name”);

 

要选择属性 sn 的值等于 01 的 <student> 元素，代码如下：

java.util.List l=root.selectNodes(“//student[@sn=’01’]”);

 

注意 : 为了能够编译执行上述使用 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 环境变量中配置该文件的全路径名。

 

访问属性：

  要得到某个元素的所有属性，，如下：

java.util.List attrList=elt.attributes();

  要得到指定的属性，如下：

Attribute attr=elt.attribute(“sn”);

要得到某个属性的值；如下：

String attrValue=elt.attributeValue(“sn”);

 

删除节点和节点的属性：

要删除某个元素 : ：可以用 Branch 接口中定义的 remove() 方法，如下：

Element eltStu=root.element(“student”);

root.remove(eltStu);

 

要删除某个属性；如下：

elt.remove(elt.attribute(“sn”));

 

输出文档：

对象：XMLWriter 实例方法：write（Document doc）

常用的几种构造方法总结：

1 ：无参数：

2: 字节流参数

3 ：字符流参数。

4 ：文档输出格式类参数。

示例代码1：

输出文档内容到控制台

XMLWriter xw=new XMLWriter();

xw.write(doc);

示例代码2:

输出文档内容到文件。构造 XMLWriter 对象的时候，可以传递字节流参数。其底层代码设置了自动刷新机制。

XMLWriter xw=new XMLWriter(new java.io.FileOutputStream(“student.xml”));

xw.write(doc);

 

示例代码3：

构造 XMLWriter 对象的时候，可以传递 java.io.Writer 对象。

XMLWriter xw=new XMLWriter(new java.io.FileWriter(“student.xml”));                                                                         

xw.write(doc);

xw.close();

注意：使用 java.io.Writer 对象构建的 XMLWriter 对象，则没有设置自动刷新机制，所以在调用 write() 方法之后，还要调用 xw.close() 或者xw.flush() 方法。并且 XMLWriter 继承自 org.xml.sax.helpers.XMLFilterImpl 类。它所提供的 close() 和flush() 方法只是其内部 java.io.Writer 对象的 flush() 和 close() 方法的封装方法。

 

  示例代码4 ：

构造 XMLWriter 对象的时候,可以传递文档输出格式类 org.dom4j.io.OutputFormat, 利用这个类，可以设置输出文档的字符编码，设置行分割符以及控制使用的缩进字符串等。

 

下面的代码输出格式使用 4 个空格作为缩进字符串，元素之间添加新行。

 

OutputFormat outFmt=new OutputFormat(“    ”,true);

XMLWriter xw=new XMLWriter(outFmt);

xw.write(doc);

 

下面的代码采用美化的格式输出文档，设置字符串编码为 GB2312 , 并且用 4 个空格作为缩进。

OutputFormat outFmt=OutputFormat.createPrettyPrint();

outFmt.setEncoding(“GB2312”);

outFmt.setIndent(“    ”);

XMLWriter xw=new XMLWriter(outFmt);

xw.write(doc);

 

dom4j 的名称空间 信息api

常用的方法有8个。

 

dom4j 在 Element 和 Attribute 接口中定义了获取名称空间信息的方法，这些方法和 JDOM 中的方法相同。如下所示：

public java.lang.String getNamespacePrefix()

该方法返回元素（属性）的名称空间前缀

public java.lang.String getNamespaceURI()

该方法返回元素（属性）的名称空间 URI

public 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 。