XML文件的创建和解析笔记

解析XML的四种方法

　　XML现在已经成为一种通用的数据交换格式,它的平台无关性,语言无关性,系统无关性,给数据集成与交互带来了极大的方便。对于XML本身的语法知识与技术细节,需要阅读相关的技术文献,这里面包括的内容有DOM(Document Object Model),DTD(Document Type Definition),SAX(Simple API for XML),XSD(Xml Schema Definition),XSLT(Extensible Stylesheet Language Transformations),具体可参阅w3c官方网站文档http://www.w3.org获取更多信息。

　　XML在不同的语言里解析方式都是一样的,只不过实现的语法不同而已。基本的解析方式有两种,一种叫SAX，另一种叫DOM。SAX是基于事件流的解析,DOM是基于XML文档树结构的解析。假设我们XML的内容和结构如下:

<?xml   version="1.0" encoding="UTF-8"?>
    <employees>
        <employee>
          <name>ddviplinux</name>
          <sex>m</sex>
          <age>30</age>
        </employee>
    </employees>

　　本文使用JAVA语言来实现DOM与SAX的XML文档生成与解析。
　　首先定义一个操作XML文档的接口XmlDocument 它定义了XML文档的建立与解析的接口。

package com.beyond.framework.bean;
  /**
  * @author zhengwei
  * 定义XML文档建立与解析的接口
  */
  public interface XmlDocument {
  /**
  * 建立XML文档
  * @param fileName 文件全路径名称
  */
  public void createXml(String fileName);
  /**
  * 解析XML文档
  * @param fileName 文件全路径名称
  */
  public void parserXml(String fileName);
  }

1. DOM生成和解析XML文档

 　　为 XML 文档的已解析版本定义了一组接口。解析器读入整个文档，然后构建一个驻留内存的树结构，然后代码就可以使用 DOM 接口来操作这个树结构。

　　优点：整个文档树在内存中，便于操作；支持删除、修改、重新排列等多种功能；

　　缺点：将整个文档调入内存（包括无用的节点），浪费时间和空间；

　　使用场合：一旦解析了文档还需多次访问这些数据；硬件资源充足（内存、CPU）。

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/*
* @author zhengwei
* DOM生成与解析XML文档
*/
public class DomDemo implements XmlDocument {
    private Document document;
    private String fileName;
     public void init() {
          try {
               DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
               DocumentBuilder builder = factory.newDocumentBuilder();
               this.document = builder.newDocument();
          } catch (ParserConfigurationException e) {
               System.out.println(e.getMessage());
          }
     }
     public void createXml(String fileName) {
          Element root = this.document.createElement("employees");
          this.document.appendChild(root);

          Element employee = this.document.createElement("employee");

          Element name = this.document.createElement("name");
          name.appendChild(this.document.createTextNode("丁宏亮"));
          employee.appendChild(name);

          Element sex = this.document.createElement("sex");
          sex.appendChild(this.document.createTextNode("m"));
          employee.appendChild(sex);

          Element age = this.document.createElement("age");
          age.appendChild(this.document.createTextNode("30"));
          employee.appendChild(age);

          root.appendChild(employee);

          TransformerFactory tf = TransformerFactory.newInstance();
          try {
               Transformer transformer = tf.newTransformer();
               DOMSource source = new DOMSource(document);
               transformer.setOutputProperty(OutputKeys.ENCODING, "gb2312");
               transformer.setOutputProperty(OutputKeys.INDENT, "yes");

               PrintWriter pw = new PrintWriter(new FileOutputStream(fileName));
               StreamResult result = new StreamResult(pw);

               transformer.transform(source, result);
               System.out.println("生成XML文件成功!");
          } catch (TransformerConfigurationException e) {
               System.out.println(e.getMessage());
          } catch (IllegalArgumentException e) {
               System.out.println(e.getMessage());
          } catch (FileNotFoundException e) {
               System.out.println(e.getMessage());
          } catch (TransformerException e) {
               System.out.println(e.getMessage());
          }
     }
     public void parserXml(String fileName) {
          try {
               DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
               DocumentBuilder db = dbf.newDocumentBuilder();
               Document document = db.parse(fileName);
               NodeList employees = document.getChildNodes();
               for (int i = 0; i < employees.getLength(); i++) {
                    Node employee = employees.item(i);
                    NodeList employeeInfo = employee.getChildNodes();
                    for (int j = 0; j < employeeInfo.getLength(); j++) {
                         Node node = employeeInfo.item(j);
                         NodeList employeeMeta = node.getChildNodes();
                         for (int k = 0; k < employeeMeta.getLength(); k++) {
                              System.out.println(employeeMeta.item(k).getNodeName()
                                        + ":" + employeeMeta.item(k).getTextContent());
                         }
                    }
               }
               System.out.println("解析完毕");
          } catch (FileNotFoundException e) {
               System.out.println(e.getMessage());
          } catch (ParserConfigurationException e) {
               System.out.println(e.getMessage());
          } catch (SAXException e) {
               System.out.println(e.getMessage());
          } catch (IOException e) {
               System.out.println(e.getMessage());
          }
     }
}

