用Dom4j解析XML及中文问题

作者：陈光（holen@263.net）
时间：2004-09-11

本文主要讨论了用dom4j解析XML的基础问题，包括建立XML文档，添加、修改、删除节点，以及格式化（美化）输出和中文问题。可作为dom4j的入门资料。

下载与安装

dom4j是sourceforge.net上的一个开源项目，主要用于对XML的解析。从2001年7月发布第一版以来，已陆续推出多个版本，目前最高版本为1.5。
dom4j专门针对Java开发，使用起来非常简单、直观，在Java界，dom4j正迅速普及。

可以到http://sourceforge.net/projects/dom4j下载其最新版。

dom4j1.5的完整版大约13M，是一个名为dom4j-1.5.zip的压缩包，解压后有一个dom4j-1.5.jar文件，这就是应用时需要引入的类包，另外还有一个jaxen-1.1-beta-4.jar文件，一般也需要引入，否则执行时可能抛java.lang.NoClassDefFoundError:
org/jaxen/JaxenException异常，其他的包可以选择用之。

示例XML文档（holen.xml）

为了述说方便，先看一个XML文档，之后的操作均以此文档为基础。

holen.xml

<?xml version="1.0" encoding="UTF-8"?> <books> <!--This is a test for dom4j, holen, 2004.9.11--> <book show="yes"> <title>Dom4j Tutorials</title> </book> <book show="yes"> <title>Lucene Studing</title> </book> <book show="no"> <title>Lucene in Action</title> </book> <owner>O'Reilly</owner> </books>

这是一个很简单的XML文档，场景是一个网上书店，有很多书，每本书有两个属性，一个是书名[title]，一个为是否展示[show]，最后还有一项是这些书的拥有者[owner]信息。

建立一个XML文档

/**
*XML文档
需建立的文件名
*@return,0表失败

返回操作结果
,1表成功*/

int returnValue
= 0;
/**document对象*/

Document document
= DocumentHelper.createDocument();
/**XML文档的根

加入一行注释*/

booksElement.addComment("This is a test for dom4j, holen, 2004.9.11");
/**book节点*/

Element bookElement
= booksElement.addElement("book");
/**show属性内容*/

bookElement.addAttribute("show","yes");
/**title节点*/

Element titleElement
= bookElement.addElement("title");
/**title设置内容*/

titleElement.setText("Dom4j Tutorials");

/**book*/

bookElement = booksElement.addElement("book");

bookElement.addAttribute("show","yes");

titleElement =
bookElement.addElement("title");

titleElement.setText("Lucene Studing");

bookElement = booksElement.addElement("book");

bookElement.addAttribute("show","no");

titleElement =
bookElement.addElement("title");

titleElement.setText("Lucene in Action");

/**owner节点*/

Element ownerElement
= booksElement.addElement("owner");

ownerElement.setText("O'Reilly");

