首页 > 代码库 > DRP——Dom4j使用

DRP——Dom4j使用

   dom4j是一个Java的XMLAPI,类似于jdom,用来读写XML文件的。dom4j是一个非常非常优秀的JavaXMLAPI,具有性能优异、功能强大和极端易用使用的特点。Dom4j是一个易用的、开源的库,用于XML,XPath和XSLT。它应用于Java平台,采用了Java集合框架并完全支持DOM,SAX和JAXP。

Dom4j的主要接口:


 

Node为所有的dom4j中XML节点定义了多态行为;

Branch为能够包含子节点的节点如XML元素(Element)和文档(Docuemnts)定义了一个公共的行为;

Element定义XML 元素;

Document定义了XML文档;

 

DocumentType定义XML DOCTYPE声明;

Entity定义XML entity;

Attribute定义了XML的属性;

ProcessingInstruction定义 XML 处理指令;

 

CharacterData是一个标识借口,标识基于字符的节点。如CDATA,Comment,Text;

CDATA定义了XML CDATA 区域;

Text定义XML 文本节点;

Comment定义了XML注释的行为;

 

使用Dom4j

 

1.解析XML文档

          读写XML文档主要依赖于org.dom4j.io包,其中提供DOMReaderSAXReader两类不同方式,而调用方式是一样的。这就是依靠接口的好处。

// 从文件读取XML,输入文件名,返回XML文档
public Document read(String fileName) throws MalformedURLException, DocumentException {
SAXReader reader = new SAXReader();
Document document = reader.read(new File(fileName));
return document;
}

   其中,readerread方法是重载的,可以从InputStream,File, Url等多种不同的源来读取。得到的Document对象就代表了整个XML

           

2.取得Root节点

   读取后的第二步,就是得到Root节点。熟悉XML的人都知道,一切XML分析都是从Root元素开始的。

public Element getRootElement(Document doc){
return doc.getRootElement();
}

3.遍历XML

 

  DOM4J提供至少3种遍历节点的方法:

      1)枚举(Iterator)

// 枚举所有子节点
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)递归

   递归也可以采用Iterator作为枚举手段,但文档中提供了另外的做法

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模式

    最令人兴奋的是DOM4JVisitor的支持,这样可以大大缩减代码量,并且清楚易懂。了解设计模式的人都知道,VisitorGOF设计模式之一。其主要原理就是两种类互相保有对方的引用,并且一种作为Visitor去访问许多Visitable。我们来看DOM4J中的Visitor模式

只需要自定一个类实现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())

         Visitor接口提供多种Visit()的重载,根据XML不同的对象,将采用不同的方式来访问。上面是给出的ElementAttribute的简单实现,一般比较常用的就是这两个。VisitorSupportDOM4J提供的默认适配器,Visitor接口的Default Adapter模式,这个模式给出了各种visit(*)的空实现,以便简化代码。

     注意,这个Visitor是自动遍历所有子节点的。如果是root.accept(MyVisitor),将遍历子节点。


4.文件输出

   一个简单的输出方法是将一个Document或任何的Node通过write方法输出

FileWriter out = new FileWriter( foo.xml );
document.write(out);

    如果你想改变输出的格式,比如美化输出或缩减格式,可以用XMLWriter

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 );
}

5.XPath支持

     DOM4JXPath有良好的支持,如访问一个节点,可直接用XPath选择。


public void bar(Document document) {
List list = document.selectNodes( //foo/bar );
Node node = document.selectSingleNode(//foo/bar/author);
String name = node.valueOf( @name );
}

例如,如果你想查找XHTML文档中所有的超链接,下面的代码可以实现:


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();
}
}

简单使用:

private XmlConfigReader(){
		SAXReader  reader =new SAXReader();
		//常用的装载方式,需要注意
	    InputStream ins=Thread.currentThread().getContextClassLoader().getResourceAsStream("sys-config.xml");
		try {
		       //Document中存入了配置文件
		   Document doc=	reader.read(ins);
		   //通过节点名称读取节点中的内容
		   Element driverNameElt= (Element)doc.selectObject("/config/db-info/dirver-name");
	       Element urllist=(Element)doc.selectObject("/config/db-info/url"); 
	       Element namelist=(Element)doc.selectObject("/config/db-info/username");
	       Element passwordlist=(Element)doc.selectObject("/config/db-info/password");
	       List daoFactorylist=doc.selectNodes("/config/dao-factory/*");
	    } catch (DocumentException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
	}

     一句话:Dom4j是一种工具,我们善用工具,工具会提供我们很大的便利。