2. SAX生成和解析XML文档

　　为解决DOM的问题，出现了SAX。SAX ，事件驱动。当解析器发现元素开始、元素结束、文本、文档的开始或结束等时，发送事件，程序员编写响应这些事件的代码，保存数据。

　　优点：不用事先调入整个文档，占用资源少；SAX解析器代码比DOM解析器代码小，适于Applet，下载。

　　缺点：不是持久的；事件过后，若没保存数据，那么数据就丢了；无状态性；从事件中只能得到文本，但不知该文本属于哪个元素；

　　使用场合：Applet;只需XML文档的少量内容，很少回头访问；机器内存少；

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
/**
* @author zhengwei
* SAX文档解析
*/
public class SaxDemo implements XmlDocument {
     public void createXml(String fileName) {
          System.out.println("<<"+filename+">>");
     }

     public void parserXml(String fileName) {
          SAXParserFactory saxfac = SAXParserFactory.newInstance();
          try {
               SAXParser saxparser = saxfac.newSAXParser();
               InputStream is = new FileInputStream(fileName);
               saxparser.parse(is, new MySAXHandler());
          } catch (ParserConfigurationException e) {
               e.printStackTrace();
          } catch (SAXException e) {
               e.printStackTrace();
          } catch (FileNotFoundException e) {
               e.printStackTrace();
          } catch (IOException e) {
               e.printStackTrace();
          }
     }
}  

class MySAXHandler extends DefaultHandler {
     boolean hasAttribute = false;
     Attributes attributes = null;
     public void startDocument() throws SAXException {
          System.out.println("文档开始打印了");
     }

     public void endDocument() throws SAXException {
          System.out.println("文档打印结束了");
     }

     public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
          if (qName.equals("employees")) {
               return;
          }
          if (qName.equals("employee")) {
               System.out.println(qName);
          }
          if (attributes.getLength() > 0) {
               this.attributes = attributes;
               this.hasAttribute = true;
          }
     }  

     public void endElement(String uri, String localName, String qName) throws SAXException {
          if (hasAttribute && (attributes != null)) {
               for (int i = 0; i < attributes.getLength(); i++) {
                    System.out.println(attributes.getQName(0)  + attributes.getValue(0));
               }
          }
     }  

     public void characters(char[] ch, int start, int length) throws SAXException {
          System.out.println(new String(ch, start, length));
     }
}

3. DOM4J生成和解析XML文档

