Sax解析xml_动力节点Java学院整理

java 解析 xml 通常有两种方式，dom 和 sax。dom 虽然是 w3c 的标准，提供了标准的解析方式，但它的解析效率一直不尽如人意，因为使用dom解析xml时，解析器读入整个文档并构建一个驻留内存的树结构（节点树），然后您的代码才可以使用 dom 的标准接口来操作这个树结构。但大部分情况下我们只对文档的部分内容感兴趣，根本就不用先解析整个文档，并且从节点树的根节点来索引一些我们需要的数据也是非常耗时的。 

sax是一种xml解析的替代方法。相比于文档对象模型dom，sax 是读取和操作 xml 数据的更快速、更轻量的方法。sax 允许您在读取文档时处理它，从而不必等待整个文档被存储之后才采取操作。它不涉及 dom 所必需的开销和概念跳跃。 sax api是一个基于事件的api ，适用于处理数据流，即随着数据的流动而依次处理数据。sax api 在其解析您的文档时发生一定事件的时候会通知您。在您对其响应时，您不作保存的数据将会 被抛弃。

下面是一个sax解析xml的示例（有点长，因为详细注解了sax事件处理的所有方法），sax api中主要有四种处理事件的接口，它们分别是contenthandler，dtdhandler， entityresolver 和 errorhandler 。下面的例子可能有点冗长，实际上只要继承defaulthandler 类 ，再覆盖一部分 处理事件的方法 同样可以达到这个示例的效果，但为了纵观全局，还是看看sax api里面所有主要的事件解析方法吧。（ 实际上defaulthandler就是实现了上面的四个事件处理器接口，然后提供了每个抽象方法的默认实现。） 

1，contenthandler 接口 ：接收文档逻辑内容的通知 的处理器接口。

import org.xml.sax.attributes; 
import org.xml.sax.contenthandler; 
import org.xml.sax.locator; 
import org.xml.sax.saxexception; 
 
class mycontenthandler implements contenthandler{ 
 stringbuffer jsonstringbuffer ; 
 int frontblankcount = 0; 
 public mycontenthandler(){ 
  jsonstringbuffer = new stringbuffer(); 
 } 
 /* 
  * 接收字符数据的通知。 
  * 在dom中 ch[begin:end] 相当于text节点的节点值（nodevalue） 
  */ 
 @override 
 public void characters(char[] ch, int begin, int length) throws saxexception { 
  stringbuffer buffer = new stringbuffer(); 
  for(int i = begin ; i < begin+length ; i++){ 
   switch(ch[i]){ 
    case '\\':buffer.append("\\\\");break; 
    case '\r':buffer.append("\\r");break; 
    case '\n':buffer.append("\\n");break; 
    case '\t':buffer.append("\\t");break; 
    case '\"':buffer.append("\\\"");break; 
    default : buffer.append(ch[i]); 
   } 
  } 
  system.out.println(this.toblankstring(this.frontblankcount)+ 
    ">>> characters("+length+"): "+buffertostring()); 
 } 
 
  
 /* 
  * 接收文档的结尾的通知。 
  */ 
 @override 
 public void enddocument() throws saxexception { 
  system.out.println(this.toblankstring(--this.frontblankcount)+ 
    ">>> end document"); 
 } 
 
  
 /* 
  * 接收文档的结尾的通知。 
  * 参数意义如下： 
  * uri ：元素的命名空间 
  * localname ：元素的本地名称（不带前缀） 
  * qname ：元素的限定名（带前缀） 
  * 
  */ 
 @override 
 public void endelement(string uri,string localname,string qname) 
   throws saxexception { 
  system.out.println(this.toblankstring(--this.frontblankcount)+ 
    ">>> end element : "+qname+"("+uri+")"); 
 } 
 
 /* 
  * 结束前缀 uri 范围的映射。 
  */ 
 @override 
 public void endprefixmapping(string prefix) throws saxexception { 
  system.out.println(this.toblankstring(--this.frontblankcount)+ 
    ">>> end prefix_mapping : "+prefix); 
 } 
 
