Dom4j 使用 详解~~
DOM4J是dom4j.org出品的一个开源XML解析包。Dom4j是一个易用的、开源的库，用于XML，XPath和XSLT。它应用于Java平台，采用了Java集合框架并完全支持DOM，SAX和JAXP。
DOM4J下载jar包：http://downloads.sourceforge.net/dom4j/dom4j-1.6.1.jar
JAXEN（对XPath的支持）：http://dist.codehaus.org/jaxen/distributions/jaxen-1.1.1.zip
1.DOM4J主要接口
DOM4J主要接口都在org.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注释的行为；
2.创建XML文档
示例xml：students.xml
|
import
java.io.File;
import
java.io.FileWriter;
import
java.io.IOException;
import
java.util.HashMap;
import
java.util.Map;
import
org.dom4j.Document;
import
org.dom4j.DocumentException;
import
org.dom4j.DocumentHelper;
import
org.dom4j.Element;
import
org.dom4j.io.XMLWriter;
public
class
XmlGen {
public
Document generateDocumentByMethod() {
Document document = DocumentHelper.
createDocument();
// ProcessingInstruction
Map<String, String> inMap =
new
HashMap<String, String>();
inMap.put(
"type"
,
"text/xsl"
);
inMap.put(
"href"
,
"students.xsl"
);
document.addProcessingInstruction(
"xml-stylesheet"
, inMap);
// root element
Element studentsElement = document.addElement(
"students"
);
studentsElement.addComment(
"An Student Catalog"
);
// son element
Element stuElement = studentsElement.addElement(
"student"
);
stuElement.addAttribute(
"sn"
,
"01"
);
Element nameElement = stuElement.addElement(
"name"
);
nameElement.setText(
"sam"
);
Element ageElement = stuElement.addElement(
"age"
);
ageElement.setText(
"18"
);
// son element
Element anotherStuElement = studentsElement.addElement(
"student"
);
anotherStuElement.addAttribute(
"sn"
,
"02"
);
Element anotherNameElement = anotherStuElement.addElement(
"name"
);
anotherNameElement.setText(
"lin"
);
Element anotherAgeElement = anotherStuElement.addElement(
"age"
);
anotherAgeElement.setText(
"20"
);
return
document;
}
public
Document generateDocumentByString() {
String text =
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+
"<?xml-stylesheet type=\"text/xsl\" href=\"students.xsl\"?>"
+
"<students><!--An Student Catalog--> <student sn=\"01\">"
+
"<name>sam</name><age>18</age></student><student sn=\"02\">"
+
"<name>lin</name><age>20</age></student></students>"
;
Document document =
null
;
try
{
document = DocumentHelper.
parseText(text);
}
catch
(DocumentException e) {
e.printStackTrace();
}
return
document;
}
public
void
saveDocument(Document document, File outputXml) {
try
{
//
美化格式
OutputFormat format = OutputFormat.
createPrettyPrint();
/*//
缩减格式
OutputFormat format = OutputFormat.createCompactFormat();*/
/*//
指定
XML
编码
format.setEncoding("GBK");*/
XMLWriter output =
new
XMLWriter(
new
FileWriter(outputXml), format);
output.write(document);
output.close();
}
catch
(IOException e) {
System.
out
.println(e.getMessage());
}
}
public
static
void
main(String[] argv) {
XmlGen dom4j =
new
XmlGen();
Document document =
null
;
// document=dom4j.generateDocumentByMethod();
document = dom4j.generateDocumentByString();
dom4j.saveDocument(document,
new
File(
"output.xml"
));
}
}
|
方法
generateDocumentByMethod()
通过调用方法构建
xml
文档：
1.使用DocumentHelper得到Document实例
Document document = DocumentHelper.createDocument();
2.创建
Processing Instruction
document.addProcessingInstruction(
"xml-stylesheet"
, inMap);
3.创建元素Element
Element studentsElement = document.addElement(
"students"
);
4.为元素添加注释Comment
studentsElement.addComment(
"An Student Catalog"
);
5.为元素添加属性
studentsElement.addComment(
"An Student Catalog"
);
6.为元素添加文本值Text
ageElement.setText(
"18"
);
方法
generateDocumentByString()
通过字符串转换直接构建
xml
文档，使用
DocumentHelper.parseText()
来实现
.
document = DocumentHelper.parseText(text);
方法
saveDocument(Document document, File outputXml)将文档输出到文件保存，可指定字符编码，可指定格式化输出。
3.修改XML文档
这里使用xpath来定位待修改的元素和属性，需要jaxen的支持。
示例中将students-gen.xml的第一个student元素的sn属性改为001，其子元素name内容改为jeff。
XmlMod.java
|
import
java.io.File;
import
java.util.Iterator;
import
org.dom4j.Attribute;
import
org.dom4j.Document;
import
org.dom4j.DocumentException;
import
org.dom4j.Element;
import
org.dom4j.ProcessingInstruction;
import
org.dom4j.VisitorSupport;
import
org.dom4j.io.SAXReader;
public
class
XmlTra {
private
File
inputXml
;
public
XmlTra(File inputXml) {
this
.
inputXml
= inputXml;
}
public
Document getDocument() {
SAXReader saxReader =
new
SAXReader();
Document document =
null
;
try
{
document = saxReader.read(
inputXml
);
}
catch
(DocumentException e) {
e.printStackTrace();
}
return
document;
}
public
Element getRootElement() {
return
getDocument().getRootElement();
}
public
void
traversalDocumentByIterator() {
Element root = getRootElement();
//
枚举根节点下所有子节点
for
(Iterator ie = root.elementIterator(); ie.hasNext();) {
System.
out
.println(
"======"
);
Element element = (Element) ie.next();
System.
out
.println(element.getName());
//
枚举属性
for
(Iterator ia = element.attributeIterator(); ia.hasNext();) {
Attribute attribute = (Attribute) ia.next();
System.
out
.println(attribute.getName() +
":"
+ attribute.getData());
}
//
枚举当前节点下所有子节点
for
(Iterator ieson = element.elementIterator(); ieson.hasNext();) {
Element elementSon = (Element) ieson.next();
System.
out
.println(elementSon.getName() +
":"
+ elementSon.getText());
}
}
}
public
void
traversalDocumentByVisitor() {
getDocument().accept(
new
MyVisitor());
}
/**
*
定义自己的访问者类
*/
private
static
class
MyVisitor
extends
VisitorSupport {
/**
*
对于属性节点，打印属性的名字和值
*/
public
void
visit(Attribute node) {
System.
out
.println(
"attribute : "
+ node.getName() +
" = "
+ node.getValue());
}
/**
*
对于处理指令节点，打印处理指令目标和数据
*/
public
void
visit(ProcessingInstruction node) {
System.
out
.println(
"PI : "
+ node.getTarget() +
" "
+ node.getText());
}
/**
*
对于元素节点，判断是否只包含文本内容，如是，则打印标记的名字和
元素的内容。如果不是，则只打印标记的名字
*/
public
void
visit(Element node) {
if
(node.isTextOnly())
System.
out
.println(
"element : "
+ node.getName() +
" = "
+ node.getText());
else
System.
out
.println(
"--------"
+ node.getName() +
"--------"
);
}
}
public
static
void
main(String[] argv) {
XmlTra dom4jParser =
new
XmlTra(
new
File(
"students-gen.xml"
));
// dom4jParser.traversalDocumentByIterator();
dom4jParser.traversalDocumentByVisitor();
}
}
|
方法
traversalDocumentByIterator()提供一种基于迭代的遍历实现，每个Element通过
elementIterator()和
attributeIterator()取代其子元素和属性的迭代器。
Visitor是GOF设计模式之一。其主要原理就是两种类互相保有对方的引用，并且一种作为Visitor去访问许多Visitable。DOM4J中的Visitor模式只需要自定一个类实现Visitor接口即可。
|
import
java.io.File;
import
org.dom4j.DocumentException;
import
org.dom4j.Element;
import
org.dom4j.ElementHandler;
import
org.dom4j.ElementPath;
import
org.dom4j.io.SAXReader;
public
class
XmlHandler {
public
static
void
main(String[] args) {
SAXReader saxReader =
new
SAXReader();
File file =
new
File(
"students.xml"
);
try
{
//
添加一个
ElementHandler
实例。
saxReader.addHandler(
"/students/student"
,
new
StudentHandler());
saxReader.read(file);
}
catch
(DocumentException e) {
System.
out
.println(e.getMessage());
}
}
/**
*
定义
StudentHandler
处理器类，对
<student>
元素进行处理。
*/
private
static
class
StudentHandler
implements
ElementHandler {
public
void
.Start(ElementPath path) {
Element elt = path.getCurrent();
System.
out
.println(
"Found student: "
+ elt.attribut.ue(
"sn"
));
//
添加对子元素
<name>
的处理器。
path.addHandler(
"name"
,
new
NameHandler());
}
public
void
.End(ElementPath path) {
//
移除对子元素
<name>
的处理器。
path.removeHandler(
"name"
);
}
}
/**
*
定义
NameHandler
处理器类，对
<student>
的
<name>
子元素进行处理。
*/
private
static
class
NameHandler
implements
ElementHandler {
public
void
.Start(ElementPath path) {
System.
out
.println(
"path : "
+ path.getPath());
}
public
void
.End(ElementPath path) {
Element elt = path.getCurrent();
//
输出
<name>
元素的名字和它的文本内容。
System.
out
.println(elt.getName() +
" : "
+ elt.getText());
}
}
}
|
6.使用XSLT转换XML
这里必须使用JAXP的支持。
<td 230,="" 230)="" none="" repeat="" scroll="" 0%="" 0%;="" width:="" 426.1pt;="" -moz-background-clip:="" -moz-initial;="" -moz-background-origin:="" -moz-background-inline-policy:="" -moz-initial;"="" valign="top" width="568" style="padding: 0cm 5.4pt; margin: 0px; border: 1pt solid windowtext;">
import
javax.xml.transform.Transformer;
import
javax.xml.transform.TransformerFactory;
import
org.dom4j.Document;
import
org.dom4j.io.DocumentResult;
import
org.dom4j.io.DocumentSource;
……
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;
}
……