　　DOM4J 是一个非常非常优秀的Java XML API，具有性能优异、功能强大和极端易用使用的特点，同时它也是一个开放源代码的软件。如今你可以看到越来越多的 Java 软件都在使用 DOM4J 来读写 XML，特别值得一提的是连 Sun 的 JAXM 也在用 DOM4J。

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.Iterator;  

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;
/**
* @author zhengwei
* Dom4j 生成XML文档与解析XML文档
*/
public class Dom4jDemo implements XmlDocument {
     public void createXml(String fileName) {
          Document document = DocumentHelper.createDocument();
          Element employees=document.addElement("employees");
          Element employee=employees.addElement("employee");
          Element name= employee.addElement("name");
          name.setText("ddvip");
          Element sex=employee.addElement("sex");
          sex.setText("m");
          Element age=employee.addElement("age");
          age.setText("29");
          try {
               Writer fileWriter=new FileWriter(fileName);
               XMLWriter xmlWriter=new XMLWriter(fileWriter);
               xmlWriter.write(document);
               xmlWriter.close();
          } catch (IOException e) {
               System.out.println(e.getMessage());
          }
     }

     public void parserXml(String fileName) {
          File inputXml=new File(fileName);
          SAXReader saxReader = new SAXReader();
          try {
               Document document = saxReader.read(inputXml);
               Element employees=document.getRootElement();
               for(Iterator i = employees.elementIterator(); i.hasNext();){
                    Element employee = (Element) i.next();
                    for(Iterator j = employee.elementIterator(); j.hasNext();){
                         Element node=(Element) j.next();
                         System.out.println(node.getName()+":"+node.getText());
                    }
               }
          } catch (DocumentException e) {
               System.out.println(e.getMessage());
          }
          System.out.println("dom4j parserXml");
     }
}

4. JDOM生成和解析XML

　　为减少DOM、SAX的编码量，出现了JDOM；

　　优点：20-80原则，极大减少了代码量。

　　使用场合：要实现的功能简单，如解析、创建等，但在底层，JDOM还是使用SAX（最常用）、DOM、Xanan文档。

import java.io.FileNotFoundException; 

import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;
import org.jdom.Document;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.input.SAXBuilder;
import org.jdom.output.XMLOutputter;  

/**
* @author zhengwei
* JDOM 生成与解析XML文档
*/
public class JDomDemo implements XmlDocument {
     public void createXml(String fileName) {
          Document document;
          Element  root;
          root=new Element("employees");
          document=new Document(root);
          Element employee=new Element("employee");
          root.addContent(employee);
          Element name=new Element("name");
          name.setText("ddvip");
          employee.addContent(name);
          Element sex=new Element("sex");
          sex.setText("m");
          employee.addContent(sex);
          Element age=new Element("age");
          age.setText("23");
          employee.addContent(age);
          XMLOutputter XMLOut = new XMLOutputter();
          try {
               XMLOut.output(document, new FileOutputStream(fileName));
          } catch (FileNotFoundException e) {
               e.printStackTrace();
          } catch (IOException e) {
               e.printStackTrace();
          }
     }

public void parserXml(String fileName) {
          SAXBuilder builder=new SAXBuilder(false);
          try {
               Document document=builder.build(fileName);

          Element employees=document.getRootElement();
               List employeeList=employees.getChildren("employee");

               for(int i=0;i<EMPLOYEELIST.SIZE();I++){

                   iElement employee=(Element)employeeList.get(i);

                   List employeeInfo=employee.getChildren();

                       for(int j=0;j<EMPLOYEEINFO.SIZE();J++){

                           System.out.println(((Element)employeeInfo.get(j)).getName()+":"

                                                                +((Element)employeeInfo.get(j)).getValue())

                       }
               }
          } catch (JDOMException e) {
               e.printStackTrace();
          } catch (IOException e) {
               e.printStackTrace();
          }
     }
}

5.使用 dom4j 解析 XML

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

　　dom4j API 包含一个解析 XML 文档的工具。本文中将使用这个解析器创建一个示例 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 XMLSchema"))
                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 文档的非验证性工具，可以与JAXP、Crimson 或 Xerces 集成。本文说明了如何使用该解析器创建和修改 XML 文档。