dom4j是一个Java的XML API,类似于jdom,用来读写XML文件的。dom4j是一个非常非常优秀的Java XML API,具有性能优异、功能强大和极端易用使用的特点,同时它也是一个开放源代码的软件,现在越来越多的Java软件都在使用dom4j来读写XML,特别值得一提的是连Sun的JAXM也在用dom4j。这是必须使用的jar包。
上面说dom4j这么优秀,那么好用,那么从今天开始就跟大家一起分享dom4j的一些用法。
dom4j的主要接口都在org.dom4j这个包里定义:
Attribute | Attribute定义了XML的属性 |
Branch | Branch为能够包含子节点的节点如XML元素(Element)和文档(Docuemnts)定义了一个公共的行为, |
CDATA | CDATA 定义了XML CDATA 区域 |
CharacterData | 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 | NodeFilter 定义了在dom4j节点中产生的一个滤镜或谓词的行为(predicate) |
ProcessingInstruction | ProcessingInstruction 定义 XML 处理指令. |
Text | Text 定义XML 文本节点. |
Visitor | Visitor 用于实现Visitor模式. |
XPath | XPath 在分析一个字符串后会提供一个XPath 表达式 |
要想弄懂这套接口,关键的是要明白接口的继承关系:
-
-
- interface org.dom4j.CharacterData
- interface org.dom4j.DocumentType
- interface org.dom4j.Entity
- interface org.dom4j.ProcessingInstruction
-
读写XML文档主要依赖于org.dom4j.io包,其中提供DOMReader和SAXReader两类不同方式,而调用方式是一样的。这就是依靠接口的好处。
// 从文件读取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文件头定义的编码来转换。如果遇到乱码问题,注意要把各处的编码名称保持一致即可。
下面这个例子是SAXReader类通过InputStream读取xml文件:
所要读取的xml文件:
<?xml version="1.0" encoding="UTF-8"?>
<config>
<db-info>
<driver-name>oracle.jdbc.driver.OracleDriver</driver-name>
<url>jdbc:oracle:thin:@localhost:1522:mydb</url>
<user-name>drp</user-name>
<password>drp</password>
</db-info>
</config>
读取xml文件的类:
package com.util;
import java.io.InputStream;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
/**
* 解析sys-config.xml文件
* @author Ronaldinho
*
*/
public class XmlConfigReader {
//懒汉式
private static XmlConfigReader instance = null;
//保存jdbc相关信息
private JdbcConfig jdbcConfig = new JdbcConfig();
private XmlConfigReader() {
//建立一个SAXReader对象
SAXReader reader=new SAXReader();
//通过当前线程的类加载器,获得文件的相对路径,读入缓冲输入流
InputStream in=Thread.currentThread().getContextClassLoader().getResourceAsStream("sys-config.xml");
try {
//通过流来读取xml文件
Document doc=reader.read(in);
//读取jdbc相关信息
Element driverNameElt=(Element) doc.selectObject("/config/db-info/driver-name");
Element urlElt=(Element) doc.selectObject("/config/db-info/url");
Element userNameElt=(Element) doc.selectObject("/config/db-info/user-name");
Element passwordElt=(Element) doc.selectObject("/config/db-info/password");
//设置jdbc相关信息
jdbcConfig.setDrivername(driverNameElt.getStringValue());
jdbcConfig.setUrl(urlElt.getStringValue());
jdbcConfig.setUsername(userNameElt.getStringValue());
jdbcConfig.setPassword(passwordElt.getStringValue());
} catch (DocumentException e) {
e.printStackTrace();
}
}
public static synchronized XmlConfigReader getInstance() {
if (instance==null) {
instance = new XmlConfigReader();
}
return instance;
}
}
上面这种方式是通过单例模式生成一个对象,这个对象实例化一个SAXReader,然后将xml文件加载到流当中。再通过SAXReader的read()方法将其转换成一个document对象。然后通过这个document对象取到xml文件的节点的值。
今天就先简单介绍一下利用dom4j读取xml文件,后面会陆续跟大家说说其他的用法。大家不要着急哦。
PS:欢迎各位批评指正!