XML解析之——使用dom4j解析XML

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

2、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>

清单 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>

3、 这个解析器可以从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 接口。

4、创建文档

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

使用 import 语句导入 dom4j API 类：

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

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

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

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

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

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

向article元素中添加journal元素。

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

向article元素中增加title元素。

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

在article元素中增加author元素。

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

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

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

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

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

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

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

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

package dom4j;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;

import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.io.XMLWriter;

public class XmlDom4J{
	public void generateDocument(){
		
	     //使用 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","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){
	    	 e.printStackTrace();
	      }
	}
	
	public static void main(String[] args){
		
		XmlDom4J dom4j=new XmlDom4J();
		dom4j.generateDocument();
		
	}

}

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

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

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

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

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

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

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

package dom4j;

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

import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;

public class Dom4JParser{
	 @SuppressWarnings("unchecked")
	 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"));
     }
}