try{
/**document中的内容写入文件中*/

XMLWriter writer
= new
XMLWriter(new
FileWriter(new
File(filename)));

writer.write(document);

writer.close();
/**,需返回
Element有几个重要的方法：
addAttribute：添加属性
XMLWriter生成物理文件，默认生成的XML文件排版格式比较乱，可以通过OutputFormat类的createCompactFormat()方法或createPrettyPrint()方法格式化输出，默认采用createCompactFormat()方法，显示比较紧凑，这点将在后面详细谈到。

生成后的holen.xml文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<books><!--This is a test for dom4j, holen, 2004.9.11--><book show="yes"><title>Dom4j Tutorials</title></book><book show="yes"><title>Lucene Studing</title></book><book show="no"><title>Lucene in Action</title></book><owner>O'Reilly</owner></books>

修改XML文档

有三项修改任务，依次为：
如果book节点中show属性的内容为yes,则修改成no
把owner项内容改为Tshinghua，并添加date节点
若title内容为Dom4j Tutorials,则删除该节点

/**
*XML文件中内容
重点掌握,修改节点
修改对象文件
*@paramnewfilename
返回操作结果
,1表成功
*/

public int
ModiXMLFile(String filename,String
newfilename){

int returnValue
= 0;

try{

SAXReader saxReader
= new
SAXReader();

Document document
= saxReader.read(new
File(filename));
/**:book节点中yes,则修改成

先用

修改内容之二
把Tshinghua
*owner节点中加入,date节点的内容为--date节点添加一个属性
修改内容之三
若Dom4jTutorials,则删除该节点*/

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

iter = list.iterator();

while(iter.hasNext()){

Element bookElement
= (Element)iter.next();

Iterator iterator
= bookElement.elementIterator("title");

while(iterator.hasNext()){

Element titleElement=(Element)iterator.next();

if(titleElement.getText().equals("Dom4j Tutorials")){

bookElement.remove(titleElement);

}

}

}

try{
/**document中的内容写入文件中*/

XMLWriter writer
= new
XMLWriter(new
FileWriter(new
File(newfilename)));

writer.write(document);

writer.close();
/**,需返回
" p="" style="MARGIN: 0in; FONT-SIZE: 10pt" font="" face="宋体" font="" font="" face="">xpath查找到相应内容。

通过setText()修改节点内容。

通过
格式化,并解决中文问题
*
@param
filename
*
@return
*/

public int
formatXMLFile(String filename){

int returnValue
= 0;

try{

SAXReader saxReader
= new
SAXReader();

Document document
= saxReader.read(new
File(filename));

XMLWriter writer =
null;
/**,类型

指定
" font="" style="FONT-WEIGHT: bold" color="#7f0055" new="" font="" font="" color="black" xmlwriter="" font="" font="" style="FONT-WEIGHT: bold" color="#7f0055" new=""
font="" font="" color="black" filewriter="" font="" font="" style="FONT-WEIGHT: bold" color="#7f0055" new="" font="" font="" color="black" file="" filename="" format="" font="" p="" p="" style="MARGIN: 0in; FONT-FAMILY: 'Courier New'; FONT-SIZE: 10pt" nbsp=""
nbsp="" nbsp="" nbsp="" nbsp="" nbsp="" nbsp="" nbsp="" nbsp="" nbsp="" font="" color="black" writer="" write="" document="" font="" p="" p="" style="MARGIN: 0in; FONT-FAMILY: 'Courier New'; FONT-SIZE: 10pt" nbsp="" nbsp="" nbsp="" nbsp="" nbsp="" nbsp=""
nbsp="" nbsp="" nbsp="" nbsp="" font="" color="black" writer="" close="" font="" nbsp="" nbsp="" nbsp="" nbsp="" nbsp="" p="" p="" style="MARGIN: 0in; FONT-SIZE: 10pt" font="" face="">
执行成功1*/

returnValue = 1;

}catch(Exception
ex){

ex.printStackTrace();

}

return returnValue;

}

说明：

OutputFormat
format =
OutputFormat.createPrettyPrint();
这句指定了格式化的方式为缩进式，则非紧凑式。

format.setEncoding("GBK");
指定编码为GBK。

XMLWriter writer = new XMLWriter(new FileWriter(new File(filename)),format);
这与前面两个方法相比，多加了一个<FONT face=""">OutputFormat对象，用于指定显示和编码方式。

完整的类代码

前面提出的方法都是零散的，下面给出完整类代码。

Dom4jDemo.java

package com.holen.dom4j; import java.io.File; import java.io.FileWriter; import java.util.Iterator; import java.util.List; import org.dom4j.Attribute; import org.dom4j.Document; import org.dom4j.DocumentHelper; import org.dom4j.Element; import org.dom4j.io.OutputFormat; import org.dom4j.io.SAXReader; import org.dom4j.io.XMLWriter; /** * @author Holen Chen */ public class Dom4jDemo { public Dom4jDemo() { } public int createXMLFile(String filename){…} public int ModiXMLFile(String filename,String newfilename){…} public int formatXMLFile(String filename){…} public static void main(String[] args) { Dom4jDemo temp = new Dom4jDemo(); System.out.println(temp.createXMLFile("d://holen.xml")); System.out.println(temp.ModiXMLFile("d://holen.xml","d://holen2.xml")); System.out.println(temp.formatXMLFile("d://holen2.xml")); } }

说明：
main()方法中依次调用三个方法，第一个方法用于生成holen.xml，第二个方法用于修改holen.xml，并且修改后的内容另存为holen2.xml，第三个方法将holen2.xml格式化缩进式输出，并指定编码方式为GBK。