Dom4j
1、DOM4J简介
DOM4J是 dom4j.org出品的一个开源 XML解析包。DOM4J应用于 Java平台，采用了 Java集合框架并完全支持 DOM，SAX和 JAXP。
DOM4J 使用起来非常简单。只要你了解基本的 XML-DOM模型，就能使用。
Dom：把整个文档作为一个对象。
DOM4J 最大的特色是使用大量的接口。它的主要接口都在org.dom4j里面定义：
|
Attribute |
定义了 XML的属性。 |
|
Branch |
指能够包含子节点的节点。如XML元素(Element)和文档(Docuemnts)定义了一个公共的行为 |
|
CDATA |
定义了 XML CDATA区域 |
|
CharacterData |
是一个标识接口，标识基于字符的节点。如CDATA，Comment, Text. |
|
Comment |
定义了 XML注释的行为 |
|
Document |
定义了XML文档 |
|
DocumentType |
定义 XML DOCTYPE声明 |
|
Element |
定义XML 元素 |
|
ElementHandler |
定义了Element对象的处理器 |
|
ElementPath |
被 ElementHandler使用，用于取得当前正在处理的路径层次信息 |
|
Entity |
定义 XML entity |
|
Node |
为dom4j中所有的XML节点定义了多态行为 |
|
NodeFilter |
定义了在dom4j节点中产生的一个滤镜或谓词的行为（predicate） |
|
ProcessingInstruction |
定义 XML处理指令 |
|
Text |
定义 XML文本节点 |
|
Visitor |
用于实现 Visitor模式 |
|
XPath |
在分析一个字符串后会提供一个 XPath表达式 |
接口之间的继承关系如下：
interfacejava.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
2、XML文档操作1
2.1、读取XML文档：
读写XML文档主要依赖于org.dom4j.io包，有DOMReader和SAXReader两种方式。因为利用了相同的接口，它们的调用方式是一样的。
public staticDocument load(String filename) {
Document document= null;
try {
SAXReadersaxReader = new SAXReader();
document =saxReader.read(new File(filename)); //读取XML文件,获得document对象
} catch (Exceptionex) {
ex.printStackTrace();
}
return document;
}
或
public staticDocument load(URL url) {
Document document= null;
try {
SAXReadersaxReader = new SAXReader();
document =saxReader.read(url); //读取XML文件,获得document对象
} catch (Exceptionex) {
ex.printStackTrace();
}
return document;
}
读取指定的xml文件之后返回一个Document对象，这个对象代表了整个XML文档，用于各种Dom运算。执照XML文件头所定义的编码来转换。
2.2、获取根节点
根节点是xml分析的开始，任何xml分析工作都需要从根开始
Xml xml = newXml(); Document dom =xml.load(path + "/" + file); Element root = dom.getRootElement();
2.3、.新增一个节点以及其下的子节点与数据
ElementmenuElement = root.addElement("menu");
ElementengNameElement = menuElement.addElement("engName");
engNameElement.setText(catNameEn);
ElementchiNameElement = menuElement.addElement("chiName");
chiNameElement.setText(catName);
2.4、写入XML文件
注意文件操作的包装类是乱码的根源
public staticboolean doc2XmlFile(Document document, String filename) {
boolean flag =true;
try {
XMLWriter writer =new XMLWriter( new OutputStreamWriter(newFileOutputStream(filename),"UTF-8"));
writer.write(document);
writer.close();
} catch (Exceptionex) {
flag = false;
ex.printStackTrace();
}
System.out.println(flag);
return flag;
}
Dom4j通过XMLWriter将Document对象表示的XML树写入指定的文件，并使用OutputFormat格式对象指定写入的风格和编码方法。调用OutputFormat.createPrettyPrint()方法可以获得一个默认的pretty print风格的格式对象。对OutputFormat对象调用setEncoding()方法可以指定XML文件的编码方法。
public voidwriteTo(OutputStream out, String encoding) throws UnsupportedEncodingException,IOException {
OutputFormatformat = OutputFormat.createPrettyPrint();
format.setEncoding("gb2312");
XMLWriterwriter = new XMLWriter(System.out,format);
writer.write(doc);
writer.flush();
return;
}
2.5 格式化输出和指定编码
默认的输出方式为紧凑方式，默认编码为UTF-8，但对于我们的应用而言，一般都要用到中文，并且希望显示时按自动缩进的方式的显示，这就需用到OutputFormat类。
/**
* 格式化XML文档,并解决中文问题
* @param filename
* @return
*/
public intformatXMLFile(String filename){
int returnValue = 0;
try{
SAXReader saxReader =new SAXReader();
Document document =saxReader.read(new File(filename));
XMLWriter writer =null;
/** 格式化输出,类型IE浏览一样 */
OutputFormat format =OutputFormat.createPrettyPrint();
/** 指定XML编码 */
format.setEncoding("GBK");
writer= newXMLWriter(new FileWriter(new File(filename)),format);
writer.write(document);
writer.close();
/** 执行成功,需返回1 */
returnValue = 1;
}catch(Exception ex){
ex.printStackTrace();
}
return returnValue;
}
说明：
OutputFormat format =OutputFormat.createPrettyPrint();
这句指定了格式化的方式为缩进式，则非紧凑式。
format.setEncoding("GBK");
指定编码为GBK。
XMLWriter writer = newXMLWriter(new FileWriter(new File(filename)),format);
这与前面两个方法相比，多加了一个OutputFormat对象，用于指定显示和编码方式。
2. 6、遍历xml节点
对Document对象调用getRootElement()方法可以返回代表根节点的Element对象。拥有了一个Element对象后，可以对该对象调用elementIterator()方法获得它的子节点的Element对象们的一个迭代器。使用(Element)iterator.next()方法遍历一个iterator并把每个取出的元素转化为Element类型。
public boolean isOnly(String catNameEn,HttpServletRequest request,String xml) {
boolean flag =true;
String path =request.getRealPath("");
Document doc =load(path+"/"+xml);
Element root =doc.getRootElement();
for (Iterator i =root.elementIterator(); i.hasNext();) {
Element el =(Element) i.next();
if(catNameEn.equals(el.elementTextTrim("engName"))){
flag = false;
break;
}
}
return flag;
}
2.7、创建xml文件
public static voidmain(String args[]){
StringfileName="c:/text.xml";
Documentdocument=DocumentHelper.createDocument();//建立document对象，用来操作xml文件
ElementbooksElement=document.addElement("books");//建立根节点
booksElement.addComment("Thisis a test for dom4j ");//加入一行注释
ElementbookElement=booksElement.addElement("book");//添加一个book节点
bookElement.addAttribute("show","yes");//添加属性内容
ElementtitleElement=bookElement.addElement("title");//添加文本节点
titleElement.setText("ajaxin action");//添加文本内容
try{
XMLWriter writer=new XMLWriter(new FileWriter(new File(fileName)));
writer.write(document);
writer.close();
}catch(Exceptione){
e.printStackTrace();
}
}
2.8、修改节点属性
publicstatic void modifyXMLFile() {
String oldStr ="c:/text.xml";
String newStr ="c:/text1.xml";
Document document= null;
//修改节点的属性
try {
SAXReadersaxReader = new SAXReader(); //用来读取xml文档
document =saxReader.read(new File(oldStr)); //读取xml文档
List list = document.selectNodes("/books/book/@show");//用xpath查找节点book的属性
Iterator iter = list.iterator();
while (iter.hasNext()) {
Attributeattribute = (Attribute) iter.next();
if (attribute.getValue().equals("yes"))
attribute.setValue("no");
}
} catch (Exceptione) {
e.printStackTrace();
}
//修改节点的内容
try {
SAXReadersaxReader = new SAXReader(); //用来读取xml文档
document =saxReader.read(new File(oldStr)); //读取xml文档
List list = document.selectNodes("/books/book/title");//用xpath查找节点book的内容
Iterator iter = list.iterator();
while (iter.hasNext()) {
Element element =(Element) iter.next();
element.setText("xxx");//设置相应的内容
}
} catch(Exception e) {
e.printStackTrace();
}
try {
XMLWriter writer =new XMLWriter(new FileWriter(new File(newStr)));
writer.write(document);
writer.close();
} catch(Exception ex) {
ex.printStackTrace();
}
}
2.9、删除节点
publicstatic void removeNode() {
String oldStr ="c:/text.xml";
String newStr ="c:/text1.xml";
Document document= null;
try {
SAXReadersaxReader = new SAXReader();//用来读取xml文档
document =saxReader.read(new File(oldStr));//读取xml文档
List list = document.selectNodes("/books/book");//用xpath查找对象
Iterator iter = list.iterator();
while (iter.hasNext()) {
ElementbookElement = (Element) iter.next();
// 创建迭代器，用来查找要删除的节点,迭代器相当于指针，指向book下所有的title节点
Iterator iterator = bookElement.elementIterator("title");
while (iterator.hasNext()) {
ElementtitleElement = (Element) iterator.next();
if (titleElement.getText().equals("ajax in action")) {
bookElement.remove(titleElement);
}
}
}
} catch(Exception e) {
e.printStackTrace();
}
try {
XMLWriter writer =new XMLWriter(new FileWriter(new File(newStr)));
writer.write(document);
writer.close();
} catch(Exception ex) {
ex.printStackTrace();
}
}
3、XML文档操作2
3.1、Document对象相关
1、读取XML文件,获得document对象.
SAXReader reader = new SAXReader();
Document document = reader.read(newFile("input.xml"));
2、解析XML形式的文本,得到document对象.
String text ="<members></members>";
Documentdocument = DocumentHelper.parseText(text);
3、主动创建document对象.
Document document = DocumentHelper.createDocument();
Elementroot = document.addElement("members");//创建根节点
3.2、节点相关
1、获取文档的根节点.
Element rootElm =document.getRootElement();
2、取得某节点的单个子节点.
ElementmemberElm=root.element("member");// "member"是节点名
3.取得节点的文字
Stringtext=memberElm.getText();
String text=root.elementText("name");这个是取得根节点下的name字节点的文字.
4.取得某节点下指定名称的所有节点并进行遍历.
List nodes =rootElm.elements("member");
for (Iterator it =nodes.iterator(); it.hasNext();) {
Elementelm = (Element) it.next();
//do something
}
5.对某节点下的所有子节点进行遍历.
for(Iteratorit=root.elementIterator();it.hasNext();){
Elementelement = (Element) it.next();
//do something
}
6.在某节点下添加子节点.
Element ageElm =newMemberElm.addElement("age");
7.设置节点文字.
ageElm.setText("29");
8.删除某节点.
parentElm.remove(childElm); // childElm是待删除的节点,parentElm是其父节点
9.添加一个CDATA节点.
Element contentElm = infoElm.addElement("content");
contentElm.addCDATA(diary.getContent());
3.3、属性相关.
1.取得节点的指定的属性
Element root=document.getRootElement();
Attributeattribute=root.attribute("size"); //属性名name
2.取得属性的文字
String text=attribute.getText();
Stringtext2=root.element("name").attributeValue("firstname");
//这个是取得根节点下name字节点的firstname属性的值.
3.遍历某节点的所有属性
Elementroot=document.getRootElement();
for(Iteratorit=root.attributeIterator();it.hasNext();){
Attribute attribute= (Attribute) it.next();
Stringtext=attribute.getText();
System.out.println(text);
}
4.设置某节点的属性和文字.
newMemberElm.addAttribute("name","sitinspring");
5.设置属性的文字
Attribute attribute=root.attribute("name");
attribute.setText("sitinspring");
6.删除某属性
Attribute attribute=root.attribute("size");//属性名name
root.remove(attribute);
3.4、将文档写入XML文件.
1.文档中全为英文,不设置编码,直接写入.
XMLWriter writer =new XMLWriter(newFileWriter("output.xml"));
writer.write(document);
writer.close();
2.文档中含有中文,设置编码格式再写入.
OutputFormatformat = OutputFormat.createPrettyPrint();
format.setEncoding("GBK"); //指定XML编码
XMLWriter writer =new XMLWriter(new FileWriter("output.xml"),format);
writer.write(document);
writer.close();
3.5、字符串与XML的转换
1.将字符串转化为XML
String text ="<members> <member>sitinspring</member></members>"; Document document= DocumentHelper.parseText(text);
2.将文档或节点的XML转化为字符串.
SAXReader reader =new SAXReader();
Document document= reader.read(new File("input.xml"));
Elementroot=document.getRootElement();
StringdocXmlText=document.asXML();
StringrootXmlText=root.asXML();
Element memberElm=root.element("member");
StringmemberXmlText=memberElm.asXML();
3、dom4j的事件处理模型涉及的类和接口：
3.1、类：SAXReader
public void addHandler(String path,ElementHandler handler)
当解析到path指定的路径时，将调用参数handler指定的处理器。针对不同的节点可以添加多个handler实例。或者调用默认的Handler setDefaultHandler(ElementHandler handler);
3.2、接口ElementHandler
public void onStart(ElementPath path)
该方法在解析到元素的开始标签时被调用。
public void onEnd(ElementPath path)
该方法在解析到元素的结束标签时被调用
3.3、接口：ElementPath（假设有参数：ElementPath path）
public void addHandler(String path,ElementHandler)
该方法与SAXReader类中的addHandler()方法的作用相同。路径path可以是绝对路径（路径以/开头），也可以是相对路径（假设是当前路径的子节点路径）。
public void removeHandler(String path)
移除指定路径上的ElementHandler实例。路径可以是相对路径，也可以是绝对路径。
public String getPath()
该方法得到当前节点的路径。该方法返回的是完整的绝对路径
public Element getCurrent()
该方法得到当前节点。
3.3、Element类
|
getQName() |
元素的QName对象 |
|
getNamespace() |
元素所属的Namespace对象 |
|
getNamespacePrefix() |
元素所属的Namespace对象的prefix |
|
getNamespaceURI() |
元素所属的Namespace对象的URI |
|
getName() |
元素的local name |
|
getQualifiedName() |
元素的qualified name |
|
getText() |
元素所含有的text内容，如果内容为空则返回一个空字符串而不是null |
|
getTextTrim() |
元素所含有的text内容，其中连续的空格被转化为单个空格，该方法不会返回null |
|
attributeIterator() |
元素属性的iterator，其中每个元素都是Attribute对象 |
|
attributeValue() |
元素的某个指定属性所含的值 |
|
elementIterator() |
元素的子元素的iterator，其中每个元素都是Element对象 |
|
element() |
元素的某个指定（qualified name或者local name）的子元素 |
|
elementText() |
元素的某个指定（qualified name或者local name）的子元素中的text信息 |
|
getParent |
元素的父元素 |
|
getPath() |
元素的XPath表达式，其中父元素的qualified name和子元素的qualified name之间使用"/"分隔 |
|
isTextOnly() |
是否该元素只含有text或是空元素 |
|
isRootElement() |
是否该元素是XML树的根节点 |
3.4、类DocumentHelper
DocumentHelper 是用来生成生成 XML 文档的工厂类
4、通过xpath查找指定的节点
采用xpath查找需要引入jaxen-xx-xx.jar，否则会报java.lang.NoClassDefFoundError:org/jaxen/JaxenException异常
List list=document.selectNodes(/books/book/@show);
5、例子
5.1、示例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>Dom4jTutorials</title> </book> <book show="yes"> <title>LuceneStuding</title> </book> <book show="no"> <title>Lucene inAction</title> </book> <owner>O'Reilly</owner> </books>
这是一个很简单的XML文档，场景是一个网上书店，有很多书，每本书有两个属性，一个是书名，一个为是否展示[show]，最后还有一项是这些书的拥有者[owner]信息。
5.2例子代码
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;
importorg.dom4j.io.XMLWriter;
publicclass Dom4jDemo {
publicint createXMLFile(String filename) {
/**返回操作结果, 0表失败, 1表成功 */
int returnValue = 0;
/**建立document对象 */
Document document = DocumentHelper.createDocument();
/**建立XML文档的根books */
Element booksElement = document.addElement("books");
/**加入一行注释 */
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("Dom4jTutorials");
/**类似的完成后两个book */
bookElement = booksElement.addElement("book");
bookElement.addAttribute("show","yes");
titleElement = bookElement.addElement("title");
titleElement.setText("LuceneStuding");
bookElement = booksElement.addElement("book");
bookElement.addAttribute("show","no");
titleElement = bookElement.addElement("title");
titleElement.setText("Lucenein Action");
/**加入owner节点 */
Element ownerElement = booksElement.addElement("owner");
ownerElement.setText("O'Reilly");
try {
/**将document中的内容写入文件中 */
XMLWriterwriter =new XMLWriter(new FileWriter(new File(filename)));
writer.write(document);
writer.close();
/**执行成功,需返回1 */
returnValue = 1;
} catch (Exception ex) {
ex.printStackTrace();
}
return returnValue;
}
publicint ReadXMLFile(String filename) {
int returnValue = 0;
try {
SAXReader saxReader =new SAXReader();
// 用来读取xml文件
Document document = saxReader.read(filename);//读取xml文件
// Stringxml= document.asXML();//把Docment转换为String
List list = document.selectNodes("/books/book/title");
Iterator iterator = list.iterator();
while (iterator.hasNext()) {
Element titleElement = (Element) iterator.next();
System.out.println(titleElement.getText());
}
} catch (Exception ex) {
ex.printStackTrace();
}
return returnValue;
}
publicint ModiXMLFile(String filename, String newfilename) {
int returnValue = 0;
try {
SAXReader saxReader =new SAXReader();
Document document = saxReader.read(new File(filename));
/**修改内容之一: 如果book节点中show属性的内容为yes,则修改成no */
/**先用xpath查找对象 */
List list =document.selectNodes("/books/book/@show");
Iterator iter = list.iterator();
while (iter.hasNext()) {
Attribute attribute = (Attribute) iter.next();
if (attribute.getValue().equals("yes")) {
attribute.setValue("no");
}
}
/**
* 修改内容之二: 把owner项内容改为Tshinghua
* 并在owner节点中加入date节点,date节点的内容为2004-09-11,还为date节点添加一个属性type
*/
list = document.selectNodes("/books/owner");
iter = list.iterator();
if (iter.hasNext()) {
Element ownerElement = (Element) iter.next();
ownerElement.setText("Tshinghua");
Element dateElement = ownerElement.addElement("date");
dateElement.setText("2004-09-11");
dateElement.addAttribute("type","Gregorian calendar");
}
/**修改内容之三: 若title内容为Dom4j Tutorials,则删除该节点 */
list = document.selectNodes("/books/book");
iter = list.iterator();
while (iter.hasNext()) {
Element bookElement = (Element) iter.next();
Iterator iterator = bookElement.elementIterator("title");
while (iterator.hasNext()) {
ElementtitleElement = (Element) iterator.next();
if (titleElement.getText().equals("Dom4j Tutorials")) {
bookElement.remove(titleElement);
}
}
}
try {
/**将document中的内容写入文件中 */
XMLWriterwriter =new XMLWriter(new FileWriter(new File(
newfilename)));
writer.write(document);
writer.close();
/**执行成功,需返回1 */
returnValue = 1;
} catch (Exception ex) {
ex.printStackTrace();
}
} catch (Exception ex) {
ex.printStackTrace();
}
return returnValue;
}
/**
* 格式化XML文档,并解决中文问题
*
* @param filename
* @return
*/
publicint formatXMLFile(String filename) {
int returnValue = 0;
try {
SAXReader saxReader =new SAXReader();
Document document = saxReader.read(new File(filename));
XMLWriterwriter =null;
/**格式化输出,类型IE浏览一样 */
OutputFormat format = OutputFormat.createPrettyPrint();
/**指定XML编码 */
format.setEncoding("GBK");
writer = newXMLWriter(new FileWriter(new File(filename)),format);
writer.write(document);
writer.close();
/**执行成功,需返回1 */
returnValue = 1;
} catch (Exception ex) {
ex.printStackTrace();
}
return returnValue;
}
publicstaticvoid main(String[] args) {
Dom4jDemo dom4jDemo = new Dom4jDemo();
dom4jDemo.createXMLFile("D:/holen1.xml");
System.out.println("createok");
dom4jDemo.formatXMLFile("D:/holen1.xml");
System.out.println("formatok");
dom4jDemo.ModiXMLFile("D:/holen1.xml","D:/holen2.xml");
System.out.println("modiyok");
dom4jDemo.ReadXMLFile("D:/holen1.xml");
System.out.println("readok");
}
}
