DOM4j介绍

      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. 

     

它的主要接口都在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 表达式

 

这些接口所在的包结构如下：

interface java.lang. Cloneable

• 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.dom4j.DocumentType
    
  • interface org.dom4j.Entity
    
  • interface org.dom4j.ProcessingInstruction

 

为了容易叙述，现在我用Dom4j创建如下格式的XML：

< sqls >
< sql  id ="insertProduct" >
  INSERT INTO product VALUES ('Sony Ericsson P990i') 
</ sql >
< sql  id ="queryProduct" >
   <![CDATA[  SELECT title FROM product WHERE id=? AND insert_date > ? ]]>
</ sql >
</ sqls >

 

创建代码如下：

package  com.myyate.test.dom4j;

import  java.io.BufferedWriter;
import  java.io.File;
import  java.io.FileWriter;
import  java.io.Writer;

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

public   class  SqlCreator  ... {

    public SqlCreator() ...{
    document = DocumentHelper.createDocument();
    }
    
    public void createSqlXmlFile(Writer xmlOut) throws Exception ...{
    Element root = document.addElement("sqls");
    
    Element sqlEle = DocumentHelper.createElement("sql");
    sqlEle.addAttribute("id", "insertProduct");
    sqlEle.setText("INSERT INTO product VALUES ('Sony Ericsson P990i')");
    root.add(sqlEle);
    
    sqlEle = DocumentHelper.createElement("sql");
    sqlEle.addAttribute("id", "queryProduct");
    CDATA sqlStr = 
        DocumentHelper.createCDATA("SELECT title FROM product WHERE id=? AND insert_date > ?");
    sqlEle.add(sqlStr);
    root.add(sqlEle);
    //添加文档类型说明
    //document.addDocType("sqls", "myyate", "*.dtd");    //name publicId systemId
    //输出文档,并格式化输出
    XMLWriter out = new XMLWriter(xmlOut, OutputFormat.createPrettyPrint());
    out.write(document);
    out.close();
    }
    
    static Writer getOutWriter() throws Exception ...{
    File outFile = new File("E:/project/designpattern/src/com/myyate/test/dom4j/sqls.xml");
    if(!outFile.exists()) ...{
        outFile.createNewFile();
    }
    
    return new FileWriter(outFile);
    }
    
    public static void main(String[] args) throws Exception ...{
    SqlCreator sqlCreator = new SqlCreator();
    Writer xmlOut = new BufferedWriter(getOutWriter());
    sqlCreator.createSqlXmlFile(xmlOut);
    }
    private Document document;
}

 

使用dom4j读取xml的代码如下：

package  com.myyate.test.dom4j;

import  java.io.InputStream;
import  java.util.HashMap;
import  java.util.List;
import  java.util.Map;

import  org.dom4j.Document;
import  org.dom4j.Element;
import  org.dom4j.io.SAXReader;

public   class  SqlReader  ... {

    public SqlReader() throws Exception ...{
    read();
    }

    public Map<String, String> parseSqlXmlFile() throws Exception ...{
    Map<String, String> result = new HashMap<String, String>();

    List nodes = document.selectNodes("//sql");
    if (nodes != null && !nodes.isEmpty()) ...{
        for (Object obj : nodes) ...{
        Element sqlEle = (Element) obj;
        String id = sqlEle.attributeValue("id");
        String text = sqlEle.getText();
        result.put(id, text);
        }
    }

    return result;
    }

    private void read() throws Exception ...{
    SAXReader saxReader = new SAXReader();
    InputStream in = getClass().getResourceAsStream("sqls.xml");
    saxReader.setValidation(false);
    document = saxReader.read(in);
    }

    public static void main(String[] args) throws Exception ...{
    SqlReader sqlReader = new SqlReader();
    System.out.println(sqlReader.parseSqlXmlFile());
    }

    private Document document;
}

 

这儿用xpath访问节点，要用到jaxen包，更多XPath访问的方式请看：XPath语法