SQnote
永远有多远……
SQnote - java,web优化,python,(www.sqnote.cn)
[摘]domj4 API 创建与修改 XML 文档
 

使用 domj4 API 创建与修改 XML 文档

级别: 初级

Deepak Vohra
Web 开发人员
2004 年 4 月

dom4j 是一种解析 XML 文档的开放源代码 XML 框架。本文介绍如何使用包含在 dom4j 中的解析器创建并修改 XML 文档。

dom4j API 包含一个解析 XML 文档的工具。本文中将使用这个解析器创建一个示例 XML 文档。清单 1 显示了这个示例 XML 文档，catalog.xml。

清单 1. 示例 XML 文档（catalog.xml）

 

<?xml version="1.0" encoding="UTF-8"?>

<catalog>

<!--An XML Catalog-->

<?target instruction?>

  <journal title="XML Zone"

                  publisher="IBM developerWorks">

 

<article level="Intermediate" date="December-2001">

       <title>Java configuration with XML Schema</title>

       <author>

           <firstname>Marcello</firstname>

           <lastname>Vitaletti</lastname>

       </author>

    </article>

  </journal>

</catalog>

然后使用同一个解析器修改 catalog.xml，清单 2 是修改后的 XML 文档，catalog-modified.xml。

清单 2. 修改后的 XML 文档（catalog-modified.xml）

 

<?xml version="1.0" encoding="UTF-8"?>

<catalog>

<!--An XML catalog-->

<?target instruction?>

  <journal title="XML Zone"

                   publisher="IBM developerWorks">

 

<article level="Introductory" date="October-2002">

 <title>Create flexible and extensible XML schemas</title>

 <author>

     <firstname>Ayesha</firstname>

     <lastname>Malik</lastname>

 </author>

  </article>

  </journal>

</catalog>

与 W3C DOM API 相比，使用 dom4j 所包含的解析器的好处是 dom4j 拥有本地的 XPath 支持。DOM 解析器不支持使用 XPath 选择节点。

本文包括以下几个部分：

  • 预先设置
  • 创建文档
  • 修改文档

预先设置
这个解析器可以从 http://dom4j.org 获取。通过设置使 dom4j-1.4/dom4j-full.jar 能够在 classpath 中访问，该文件中包括 dom4j 类、XPath 引擎以及 SAX 和 DOM 接口。如果已经使用了 JAXP 解析器中包含的 SAX 和 DOM 接口，向 classpath 中增加 dom4j-1.4/dom4j.jar 。 dom4j.jar 包括 dom4j 类和 XPath 引擎，但是不含 SAX 与 DOM 接口。

创建文档
本节讨论使用 dom4j API 创建 XML 文档的过程，并创建示例 XML 文档 catalog.xml。

使用 import 语句导入 dom4j API 类：

 

import org.dom4j.Document;

import org.dom4j.DocumentHelper;

import org.dom4j.Element;

使用 DocumentHelper 类创建一个文档实例。 DocumentHelper 是生成 XML 文档节点的 dom4j API 工厂类。

 Document document = DocumentHelper.createDocument();

使用 addElement() 方法创建根元素 catalog 。 addElement() 用于向 XML 文档中增加元素。

Element catalogElement = document.addElement("catalog");

在 catalog 元素中使用 addComment() 方法添加注释“An XML catalog”。

 catalogElement.addComment("An XML catalog");

在 catalog 元素中使用 addProcessingInstruction() 方法增加一个处理指令。

catalogElement.addProcessingInstruction("target","text");

在 catalog 元素中使用 addElement() 方法增加 journal 元素。

Element journalElement =  catalogElement.addElement("journal");

使用 addAttribute() 方法向 journal 元素添加 title 和 publisher 属性。

journalElement.addAttribute("title", "XML Zone");

         journalElement.addAttribute("publisher", "IBM developerWorks");

向 article 元素中添加 journal 元素。

Element articleElement=journalElement.addElement("article");

为 article 元素增加 level 和 date 属性。

articleElement.addAttribute("level", "Intermediate");

      articleElement.addAttribute("date", "December-2001");

向 article 元素中增加 title 元素。

Element titleElement=articleElement.addElement("title");