 /* 
  * 接收元素内容中可忽略的空白的通知。 
  * 参数意义如下： 
  *  ch : 来自 xml 文档的字符 
  *  start : 数组中的开始位置 
  *  length : 从数组中读取的字符的个数 
  */ 
 @override 
 public void ignorablewhitespace(char[] ch, int begin, int length) 
   throws saxexception { 
  stringbuffer buffer = new stringbuffer(); 
  for(int i = begin ; i < begin+length ; i++){ 
   switch(ch[i]){ 
    case '\\':bufferappend("\\\\");break; 
    case '\r':bufferappend("\\r");break; 
    case '\n':bufferappend("\\n");break; 
    case '\t':bufferappend("\\t");break; 
    case '\"':bufferappend("\\\"");break; 
    default : bufferappend(ch[i]); 
   } 
  } 
  system.out.println(this.toblankstring(this.frontblankcount)+">>> ignorable whitespace("+length+"): "+buffer.tostring()); 
 } 
  
 /* 
  * 接收处理指令的通知。 
  * 参数意义如下： 
  *  target : 处理指令目标 
  *  data : 处理指令数据，如果未提供，则为 null。 
  */ 
 @override 
 public void processinginstruction(string target,string data) 
   throws saxexception { 
  system.out.println(this.toblankstring(this.frontblankcount)+">>> process instruction : (target = \"" 
    +target+"\",data = \""+data+"\")"); 
 } 
 
 /* 
  * 接收用来查找 sax 文档事件起源的对象。 
  * 参数意义如下： 
  *  locator : 可以返回任何 sax 文档事件位置的对象 
  */ 
 @override 
 public void setdocumentlocator(locator locator) { 
  system.out.println(this.toblankstring(this.frontblankcount)+ 
    ">>> set document_locator : (linenumber = "+locatorgetlinenumber() 
    +",columnnumber = "+locatorgetcolumnnumber() 
    +",systemid = "+locatorgetsystemid() 
    +",publicid = "+locatorgetpublicid()+")"); 
   
 } 
 
 /* 
  * 接收跳过的实体的通知。 
  * 参数意义如下： 
  *  name : 所跳过的实体的名称。如果它是参数实体，则名称将以 '%' 开头， 
  *   如果它是外部 dtd 子集，则将是字符串 "[dtd]" 
  */ 
 @override 
 public void skippedentity(string name) throws saxexception { 
  system.out.println(this.toblankstring(this.frontblankcount)+ 
    ">>> skipped_entity : "+name); 
 } 
 
 /* 
  * 接收文档的开始的通知。 
  */ 
 @override 
 public void startdocument() throws saxexception { 
  system.out.println(this.toblankstring(this.frontblankcount++)+ 
    ">>> start document "); 
 } 
 
 /* 
  * 接收元素开始的通知。 
  * 参数意义如下： 
  * uri ：元素的命名空间 
  * localname ：元素的本地名称（不带前缀） 
  * qname ：元素的限定名（带前缀） 
  * atts ：元素的属性集合 
  */ 
 @override 
 public void startelement(string uri, string localname, string qname, 
   attributes atts) throws saxexception { 
  system.out.println(this.toblankstring(this.frontblankcount++)+ 
    ">>> start element : "+qname+"("+uri+")"); 
 } 
  
 /* 
  * 开始前缀 uri 名称空间范围映射。 
  * 此事件的信息对于常规的命名空间处理并非必需： 
  * 当 http://xmlorg/sax/features/namespaces 功能为 true（默认）时， 
  * sax xml 读取器将自动替换元素和属性名称的前缀。 
  * 参数意义如下： 
  * prefix ：前缀 
  * uri ：命名空间 
  */ 
 @override 
 public void startprefixmapping(string prefix,string uri) 
   throws saxexception { 
  system.out.println(this.toblankstring(this.frontblankcount++)+ 
    ">>> start prefix_mapping : xmlns:"+prefix+" = " 
    +"\""+uri+"\""); 
   
 } 
  
