SAXP解析XML的笔记

 

SAXP 使用streaming 读取xml ，基于事件触发和回调函数处理xml 内容，占用内存小，速度快，适用于1 ）仅仅读取但是不改变xml 内容 2 ）只处理内容一次，类似于在xml 中查找相关内容。

创建Factory

解析xml 过程。首先需要创建factory ，factory 是用来创建parser 的，包含一些创建parser 的属性。

view source print ?

1	SAXParserFactory spfactory = SAXParserFactory.newInstance(); // 得到一个实例

view source print ?

1	spfactory.setSchema(schema);// setSchema 会使用schema 生成一个validator 来对被处理想xml 先进性验证，然后再发到handler 去处理

view source print ?

1	spfactory.setValidating(false);// 是否验证xml 文件，这个验证是DTD 验证，默认为false

view source print ?

1	spfactory.setNamespaceAware(false);//
2	这个对于handler 处理是有影响的，默认是false 。如果是true ，则parser 会首先处理xml 的prefix ，找到与之对应的namespace ，然后作为参数传给handler 。否则namspace 就是空。

 

3	spfactory.setXIncludeAware(false);// 是否要处理xml 中的XInclude 节点，默认是false

还有一个可扩展的方法叫做setFeatures 。顾名思义，就是定制由这个factory 生成的parser 的功能。

比如下面这行代码：

view source print ?

1	saxfac.setFeature("http://xml.org/sax/features/namespace-prefixes ",
2	true);

当setNamespaceAware=true 的时候，handler 默认将得不到xmlns 这些namespace 相关的属性。这个在大多数情 况下有道理，因为namespace 已经被parser 解析好了，handler 已经知道每个节点的namespace 了。但是如果还是需要完整的 attribute ，就比较抓狂了——debug 可以看到但是实际上已经被滤掉了。这时候需要设置了这个feature 之后才能得到。

创建parser

设置好相应的属性之后，就可以使用这个factory 的实例创建parser 了。

SAXParser saxParser = spfactory.newSAXParser();// 根据factory 的设置，创建一个saxpparser

有了parser ，可以设置不同的handler 来处理xml 。使用parser.getXMLReader() 得到一个XMLReader 。

用的最多的就是ContentHandler 。ContentHandler 是一个接口。创建出这个接口实现的实例后，可以将它设到parser 中，parser 在解析xml 的过程中，会根据事件来回调ContentHandler 中相应的方法。

view source print ?

1	xmlReader.setContentHandler(contentHandler);

除此之外还有setEntityResolver(EntityResolver) ， setDTDHandler(DTDHandler) 和setErrorHandler(ErrorHandler) 。这几个从来没有用过=_= 。有用过的人没？求usecase 。。。

ContentHandler 中相应的方法

ContentHandler 是处理xml 文档最重要的类。其中的方法会在特定的事件发生时候被触发。

view source print ?

01	startDocument(); // 此事件在开始解析文档的时候触发
02

 

03	endDocument(); // 此事件在文档解析结束后触发
04

 

05	startPrefixMapping(String prefix, String uri); // 此事件只有在setNamespaceAware 为true 的时候才会被触发。每次遇到xmlns 属性后都会触发一次。prefix 为去掉xmlns 之后的内容，uri 就是这个前缀对应的namespace 。所以，如果想在setNamespaceAware 为true 的时候还得到这 些attribute ，除了setFeature 之外，也可以处理这个事件，保存相应的prefix-uri mapping
06

 

07	endPrefixMapping(String prefix); // 此事件在包含xmlns attribute 的节点结束之后被触发。对于wsdl 来说，就是在触发了wsdl:definitions 的endElement 之后触发。
08

 

09	startElement(String uri, String localName, String qName, Attributes atts); // 在一个node 开始的时候触发。如果setNamespaceAware 为true ，那么uri 的值就会被resolve ，否则就会是空。 localName 则是节点的名字，比如对于wsdl:definitions 来说，就是definitions 。qName 就是node 的全名，比如 wsdl:definitions 。atts 就是这个node 的所有属性。但是这时候会没有xmlns 的属性。如果setNamespaceAware 为 false ，那么就不对uri 解析。uri 就是空，localName 也是空，qName 就是xs:sequence 这种节点的名字。atts 则会返回节 点所有属性的k-v mapping 。
10

 

11	endElement(String uri, String localName, String qName); // 在节点处理完毕后触发。参数值与startElement 意义相同。
12

 

13	characters(char ch[], int start, int length); // 在node 的开始结束之前如果有字符，则会触发此事件。比如 <nodeA>some character</nodeA> 。在startElement nodeA 之后，endElement nodeA 之前，会调用characters 方法，用new String(ch, start, length) 创建出来的字符串就是"some character" 。这个方法需要注意的一点是，如果节点中的内容有多行，那么这个方法有可能会被调用多次。也就是可能会（没有验证过）每一行都调用一 次characters 。还有需要注意的一点是，创建出来的字符串已经包含了回车换行
14

 

15	ignorableWhitespace(char[], int, int); // 文档说Receive notification of ignorable whitespace in element content. 具体啥意思没试过。好像和validator 有关。求解答。。。
16

 

17	processingInstruction(String target, String data); // 当xml 有PI 的时候被触发。但是xml 最开始的PI 不会触发，就是那个<?xml version="1.0" encoding="UTF-8"?> ，是不会触发此事件的。除此之外，xml 里的PI 都会被处理。比如<?testpi key1="value1" key2="value2"?> 就会被触发两次，target 都是testpi ，data 两次分别是key1="value1" 和 key2="value2" 。
18

 

19	skippedEntity(String); // 文档说Receive notification of a skipped entity. 不知道啥意思，求解答。。。
20

 

21

setDocumentLocator (Locator locator); // 这个方法也很有用，parser 会在处理文档之前调用此方法。如果你需要知道当前处理到文档的第几行第几列，就需要实现这个方法。实现不需要做什么处理， 只要在自己的ContentHandler 里创建一个Locator 类型的成员变量，用这个成员变量保存传进来的参数，然后记得调用 super.setDocumentLocator 。parser 会实时更新Locator 中的变量值。通过Locator 的getLineNumber 和getColumnNumber 可以得到当前处理的行和列。还有publicID ，systemID ，不知道是做啥用的。

基本上这些内容就够解析xml 用的了。

顺道问问题

除了文章中说的几个不清楚之外，还有个问题一直想知道答案。SAXP 处理xml ，一般处理一点就找到要找的东西了，下面一大半xml 就不用处理了， 那有没有什么办法让parser 终止继续处理？做个boolean 标记，parser 总归还是要把xml 走一遍的，如果xml 很大，或者是远程的xml ， 那么就会比较有用了。

在stackoverflow 上找到了解答 http://stackoverflow.com/questions/2964315/java-sax-parser-how-to-manually-break-parsing

简单来说就是在处理完毕，确定不需要继续处理的时候，直接抛个异常。。。