使用 setText() 方法设置 article 元素的文本。

titleElement.setText("Java configuration with XML Schema");

在 article 元素中增加 author 元素。

Element authorElement=articleElement.addElement("author");

在 author 元素中增加 firstname 元素并设置该元素的文本。

Element  firstNameElement=authorElement.addElement("firstname");

     firstNameElement.setText("Marcello");

在 author 元素中增加 lastname 元素并设置该元素的文本。

Element lastNameElement=authorElement.addElement("lastname");

     lastNameElement.setText("Vitaletti");

可以使用 addDocType() 方法添加文档类型说明。

document.addDocType("catalog", null,"file://c:/Dtds/catalog.dtd");

这样就向 XML 文档中增加文档类型说明：

<!DOCTYPE catalog SYSTEM "file://c:/Dtds/catalog.dtd">

如果文档要使用文档类型定义（DTD）文档验证则必须有 Doctype。

XML 声明 <?xml version="1.0" encoding="UTF-8"?> 自动添加到 XML 文档中。

清单 3 所示的例子程序 XmlDom4J.java 用于创建 XML 文档 catalog.xml。

清单 3. 生成 XML 文档 catalog.xml 的程序（XmlDom4J.java）

 

import org.dom4j.Document;

import org.dom4j.DocumentHelper;

import org.dom4j.Element;

import org.dom4j.io.XMLWriter;

import java.io.*;

 

 

 

public class XmlDom4J{

 

 

public void generateDocument(){

Document document = DocumentHelper.createDocument();

     Element catalogElement = document.addElement("catalog");

     catalogElement.addComment("An XML Catalog");

     catalogElement.addProcessingInstruction("target","text");

     Element journalElement =  catalogElement.addElement("journal");

     journalElement.addAttribute("title", "XML Zone");

     journalElement.addAttribute("publisher", "IBM developerWorks");

 

 

     Element articleElement=journalElement.addElement("article");

     articleElement.addAttribute("level", "Intermediate");

     articleElement.addAttribute("date", "December-2001");

     Element  titleElement=articleElement.addElement("title");

     titleElement.setText("Java configuration with XML Schema");

     Element authorElement=articleElement.addElement("author");

     Element  firstNameElement=authorElement.addElement("firstname");

     firstNameElement.setText("Marcello");

     Element lastNameElement=authorElement.addElement("lastname");

     lastNameElement.setText("Vitaletti");

 

     document.addDocType("catalog",

                           null,"file://c:/Dtds/catalog.dtd");

    try{

    XMLWriter output = new XMLWriter(

            new FileWriter( new File("c:/catalog/catalog.xml") ));

        output.write( document );

        output.close();

        }

     catch(IOException e){System.out.println(e.getMessage());}

}

 

public static void main(String[] argv){

XmlDom4J dom4j=new XmlDom4J();

dom4j.generateDocument();

}}

这一节讨论了创建 XML 文档的过程，下一节将介绍使用 dom4j API 修改这里创建的 XML 文档。

修改文档
这一节说明如何使用 dom4j API 修改示例 XML 文档 catalog.xml。

使用 SAXReader 解析 XML 文档 catalog.xml：

SAXReader saxReader = new SAXReader();

 Document document = saxReader.read(inputXml);

SAXReader 包含在 org.dom4j.io 包中。

inputXml 是从 c:/catalog/catalog.xml 创建的 java.io.File。使用 XPath 表达式从 article 元素中获得 level 节点列表。如果 level 属性值是“Intermediate”则改为“Introductory”。

List list = document.selectNodes("//article/@level" );

      Iterator iter=list.iterator();

        while(iter.hasNext()){

            Attribute attribute=(Attribute)iter.next();

               if(attribute.getValue().equals("Intermediate"))

               attribute.setValue("Introductory");

       }

获取 article 元素列表，从 article 元素中的 title 元素得到一个迭代器，并修改 title 元素的文本。

list = document.selectNodes("//article" );

     iter=list.iterator();

   while(iter.hasNext()){

       Element element=(Element)iter.next();

      Iterator iterator=element.elementIterator("title");

   while(iterator.hasNext()){

   Element titleElement=(Element)iterator.next();

   if(titleElement.getText().equals("Java configuration with XML Schema"))

     titleElement.setText("Create flexible and extensible XML schema");

 

    }}