 private string toblankstring(int count){ 
  stringbuffer buffer = new stringbuffer(); 
  for(int i = 0;i<count;i++) 
   buffer.append(" "); 
  return buffer.tostring(); 
 } 
  
} 

2，dtdhandler 接口 ：接收与 dtd 相关的事件的通知的处理器接口。

import org.xml.sax.dtdhandler; 
import org.xml.sax.saxexception; 
 
public class mydtdhandler implements dtdhandler { 
 
 /* 
  * 接收注释声明事件的通知。 
  * 参数意义如下： 
  *  name - 注释名称。 
  *  publicid - 注释的公共标识符，如果未提供，则为 null。 
  *  systemid - 注释的系统标识符，如果未提供，则为 null。 
  */ 
 @override 
 public void notationdecl(string name, string publicid, string systemid) 
   throws saxexception { 
  systemoutprintln(">>> notation declare : (name = "+name 
    +",systemid = "+publicid 
    +",publicid = "+systemid+")"); 
 } 
 
 /* 
  * 接收未解析的实体声明事件的通知。 
  * 参数意义如下： 
  *  name - 未解析的实体的名称。 
  *  publicid - 实体的公共标识符，如果未提供，则为 null。 
  *  systemid - 实体的系统标识符。 
  *  notationname - 相关注释的名称。 
  */ 
 @override 
 public void unparsedentitydecl(string name, 
   string publicid, 
   string systemid, 
   string notationname) throws saxexception { 
  systemoutprintln(">>> unparsed entity declare : (name = "+name 
    +",systemid = "+publicid 
    +",publicid = "+systemid 
    +",notationname = "+notationname+")"); 
 } 
 
} 

3，entityresolver 接口 ：是用于解析实体的基本接口。

import java.io.ioexception; 
 
import org.xml.sax.entityresolver; 
import org.xml.sax.inputsource; 
import org.xml.sax.saxexception; 
 
public class myentityresolver implements entityresolver { 
 
 /* 
  * 允许应用程序解析外部实体。 
  * 解析器将在打开任何外部实体（*文档实体除外）前调用此方法 
  * 参数意义如下： 
  *  publicid ： 被引用的外部实体的公共标识符，如果未提供，则为 null。 
  *  systemid ： 被引用的外部实体的系统标识符。 
  * 返回： 
  *  一个描述新输入源的 inputsource 对象，或者返回 null， 
  *  以请求解析器打开到系统标识符的常规 uri 连接。 
  */ 
 @override 
 public inputsource resolveentity(string publicid, string systemid) 
   throws saxexception, ioexception { 
  return null; 
 } 
 
} 

4，errorhandler接口 ：是错误处理程序的基本接口。

import org.xml.sax.errorhandler; 
import org.xml.sax.saxexception; 
import org.xml.sax.saxparseexception; 
 
public class myerrorhandler implements errorhandler { 
 
 /* 
  * 接收可恢复的错误的通知 
  */ 
 @override 
 public void error(saxparseexception e) throws saxexception { 
  system.err.println("error ("+e.getlinenumber()+"," 
    +e.getcolumnnumber()+") : "+e.getmessage()); 
 } 
  
 /* 
  * 接收不可恢复的错误的通知。 
  */ 
 @override 
 public void fatalerror(saxparseexception e) throws saxexception { 
  system.err.println("fatalerror ("+e.getlinenumber()+"," 
    +e.getcolumnnumber()+") : "+e.getmessage()); 
 } 
 
 /* 
  * 接收不可恢复的错误的通知。 
  */ 
 @override 
 public void warning(saxparseexception e) throws saxexception { 
  system.err.println("warning ("+e.getlinenumber()+"," 
    +e.getcolumnnumber()+") : "+e.getmessage()); 
 } 
 
} 

test 类的主方法打印解析books.xml时的事件信息。

