《Dom4j 使用简介.pdf》由会员分享，可在线阅读，更多相关《Dom4j 使用简介.pdf（36页珍藏版）》请在三一文库上搜索。
1、Dom4j 使用简介使用简介 作者：冰云 icecloud(AT) 时间：2003.12.15 版权声明：版权声明： 本文由冰云完成，首发于 CSDN，未经许可，不得使用于任何商业用途。 文中代码部分引用自 DOM4J 文档。 欢迎转载，但请保持文章及版权声明完整。 如需联络请发邮件：icecloud(AT) DOM4J 是 dom4j.org 出品的一个开源 XML 解析包，它的网站中这样定义： Dom4j is an easy to use, open source library for working with XML, XPath and XSLT on the Java platf
2、orm using the Java Collections Framework and with full support for DOM, SAX and JAXP. Dom4j 是一个易用的、开源的库，用于是一个易用的、开源的库，用于 XML，XPath 和和 XSLT。它应用于。它应用于 Java 平平 台，采用了台，采用了 Java 集合框架并完全支持集合框架并完全支持 DOM，SAX 和和 JAXP。 DOM4J 使用起来非常简单。只要你了解基本的 XML-DOM 模型，就能使用。然而他 自己带的指南只有短短一页（html），不过说的到挺全。国内的中文资料很少。 因而俺写这个短小的
3、教程方便大家使用，这篇文章仅谈及基本的用法， 如需深入 的使用，请自己摸索或查找别的资料。 之前看过 IBM developer 社区的文章（参见附录），提到一些 XML 解析包的性能 比较，其中 DOM4J 的性能非常出色，在多项测试中名列前茅。（事实上 DOM4J 的官方文档中也引用了这个比较）所以这次的项目中我采用了 DOM4J 作为 XML 解析工具。 PDF 文件使用 pdfFactory Pro 试用版本创建 在国内比较流行的是使用 JDOM 作为解析器，两者各擅其长，但 DOM4J 最大的特 色是使用大量的接口，这也是它被认为比 JDOM 灵活的主要原因。大师不是说过 么， “面
4、向接口编程”。 目前使用 DOM4J 的已经越来越多。 如果你善于使用 JDOM， 不妨继续用下去， 只看看本篇文章作为了解与比较， 如果你正要采用一种解析器， 不如就用 DOM4J 吧。 它的主要接口都在 org.dom4j 这个包里定义： Attribute Attribute 定义了 XML 的属性 Branch Branch 为能够包含子节点的节点如 XML 元素 (Element)和文档(Docuemnts)定义了一个公共的行 为， CDATA CDATA 定义了 XML CDATA 区域 CharacterData CharacterData 是一个标识借口，标识基于字符的节 点。
5、如 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 节点
6、定义了多态行为 NodeFilter NodeFilter 定义了在 dom4j 节点中产生的一个滤镜或 谓词的行为（predicate） ProcessingInstruction ProcessingInstruction 定义 XML 处理指令. Text Text 定义 XML 文本节点. Visitor Visitor 用于实现 Visitor 模式. XPath XPath 在分析一个字符串后会提供一个 XPath 表达式 看名字大致就知道它们的涵义如何了。 要想弄懂这套接口，关键的是要明白接口的继承关系： PDF 文件使用 pdfFactory Pro 试用版本创建 o inte
7、rface java.lang.Cloneable o o o 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.do
8、m4j.DocumentType interface org.dom4j.Entity interface org.dom4j.ProcessingInstruction PDF 文件使用 pdfFactory Pro 试用版本创建 一目了然，很多事情都清楚了。大部分都是由 Node 继承来的。知道这些关系， 将来写程序就不会出现 ClassCastException 了。 下面给出一些例子（部分摘自 DOM4J 自带的文档），简单说一下如何使用。 读取并解析 XML 文档： 读写 XML 文档主要依赖于 org.dom4j.io 包，其中提供 DOMReader 和 SAXReader 两类
9、不同方式，而调用方式是一样的。这就是依靠接口的好处。 / 从文件读取 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 等多种
10、 不同的源来读取。得到的 Document 对象就带表了整个 XML。 根据本人自己的经验，读取的字符编码是按照 XML 文件头定义的编码来转换。 如 果遇到乱码问题，注意要把各处的编码名称保持一致即可。 取得 Root 节点 读取后的第二步，就是得到 Root 节点。熟悉 XML 的人都知道，一切 XML 分析都 是从 Root 元素开始的。 PDF 文件使用 pdfFactory Pro 试用版本创建 public Element getRootElement(Document doc) return doc.getRootElement(); 遍历 XML 树 DOM4J 提供至少 3
11、种遍历节点的方法： 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 = ro
12、ot.attributeIterator(); i.hasNext(); ) Attribute attribute = (Attribute) i.next(); / do something 2)递归 递归也可以采用 Iterator 作为枚举手段，但文档中提供了另外的做法 public void treeWalk() treeWalk(getRootElement(); public void treeWalk(Element element) PDF 文件使用 pdfFactory Pro 试用版本创建 for (int i = 0, size = element.nodeCount(
13、); i size; i+) Node node = element.node(i); if (node instanceof Element) treeWalk(Element) node); else / do something. 3) Visitor 模式 最令人兴奋的是 DOM4J 对 Visitor 的支持，这样可以大大缩减代码量， 并且清楚 易懂。了解设计模式的人都知道，Visitor 是 GOF 设计模式之一。其主要原理就 是两种类互相保有对方的引用，并且一种作为 Visitor 去访问许多 Visitable。 我们来看 DOM4J 中的 Visitor 模式(快速文档中没有
14、提供) 只需要自定一个类实现 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 不同的对象，将采用不同 的方式来访问
15、。 上面是给出的 Element 和 Attribute 的简单实现， 一般比较常用 的就是这两个。VisitorSupport 是 DOM4J 提供的默认适配器，Visitor 接口的 Default Adapter 模式， 这个模式给出了各种 visit(*)的空实现， 以便简化代码。 PDF 文件使用 pdfFactory Pro 试用版本创建 注意，这个 Visitor 是自动遍历所有子节点的。如果是 root.accept(MyVisitor)，将遍历子节点。我第一次用的时候，认为是需要自己 遍历，便在递归中调用 Visitor，结果可想而知。 4. XPath 支持 DOM4J 对
16、 XPath 有良好的支持，如访问一个节点，可直接用 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 Docum
17、entException 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 或反之， / XML 转字符串 Document document = .; PDF 文件使用 pdfFactory Pro 试用版本创建
18、 String text = document.asXML(); / 字符串转 XML String text = James ; Document document = DocumentHelper.parseText(text); 6 用 XSLT 转换 XML public Document styleDocument( Document document, String stylesheet ) throws Exception / load the transformer using JAXP TransformerFactory factory = TransformerFacto
19、ry.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 transf
20、ormed document Document transformedDoc = result.getDocument(); return transformedDoc; 7. 创建 XML 一般创建 XML 是写文件前的工作，这就像 StringBuffer 一样容易。 public Document createDocument() Document document = DocumentHelper.createDocument(); Element root = document.addElement(root); Element author1 = root .addElement(
21、author) .addAttribute(name, James) PDF 文件使用 pdfFactory Pro 试用版本创建 .addAttribute(location, UK) .addText(James Strachan); Element author2 = root .addElement(author) .addAttribute(name, Bob) .addAttribute(location, US) .addText(Bob McWhirter); return document; 8. 文件输出 一个简单的输出方法是将一个Document 或任何的Node 通过w
22、rite 方法输出 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(); / 美化格式 OutputF
23、ormat format = OutputFormat.createPrettyPrint(); writer = new XMLWriter( System.out, format ); writer.write( document ); / 缩减格式 format = OutputFormat.createCompactFormat(); writer = new XMLWriter( System.out, format ); writer.write( document ); PDF 文件使用 pdfFactory Pro 试用版本创建 如何， DOM4J 够简单吧， 当然， 还有一些
24、复杂的应用没有提到， 如 ElementHandler 等。如果你动心了，那就一起来用 DOM4J. DOM4J 官方网站：(我老连不上) http:/www.dom4j.org/ DOM4J 下载(SourceForge)，最新版本为 1.4 用用 Dom4j 解析解析 XML 及中文问题及中文问题 发表于 2004 年 9 月 27 日 20:21 本文主要讨论了用 dom4j 解析 XML 的基础问题， 包括建立 XML 文档， 添加、 修改、 删除节点，以及格式化（美化）输出和中文问题。可作为 dom4j 的入门资料。 转载自: 作者：陈光（） 时间：2004-09-11 PDF 文件
25、使用 pdfFactory Pro 试用版本创建 本文主要讨论了用 dom4j 解析 XML 的基础问题， 包括建立 XML 文档， 添加、 修改、 删除节点，以及格式化（美化）输出和中文问题。可作为 dom4j 的入门资料。 1 下载与安装下载与安装 dom4j 是 上的一个开源项目， 主要用于对 XML 的解析。从 2001 年 7 月发布第一版以来，已陆续推出多个版本，目前最高版本为 1.5。 dom4j 专门针对 Java 开发，使用起来非常简单、直观，在 Java 界，dom4j 正迅 速普及。 可以到 下载其最新版。 dom4j1.5 的完整版大约 13M，是一个名为 dom4j-
26、1.5.zip 的压缩包， 解压后有一 个 dom4j-1.5.jar 文件，这就是应用时需要引入的类包，另外还有一个 jaxen-1.1-beta-4.jar 文件，一般也需要引入，否则执行时可能抛 java.lang.NoClassDefFoundError: org/jaxen/JaxenException 异常，其他的 包可以选择用之。 PDF 文件使用 pdfFactory Pro 试用版本创建 2 示例示例 XML 文档（文档（holen.xml） 为了述说方便，先看一个 XML 文档，之后的操作均以此文档为基础。 holen.xml Dom4j Tutorials Lucene
27、Studing Lucene in Action OReilly 这是一个很简单的 XML 文档，场景是一个网上书店，有很多书，每本书有两个属 性，一个是书名title，一个为是否展示show，最后还有一项是这些书的拥 有者owner信息。 3 建立一个建立一个 XML 文档文档 PDF 文件使用 pdfFactory Pro 试用版本创建 /* * 建立一个 XML 文档,文档名由输入属性决定 * param filename 需建立的文件名 * return 返回操作结果, 0 表失败, 1 表成功 */ public int createXMLFile(String filename)
28、/* 返回操作结果, 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 节点 */ E
29、lement bookElement = booksElement.addElement(book); /* 加入 show 属性内容 */ bookElement.addAttribute(show,yes); /* 加入 title 节点 */ Element titleElement = bookElement.addElement(title); /* 为 title 设置内容 */ titleElement.setText(Dom4j Tutorials); /* 类似的完成后两个 book */ bookElement = booksElement.addElement(book)
30、; bookElement.addAttribute(show,yes); titleElement = bookElement.addElement(title); titleElement.setText(Lucene Studing); bookElement = booksElement.addElement(book); bookElement.addAttribute(show,no); titleElement = bookElement.addElement(title); titleElement.setText(Lucene in Action); /* 加入 owner
31、节点 */ Element ownerElement = booksElement.addElement(owner); PDF 文件使用 pdfFactory Pro 试用版本创建 ownerElement.setText(OReilly); try /* 将 document 中的内容写入文件中 */ XMLWriter writer = new XMLWriter(new FileWriter(new File(filename); writer.write(document); writer.close(); /* 执行成功,需返回 1 */ returnValue = 1; catc
32、h(Exception ex) ex.printStackTrace(); return returnValue; 说明： Document document = DocumentHelper.createDocument(); 通过这句定义一个 XML 文档对象。 Element booksElement = document.addElement(books); 通过这句定义一个 XML 元素，这里添加的是根节点。 Element 有几个重要的方法： l addComment：添加注释 PDF 文件使用 pdfFactory Pro 试用版本创建 l addAttribute：添加属性 l
33、 addElement：添加子元素 最后通过 XMLWriter 生成物理文件， 默认生成的 XML 文件排版格式比较乱， 可以 通过 OutputFormat 类的 createCompactFormat()方法或 createPrettyPrint() 方法格式化输出，默认采用 createCompactFormat()方法，显示比较紧凑，这点 将在后面详细谈到。 生成后的 holen.xml 文件内容如下： Dom4j TutorialsLucene StudingLucene in ActionOReilly 4 修改修改 XML 文档文档 PDF 文件使用 pdfFactory Pr
34、o 试用版本创建 有三项修改任务，依次为： l 如果 book 节点中 show 属性的内容为 yes,则修改成 no l 把 owner 项内容改为 Tshinghua，并添加 date 节点 l 若 title 内容为 Dom4j Tutorials,则删除该节点 /* * 修改 XML 文件中内容,并另存为一个新文件 * 重点掌握 dom4j 中如何添加节点,修改节点,删除节点 * param filename 修改对象文件 * param newfilename 修改后另存为该文件 * return 返回操作结果, 0 表失败, 1 表成功 */ public int ModiXMLF
35、ile(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.ite
36、rator(); while(iter.hasNext() Attribute attribute = (Attribute)iter.next(); if(attribute.getValue().equals(yes) attribute.setValue(no); PDF 文件使用 pdfFactory Pro 试用版本创建 /* * 修改内容之二: 把 owner 项内容改为 Tshinghua * 并在 owner 节点中加入 date 节点,date 节点的内容为 2004- 09- 11,还 为 date 节点添加一个属性 type */ list = document.sele
37、ctNodes(/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); /* 修改内容之三: 若 titl
38、e 内容为 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() Element titleElement=(Element)iterator.next(); if(titleE
39、lement.getText().equals(Dom4j Tutorials) bookElement.remove(titleElement); try /* 将 document 中的内容写入文件中 */ XMLWriter writer = new XMLWriter(new FileWriter(new File(newfilename); writer.write(document); writer.close(); /* 执行成功,需返回 1 */ returnValue = 1; catch(Exception ex) ex.printStackTrace(); catch(E
40、xception ex) ex.printStackTrace(); PDF 文件使用 pdfFactory Pro 试用版本创建 return returnValue; 说明： List list = document.selectNodes(/books/book/show ); list = document.selectNodes(/books/book); 上述代码通过 xpath 查找到相应内容。 通过 setValue()、setText()修改节点内容。 通过 remove()删除节点或属性。 5 格式化输出和指定编码格式化输出和指定编码 PDF 文件使用 pdfFactory
41、 Pro 试用版本创建 默认的输出方式为紧凑方式，默认编码为 UTF-8，但对于我们的应用而言，一般 都要用到中文，并且希望显示时按自动缩进的方式的显示，这就需用到 OutputFormat 类。 /* * 格式化 XML 文档,并解决中文问题 * param filename * return */ public int formatXMLFile(String filename) int returnValue = 0; try SAXReader saxReader = new SAXReader(); Document document = saxReader.read(new Fil
42、e(filename); XMLWriter writer = null; /* 格式化输出,类型 IE 浏览一样 */ OutputFormat format = OutputFormat.createPrettyPrint(); /* 指定 XML 编码 */ format.setEncoding(GBK); writer= new XMLWriter(new FileWriter(new File(filename),format); writer.write(document); writer.close(); /* 执行成功,需返回 1 */ returnValue = 1; cat
43、ch(Exception ex) ex.printStackTrace(); return returnValue; PDF 文件使用 pdfFactory Pro 试用版本创建 说明： OutputFormat format = OutputFormat.createPrettyPrint(); 这句指定了格式化的方式为缩进式，则非紧凑式。 format.setEncoding(GBK); 指定编码为 GBK。 XMLWriter writer = new XMLWriter(new FileWriter(new File(filename),format); 这与前面两个方法相比，多加了一个 OutputFormat 对象，用于指定显示和编码 方式。 6 完整的类代码完整的类代码 前面提出的方法都是零散的，下面给出完整类代码。 PDF 文件使用 pdfFactory Pro