通过和 title 元素类似的过程修改 author 元素。

清单 4 所示的示例程序 Dom4JParser.java 用于把 catalog.xml 文档修改成 catalog-modified.xml 文档。

清单 4. 用于修改 catalog.xml 的程序（Dom4Jparser.java）

 

import org.dom4j.Document;

import org.dom4j.Element;

import org.dom4j.Attribute;

import java.util.List;

import java.util.Iterator;

import org.dom4j.io.XMLWriter;

import java.io.*;

import org.dom4j.DocumentException;

import org.dom4j.io.SAXReader;

 

public class Dom4JParser{

 

 public void modifyDocument(File inputXml){

 

  try{

   SAXReader saxReader = new SAXReader();

   Document document = saxReader.read(inputXml);

 

   List list = document.selectNodes("//article/@level" );

   Iterator iter=list.iterator();

   while(iter.hasNext()){

    Attribute attribute=(Attribute)iter.next();

    if(attribute.getValue().equals("Intermediate"))

      attribute.setValue("Introductory");

 

       }

  

   list = document.selectNodes("//article/@date" );

   iter=list.iterator();

   while(iter.hasNext()){

    Attribute attribute=(Attribute)iter.next();

    if(attribute.getValue().equals("December-2001"))

      attribute.setValue("October-2002");

 

       }

 

   list = document.selectNodes("//article" );

   iter=list.iterator();

   while(iter.hasNext()){

    Element element=(Element)iter.next();

    Iterator iterator=element.elementIterator("title");

      while(iterator.hasNext()){

        Element titleElement=(Element)iterator.next();

        if(titleElement.getText().equals("Java configuration with XML

 

      Schema"))

        titleElement.setText("Create flexible and extensible XML schema");

 

                                          }

 

                                }

 

    list = document.selectNodes("//article/author" );

    iter=list.iterator();

     while(iter.hasNext()){

     Element element=(Element)iter.next();

     Iterator iterator=element.elementIterator("firstname");

     while(iterator.hasNext()){

      Element firstNameElement=(Element)iterator.next();

      if(firstNameElement.getText().equals("Marcello"))

      firstNameElement.setText("Ayesha");

                                     }

 

                              }

 

    list = document.selectNodes("//article/author" );

    iter=list.iterator();

     while(iter.hasNext()){

      Element element=(Element)iter.next();

      Iterator iterator=element.elementIterator("lastname");

     while(iterator.hasNext()){

      Element lastNameElement=(Element)iterator.next();

      if(lastNameElement.getText().equals("Vitaletti"))

      lastNameElement.setText("Malik");

 

                                  }

 

                               }

     XMLWriter output = new XMLWriter(

      new FileWriter( new File("c:/catalog/catalog-modified.xml") ));

     output.write( document );

     output.close();

   }

 

  catch(DocumentException e)

                 {

                  System.out.println(e.getMessage());

                            }

 

  catch(IOException e){

                       System.out.println(e.getMessage());

                    }

 }

 

 public static void main(String[] argv){

 

  Dom4JParser dom4jParser=new Dom4JParser();

  dom4jParser.modifyDocument(new File("c:/catalog/catalog.xml"));

 

                                        }

 

   }

这一节说明了如何使用 dom4j 中的解析器修改示例 XML 文档。这个解析器不使用 DTD 或者模式验证 XML 文档。如果 XML 文档需要验证，可以解释用 dom4j 与 JAXP SAX 解析器。

结束语
包含在 dom4j 中的解析器是一种用于解析 XML 文档的非验证性工具，可以与JAXP、Crimson 或 Xerces 集成。本文说明了如何使用该解析器创建和修改 XML 文档。

参考资料

关于作者
Deepak Vohra（dvohra09@yahoo.com）是一位 Web 开发人员、NuBean 顾问和 Sun 认证的 Java 1.4 程序员。可以通过 dvohra09@yahoo.com 与他联系。

 

 

 

 

 

 

Dom4j 使用简介

作者：冰云 icecloud(AT)sina.com

时间：2003.12.15

    DOM4J是dom4j.org出品的一个开源XML解析包，它的网站中这样定义：

Dom4j is an easy to use, open source library for working with XML, XPath and XSLT on the Java platform 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），不过说的到挺全。国内的中文资料很少。因而俺写这个短小的教程方便大家使用，这篇文章仅谈及基本的用法，如需深入的使用，请……自己摸索或查找别的资料。

之前看过IBM developer社区的文章（参见附录），提到一些XML解析包的性能比较，其中DOM4J的性能非常出色，在多项测试中名列前茅。（事实上DOM4J的官方文档中也引用了这个比较）所以这次的项目中我采用了DOM4J作为XML解析工具。

在国内比较流行的是使用JDOM作为解析器，两者各擅其长，但DOM4J最大的特色是使用大量的接口，这也是它被认为比JDOM灵活的主要原因。大师不是说过么，“面向接口编程”。目前使用DOM4J的已经越来越多。如果你善于使用JDOM，不妨继续用下去，只看看本篇文章作为了解与比较，如果你正要采用一种解析器，不如就用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 表达式

看名字大致就知道它们的涵义如何了。

要想弄懂这套接口，关键的是要明白接口的继承关系：

一目了然，很多事情都清楚了。大部分都是由Node继承来的。知道这些关系，将来写程序就不会出现ClassCastException了。

下面给出一些例子（部分摘自DOM4J自带的文档），简单说一下如何使用。

１．              读取并解析XML文档：

读写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文件头定义的编码来转换。如果遇到乱码问题，注意要把各处的编码名称保持一致即可。

２．    取得Root节点

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

 

　  public Element getRootElement(Document doc){

       return doc.getRootElement();

    }

 

３．    遍历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模式

最令人兴奋的是DOM4J对Visitor的支持，这样可以大大缩减代码量，并且清楚易懂。了解设计模式的人都知道，Visitor是GOF设计模式之一。其主要原理就是两种类互相保有对方的引用，并且一种作为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不同的对象，将采用不同的方式来访问。上面是给出的Element和Attribute的简单实现，一般比较常用的就是这两个。VisitorSupport是DOM4J提供的默认适配器，Visitor接口的Default Adapter模式，这个模式给出了各种visit(*)的空实现，以便简化代码。

    注意，这个Visitor是自动遍历所有子节点的。如果是root.accept(MyVisitor)，将遍历子节点。我第一次用的时候，认为是需要自己遍历，便在递归中调用Visitor，结果可想而知。

4. XPath支持

    DOM4J对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 DocumentException {

        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 = ...;

    String text = document.asXML();

// 字符串转XML

    String text = <person> <name>James</name> </person>;

    Document document = DocumentHelper.parseText(text);

 

6 用XSLT转换XML

 

   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;

}

 

7. 创建XML

  一般创建XML是写文件前的工作，这就像StringBuffer一样容易。

 

    public Document createDocument() {

       Document document = DocumentHelper.createDocument();

       Element root = document.addElement(root);

       Element author1 =

           root

              .addElement(author)

              .addAttribute(name, James)

              .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通过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 );

    }

 

如何，DOM4J够简单吧，当然，还有一些复杂的应用没有提到，如ElementHandler等。如果你动心了，那就一起来用DOM4J.

DOM4J官方网站：(我老连不上)

http://www.dom4j.org

DOM4J下载(SourceForge)，最新版本为1.4

http://sourceforge.net/projects/dom4j

参考资料：

DOM4J文档

Java 中的 XML：文档模型，第一部分：性能

http://www-900.ibm.com/developerWorks/cn/xml/x-injava/index.shtml

Java 中的 XML：Java 文档模型的用法

http://www-900.ibm.com/developerWorks/cn/xml/x-injava2/index.shtml

Java XML API 漫谈　by robbin

http://www.hibernate.org.cn:8000/137.html

 

posted on 2005-08-31 10:39  SQnote·www.SQnote.cn  阅读(1096)  评论(0)  编辑  收藏  举报

Copyright © 2024 SQnote·www.SQnote.cn
Powered by .NET 8.0 on Kubernetes Powered By博客园