import java.io.filenotfoundexception; 
import java.io.filereader; 
import java.io.ioexception; 
 
import org.xml.sax.contenthandler; 
import org.xml.sax.dtdhandler; 
import org.xml.sax.entityresolver; 
import org.xml.sax.errorhandler; 
import org.xml.sax.inputsource; 
import org.xml.sax.saxexception; 
import org.xml.sax.xmlreader; 
import org.xml.sax.helpers.xmlreaderfactory; 
 
 
public class test { 
 
 public static void main(string[] args) throws saxexception, 
   filenotfoundexception, ioexception { 
  //创建处理文档内容相关事件的处理器 
  contenthandler contenthandler = new mycontenthandler(); 
  //创建处理错误事件处理器 
  errorhandler errorhandler = new myerrorhandler(); 
  //创建处理dtd相关事件的处理器 
  dtdhandler dtdhandler = new mydtdhandler(); 
  //创建实体解析器 
  entityresolver entityresolver = new myentityresolver(); 
   
  //创建一个xml解析器（通过sax方式读取解析xml） 
  xmlreader reader = xmlreaderfactory.createxmlreader(); 
  /* 
   * 设置解析器的相关特性 
   *  http://xml.org/sax/features/validation = true 表示开启验证特性 
   *  http://xml.org/sax/features/namespaces = true 表示开启命名空间特性 
   */ 
  reader.setfeature("http://xml.org/sax/features/validation",true); 
  reader.setfeature("http://xml.org/sax/features/namespaces",true); 
  //设置xml解析器的处理文档内容相关事件的处理器 
  reader.setcontenthandler(contenthandler); 
  //设置xml解析器的处理错误事件处理器 
  reader.seterrorhandler(errorhandler); 
  //设置xml解析器的处理dtd相关事件的处理器 
  reader.setdtdhandler(dtdhandler); 
  //设置xml解析器的实体解析器 
  reader.setentityresolver(entityresolver); 
  //解析books.xml文档 
  reader.parse(new inputsource(new filereader("books.xml"))); 
 } 
 
} 

books.xml 文件的内容如下：

<?xml version="1.0" encoding="gb2312"?> 
<books count="3" xmlns="http://testorg/books"> 
 <!--books's comment--> 
 <book id="1"> 
  <name>thinking in java</name> 
 </book> 
 <book id="2"> 
  <name>core java2</name> 
 </book> 
 <book id="3"> 
  <name>c++ primer</name> 
 </book> 
</books> 

控制台输出如下：

>>> set document_locator : (linenumber = 1,columnnumber = 1,systemid = null,publicid = null)
>>> start document 
error (2,7) : document is invalid: no grammar found.
error (2,7) : document root element "books", must match doctype root "null".
 >>> start prefix_mapping : xmlns: = "http://test.org/books"
  >>> start element : books(http://test.org/books)
   >>> characters(2): \n\t
   >>> characters(2): \n\t
   >>> start element : book(http://test.org/books)
    >>> characters(3): \n\t\t
    >>> start element : name(http://test.org/books)
     >>> characters(16): thinking in java
    >>> end element : name(http://test.org/books)
    >>> characters(2): \n\t
   >>> end element : book(http://test.org/books)
   >>> characters(2): \n\t
   >>> start element : book(http://test.org/books)
    >>> characters(3): \n\t\t
    >>> start element : name(http://test.org/books)
     >>> characters(10): core java2
    >>> end element : name(http://test.org/books)
    >>> characters(2): \n\t
   >>> end element : book(http://test.org/books)
   >>> characters(2): \n\t
   >>> start element : book(http://test.org/books)
    >>> characters(3): \n\t\t
    >>> start element : name(http://test.org/books)
     >>> characters(10): c++ primer
    >>> end element : name(http://test.org/books)
    >>> characters(2): \n\t
   >>> end element : book(http://test.org/books)
   >>> characters(1): \n
  >>> end element : books(http://test.org/books)
 >>> end prefix_mapping : 
>>> end document