DOM4J是dom4j.org出品的一个开源XML解析包,它的网站中这样定义:
Dom4j是一个易用的、开源的库,用于XML,XPath和XSLT。它应用于Java平台,采用了Java集合框架并完全支持DOM,SAX和JAXP。
在国内比较流行的是使用JDOM作为解析器,两者各擅其长,但DOM4J最大的特色是使用大量的接口,这也是它被认为比JDOM灵活的主要原因。大师不是说过么,“面向接口编程”。目前使用DOM4J的已经越来越多。如果你善于使用JDOM,不妨继续用下去,只看看本篇文章作为了解与比较,如果你正要采用一种解析器,不如就用DOM4J吧。
它的主要接口都在org.dom4j这个包里定义:
Attribute
|
Attribute定义了XML的属性
|
Branch
|
Branch为能够包含子节点的节点如XML元素(Element)和文档(Docuemnts)定义了一个公共的行为,
|
CDATA
|
CDATA 定义了XML CDATA 区域
|
CharacterData是一个标识接口,标识基于字符的节点。如CDATA,Comment, Text.
| |
Comment
|
Comment 定义了XML注释的行为
|
Document
|
定义了XML文档
|
DocumentType
|
DocumentType 定义XML DOCTYPE声明
| |
Element
|
Element定义XML 元素
|
ElementHandler
|
ElementHandler定义了 Element 对象的处理器
|
ElementPath
|
被
ElementHandler 使用,用于取得当前正在处理的路径层次信息
|
Entity
|
Entity定义 XML entity
|
Node
|
Node为所有的dom4j中XML节点定义了多态行为
|
NodeFilter 定义了在dom4j节点中产生的一个滤镜或谓词的行为(predicate)
| |
ProcessingInstruction
|
ProcessingInstruction 定义 XML 处理指令.
|
Text
|
Text 定义XML 文本节点.
|
Visitor
|
Visitor 用于实现Visitor模式.
|
XPath
|
XPath 在分析一个字符串后会提供一个XPath 表达式
|
看名字大致就知道它们的涵义如何了。
- interface java.lang.Cloneable
- interface org.dom4j.Node
- interface org.dom4j.Attribute
- interface org.dom4j.Branch
- interface org.dom4j.Document
- interface org.dom4j.Element
- interface org.dom4j.CharacterData
- interface org.dom4j.CDATA
- interface org.dom4j.Comment
- interface org.dom4j.Text
- interface org.dom4j.DocumentType
- interface org.dom4j.Entity
- interface org.dom4j.ProcessingInstruction
// 从文件读取XML,输入文件名,返回XML文档
public Document read(String fileName)
throws MalformedURLException, DocumentException {
SAXReader reader =
new SAXReader();
Document document = reader.read(
new File(fileName));
return document;
}
|
其中,reader的read方法是重载的,可以从InputStream, File, Url等多种不同的源来读取。得到的Document对象就带表了整个XML。根据本人自己的经验,读取的字符编码是按照XML文件头定义的编码来转换。如果遇到乱码问题,注意要把各处的编码名称保持一致即可。
public Element getRootElement(Document doc){
return doc.getRootElement();
}
|
3. 遍历XML树
// 枚举所有子节点
for ( Iterator i = root.elementIterator(); i.hasNext(); ) {
Element element = (Element) i.next();
// do something
}
// 枚举名称为foo的节点
for ( Iterator i = root.elementIterator(foo); i.hasNext();) {
Element foo = (Element) i.next();
// do something
}
// 枚举属性
for ( Iterator i = root.attributeIterator(); i.hasNext(); ) {
Attribute attribute = (Attribute) i.next();
// do something
}
|
2)递归
public void treeWalk() {
treeWalk(getRootElement());
}
public void treeWalk(Element element) {
for (
int i = 0, size = element.nodeCount(); i < size; i++) {
Node node = element.node(i);
if (node
instanceof Element) {
treeWalk((Element) node);
}
else { // do something....
}
}
}
|
3) Visitor模式
public class MyVisitor
extends VisitorSupport {
public void visit(Element element){
System.out.println(element.getName());
}
public void visit(Attribute attr){
System.out.println(attr.getName());
}
}
调用: root.accept(new MyVisitor())
|
public void bar(Document document) {
List list = document.selectNodes( //foo/bar );
Node node = document.selectSingleNode(//foo/bar/author);
String name = node.valueOf( @name );
}
|
public void findLinks(Document document)
throws DocumentException {
List list = document.selectNodes( //a/@href );
for (Iterator iter = list.iterator(); iter.hasNext(); ) {
Attribute attribute = (Attribute) iter.next();
String url = attribute.getValue();
}
}
|
5. 字符串与XML的转换
// XML转字符串
Document document = ...;
String text = document.asXML();
// 字符串转XML
String text = <person> <name>James</name> </person>;
Document document = DocumentHelper.parseText(text);
|
6 用XSLT转换XML
public Document styleDocument(
Document document,
String stylesheet
)
throws Exception {
// load the transformer using JAXP
TransformerFactory factory = TransformerFactory.newInstance();
Transformer transformer = factory.newTransformer(
new StreamSource( stylesheet )
);
// now lets style the given document
DocumentSource source =
new DocumentSource( document );
DocumentResult result =
new DocumentResult();
transformer.transform( source, result );
// return the transformed document
Document transformedDoc = result.getDocument();
return transformedDoc;
}
|
7. 创建XML
public Document createDocument() {
Document document = DocumentHelper.createDocument();
Element root = document.addElement(root);
Element author1 =
root
.addElement(author)
.addAttribute(name, James)
.addAttribute(location, UK)
.addText(James Strachan);
Element author2 =
root
.addElement(author)
.addAttribute(name, Bob)
.addAttribute(location, US)
.addText(Bob McWhirter);
return document;
}
|
8. 文件输出
FileWriter out =
new FileWriter( foo.xml );
document.write(out);
|
public void write(Document document)
throws IOException {
// 指定文件
XMLWriter writer =
new XMLWriter(
new FileWriter( output.xml )
);
writer.write( document );
writer.close();
// 美化格式
OutputFormat format = OutputFormat.createPrettyPrint();
writer =
new XMLWriter( System.out, format );
writer.write( document );
// 缩减格式
format = OutputFormat.createCompactFormat();
writer =
new XMLWriter( System.out, format );
writer.write( document );
}
|
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"));