dom4j使用基本指南 （转载）

dom4j是一个简单的、灵活的开放源代码的库，支持XML、XPath和XSLT。与JDOM一样，dom4j也应用于Java平台。dom4j API使用了Java集合框架并完全支持DOM、SAX和JAXP。

dom4j是由早期开发JDOM的人分离出来而后独立开发的。与JDOM不同的是，dom4j使用接口和抽象基类，虽然dom4j的API相对要复杂一些，但它提供了比JDOM更好的灵活性。

dom4j是一个非常非常优秀的Java XML API，具有性能优异、功能强大和极端易用使用的特点，同时它也是一个开放源代码的软件。

dom4j API介绍

dom4j-1.6.1 API共有14个包，其中org.dom4j包中包括了表示XML文档组成部分的接口，org.dom4j.io包中包括了构建dom4j文档树的类，以及输出dom4j文档树的类。

(1)创建XML文档
在org.dom包中提供了一个DocumentHelper类，该类中多有的方法都是静态方法，其中就包括了创建XML文档各个组成部分的方法。

Document doc=DocumentHelper.createDocument();
Element eltRoot=DocumentHelper.createElement("student");
doc.setRootElement(eltRoot);

也可以先创建跟元素对象，然后在创建文档对象的同时制定根元素，如下：

Element eltRoot=DocumentHelper.createElement("student");
Document doc=DocumentHelper.createDocument(eltRoot);

(2)添加属性
在dom4j中，添加属性与JDOM一样简单，如下：

eltRoot.addAttribute("sn","01");

(3)增加子元素以及设置元素内容
在Branch接口中，定义了addElement()方法，如下：

public Element addElement(String name)

该方法用指定的name为当前节点添加一个子元素节点，并返回新节点的引用。我们使用这个方法，为根元素添加子元素，如下：

Element eltName=eltRoot.addElement("name");
Element eltAge=eltRoot.addElement("age");
eltName.setText("awang");
eltAge.setText("22");

(4)输出文档
dom4j提供了XML文档的多种输出形式。在org.dom4j.io包中，DOMWriter类可以将dom4j树输出为W3C DOM的Document对象，SAXWriter类可以将dom4j树作为SAX事件流输出，而XMLWriter类则提供了将dom4j树的各个部分以XML流的方式输出的能力。
例如，下面的代码将创建的XML文档输出到屏幕上：

XMLWriter xmlWriter=new XMLWriter();
xmlWriter.write(doc);

你也可以选择输出到文件中，如下：

XMLWriter xmlWriter=new XMLWriter(new java.io.FileWriter("student.xml"));
xmlWriter.write(doc);
xmlWriter.close();

dom4j还提供了控制文档输出格式的类org.dom4j.io.OutputFormat。利用这个类可以设置输出文档的字符编码、设置行分隔符、缩进字符串等。
下面的代码设置输出格式使用4个空格作为缩进字符串，元素之间添加新行。

OutputFormat outFmt=new OutputFormat("    ",true);
XMLWriter xmlWriter=new XMLWriter(outFmt);
xmlWriter.write(doc);

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

OutputFormat outFmt=OutputFormat.createPrettyPrint();
outFmt.setEncoding("GB2312");
outFmt.setIndent("    ");
XMLWriter xmlWriter=new XMLWriter(outFmt);
xmlWriter.write(doc);

(5)构建dom4j树
dom4j在org.dom4j.io包中，提供了两个类：DOMReader和SAXReader，DOMReader从一个现有的W3C DOM树构建dom4j树，而SAXReader则使用SAX解析器，从不同的输入源来构建dom4j树。
以SAXReader类来构建dom4j来构建dom4j文档对象的代码如下：

SAXReader saxReader=new SAXReader();
File file=new File("student.xml");
Document doc=saxReader.read(file);

(6)访问根元素
在Document类中，给出了getRootElement()方法，用于返回文档的根元素。如下：

Element root=doc.RootElement();

(7)访问节点
要得到某个元素的所有子元素，如下：

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

要得到某个元素的具有给定名称的所有子元素，如下：

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

要得到某个元素的具有给定名称的第一个字元素，如下：

Element eltChild=elt.element("student");

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

for(java.util.Iterator it=root.elementIterator();it.hasNext();)
{
    Element element=(Element)it.next();
}

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

Element eltStu=root.element("student");
root.remove(eltStu);

(8)访问属性
要得到某个元素的所有属性，如下：

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

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

Attribute attr=elt.attribute("sn");

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

String attrValue=elt.attributeValue("sn");

要删除某个属性，如下： elt.remove(elt.attribute("sn"));

评论

2 楼 Marcushe 2011-03-17  

只有不使用setrootelement，或者把addProcessingInstruction放在之后，才能是xml中正确添加 xml-stylesheet的内容

1 楼 Marcushe 2011-03-17  

Dom4j,用了SetRootElement就导致addprocessingInstruction失效？？？
朋友，用了你的第一种方式document.setrootelement就会有问题！！

public class XmlGen {
    public Document generateDocumentByMethod() {
       Document document = DocumentHelper.createDocument();
        Element root=DocumentHelper.createElement("student");

       // ProcessingInstruction
       Map<String, String> inMap = new HashMap<String, String>();
       inMap.put("type", "text/xsl");
       inMap.put("href", "students.xsl");
       document.addProcessingInstruction("xml-stylesheet", inMap);
      
      doc.setRootElement(eltRoot);  //这是出问题的地方
     
 
       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());
       }
    }