Dom4j
使用简介
作者:冰云
icecloud(AT)sina.com
时间:
2003.12.15
版权声明:
本文由冰云完成,首发于
CSDN
,未经许可,不得使用于任何商业用途。
文中代码部分引用自
DOM4J
文档。
欢迎转载,但请保持文章及版权声明完整。
如需联络请发邮件:
icecloud(AT)sina.com
|
DOM4J
是
dom4j.org
出品的一个开源
XML
解析包,它的网站中这样定义:
Dom4j
is an easy to use, open source library for working with XML, XPath and XSLT on the Java platform using the Java Collections Framework and with full support for DOM, SAX and JAXP.
Dom4j
是一个易用的、开源的库,用于
XML
,
XPath
和
XSLT
。它应用于
Java
平台,采用了
Java
集合框架并完全支持
DOM
,
SAX
和
JAXP
。
DOM4J
使用起来非常简单。只要你了解基本的
XML-DOM
模型,就能使用。然而他自己带的指南只有短短一页(
html
),不过说的到挺全。国内的中文资料很少。因而俺写这个短小的教程方便大家使用,这篇文章仅谈及基本的用法,如需深入的使用,请
……
自己摸索或查找别的资料。
之前看过
IBM developer
社区的文章(参见附录),提到一些
XML
解析包的性能比较,其中
DOM4J
的性能非常出色,在多项测试中名列前茅。(事实上
DOM4J
的官方文档中也引用了这个比较)所以这次的项目中我采用了
DOM4J
作为
XML
解析工具。
在国内比较流行的是使用
JDOM
作为解析器,两者各擅其长,但
DOM4J
最大的特色是使用大量的接口,这也是它被认为比
JDOM
灵活的主要原因。大师不是说过么,
“
面向接口编程
”
。目前使用
DOM4J
的已经越来越多。如果你善于使用
JDOM
,不妨继续用下去,只看看本篇文章作为了解与比较,如果你正要采用一种解析器,不如就用
DOM4J
吧。
它的主要接口都在
org.dom4j
这个包里定义:
看名字大致就知道它们的涵义如何了。
要想弄懂这套接口,关键的是要明白接口的继承关系:
一目了然,很多事情都清楚了。大部分都是由
Node
继承来的。知道这些关系,将来写程序就不会出现
ClassCastException
了。
下面给出一些例子(部分摘自
DOM4J
自带的文档),简单说一下如何使用。
1.
读取并解析
XML
文档:
读写
XML
文档主要依赖于
org.dom4j.io
包,其中提供
DOMReader
和
SAXReader
两类不同方式,而调用方式是一样的。这就是依靠接口的好处。
//
从文件读取
XML
,输入文件名,返回
XML
文档
publicDocumentread(StringfileName)throwsMalformedURLException,DocumentException{
SAXReaderreader=newSAXReader();
Documentdocument=reader.read(newFile(fileName));
returndocument;
}
|
其中,
reader
的
read
方法是重载的,可以从
InputStream, File, Url
等多种不同的源来读取。得到的
Document
对象就带表了整个
XML
。
根据本人自己的经验,读取的字符编码是按照
XML
文件头定义的编码来转换。如果遇到乱码问题,注意要把各处的编码名称保持一致即可。
2.
取得
Root
节点
读取后的第二步,就是得到
Root
节点。熟悉
XML
的人都知道,一切
XML
分析都是从
Root
元素开始的。
public
Element
getRootElement(Document
doc){
returndoc.getRootElement();
}
|
3.
遍历
XML
树
DOM4J
提供至少
3
种遍历节点的方法:
1)
枚举
(Iterator)
//
枚举所有子节点
for
(
Iterator
i
=
root.elementIterator();
i.hasNext();
)
{
Elementelement=(Element)i.next();
// do something
}
//
枚举名称为
foo
的节点
for
(
Iterator
i
=
root.elementIterator(
foo
);
i.hasNext();)
{
Elementfoo=(Element)i.next();
// do something
}
//
枚举属性
for
(
Iterator
i
=
root.attributeIterator();
i.hasNext();
)
{
Attributeattribute=(Attribute)i.next();
// do something
}
|
2)
递归
递归也可以采用
Iterator
作为枚举手段,但文档中提供了另外的做法
publicvoidtreeWalk(){
treeWalk(getRootElement());
}
publicvoidtreeWalk(Elementelement){
for(inti=0,size=element.nodeCount();i<size;i++) {
Nodenode=element.node(i);
if(nodeinstanceofElement){
treeWalk((Element)node);
}else{// do something....
}
}
}
|
3) Visitor
模式
最令人兴奋的是
DOM4J
对
Visitor
的支持,这样可以大大缩减代码量,并且清楚易懂。了解设计模式的人都知道,
Visitor
是
GOF
设计模式之一。其主要原理就是两种类互相保有对方的引用,并且一种作为
Visitor
去访问许多
Visitable
。我们来看
DOM4J
中的
Visitor
模式
(
快速文档中没有提供
)
只需要自定一个类实现
Visitor
接口即可。
publicclassMyVisitorextendsVisitorSupport{
publicvoidvisit(Elementelement){
System.out.println(element.getName());
}
public
void
visit(Attribute
attr){
System.out.println(attr.getName());
}
}
调用:
root.accept(new MyVisitor())
|
Visitor
接口提供多种
Visit()
的重载,根据
XML
不同的对象,将采用不同的方式来访问。上面是给出的
Element
和
Attribute
的简单实现,一般比较常用的就是这两个。
VisitorSupport
是
DOM4J
提供的默认适配器,
Visitor
接口的
Default Adapter
模式,这个模式给出了各种
visit(*)
的空实现,以便简化代码。
注意,这个
Visitor
是自动遍历所有子节点的。如果是
root.accept(MyVisitor)
,将遍历子节点。我第一次用的时候,认为是需要自己遍历,便在递归中调用
Visitor
,结果可想而知。
4. XPath
支持
DOM4J
对
XPath
有良好的支持,如访问一个节点,可直接用
XPath
选择。
publicvoidbar(Documentdocument){
Listlist=document.selectNodes(//foo/bar);
Nodenode=document.selectSingleNode(//foo/bar/author);
Stringname=node.valueOf(@name);
}
|
例如,如果你想查找
XHTML
文档中所有的超链接,下面的代码可以实现:
publicvoidfindLinks(Documentdocument)throwsDocumentException{
Listlist=document.selectNodes(//a/@href);
for(Iteratoriter=list.iterator();iter.hasNext();){
Attributeattribute=(Attribute)iter.next();
Stringurl=attribute.getValue();
}
}
|
5.
字符串与
XML
的转换
有时候经常要用到字符串转换为
XML
或反之,
// XML
转字符串
Document
document
=
...;
Stringtext=document.asXML();
//
字符串转
XML
Stringtext=<person> <name>James</name> </person>;
Documentdocument=DocumentHelper.parseText(text);
|
6
用
XSLT
转换
XML
publicDocumentstyleDocument(
Documentdocument,
Stringstylesheet
)throwsException{
// load the transformer using JAXP
TransformerFactoryfactory=TransformerFactory.newInstance();
Transformertransformer=factory.newTransformer(
newStreamSource(stylesheet)
);
// now lets style the given document
DocumentSourcesource=newDocumentSource(document);
DocumentResultresult=newDocumentResult();
transformer.transform(source,result);
// return the transformed document
DocumenttransformedDoc=result.getDocument();
returntransformedDoc;
}
|
7.
创建
XML
一般创建
XML
是写文件前的工作,这就像
StringBuffer
一样容易。
publicDocumentcreateDocument(){
Documentdocument=DocumentHelper.createDocument();
Elementroot=document.addElement(root);
Elementauthor1=
root
.addElement(author)
.addAttribute(name,James)
.addAttribute(location,UK)
.addText(James Strachan);
Elementauthor2=
root
.addElement(author)
.addAttribute(name,Bob)
.addAttribute(location,US)
.addText(Bob McWhirter);
returndocument;
}
|
8.
文件输出
一个简单的输出方法是将一个
Document
或任何的
Node
通过
write
方法输出
FileWriter
out
=
new
FileWriter(
foo.xml
);
document.write(out);
|
如果你想改变输出的格式,比如美化输出或缩减格式,可以用
XMLWriter
类
publicvoidwrite(Documentdocument)throwsIOException{
//
指定文件
XMLWriterwriter=newXMLWriter(
newFileWriter(output.xml)
);
writer.write(document);
writer.close();
//
美化格式
OutputFormatformat=OutputFormat.createPrettyPrint();
writer=newXMLWriter(System.out,format);
writer.write(document);
//
缩减格式
format=OutputFormat.createCompactFormat();
writer=newXMLWriter(System.out,format);
writer.write(document);
}
|
如何,
DOM4J
够简单吧,当然,还有一些复杂的应用没有提到,如
ElementHandler
等。如果你动心了,那就一起来用
DOM4J.
DOM4J
官方网站:
(
我老连不上
)
http://www.dom4j.org
DOM4J
下载
(SourceForge)
,最新版本为
1.4
http://sourceforge.net/projects/dom4j
参考资料:
DOM4J
文档
Java
中的
XML
:
文档模型,第一部分:性能
http://www-900.ibm.com/developerWorks/cn/xml/x-injava/index.shtml
Java
中的
XML
:
Java
文档模型的用法
http://www-900.ibm.com/developerWorks/cn/xml/x-injava2/index.shtml
Java XML API
漫谈
by robbin
http://www.hibernate.org.cn:8000/137.html