SAXP解析XML的笔记
SAXP使用streaming读取xml,基于事件触发和回调函数处理xml内容,占用内存小,速度快,适用于1)仅仅读取但是不改变xml内容 2)只处理内容一次,类似于在xml中查找相关内容。
创建Factory
解析xml过程。首先需要创建factory,factory是用来创建parser的,包含一些创建parser的属性。
SAXParserFactory spfactory = SAXParserFactory.newInstance(); // 得到一个实例
spfactory.setSchema(schema);// setSchema会使用schema生成一个validator来对被处理想xml先进性验证,然后再发到handler去处理
spfactory.setValidating(false);// 是否验证xml文件,这个验证是DTD验证,默认为false
spfactory.setNamespaceAware(false);// 这个对于handler处理是有影响的,默认是false。如果是true,则parser会首先处理xml的prefix,找到与之对应的namespace,然后作为参数传给handler。否则namspace就是空。 spfactory.setXIncludeAware(false);//是否要处理xml中的XInclude节点,默认是false
还有一个可扩展的方法叫做setFeatures。顾名思义,就是定制由这个factory生成的parser的功能。
比如下面这行代码:
saxfac.setFeature("http://xml.org/sax/features/namespace-prefixes", 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中相应的方法。
xmlReader.setContentHandler(contentHandler);
除此之外还有setEntityResolver(EntityResolver), setDTDHandler(DTDHandler)和setErrorHandler(ErrorHandler)。这几个从来没有用过=_=。有用过的人没?求usecase。。。
ContentHandler中相应的方法
ContentHandler是处理xml文档最重要的类。其中的方法会在特定的事件发生时候被触发。
startDocument(); // 此事件在开始解析文档的时候触发 endDocument(); // 此事件在文档解析结束后触发 startPrefixMapping(String prefix, String uri); // 此事件只有在setNamespaceAware为true的时候才会被触发。每次遇到xmlns属性后都会触发一次。prefix 为去掉xmlns之后的内容,uri就是这个前缀对应的namespace。所以,如果想在setNamespaceAware为true的时候还得到这些attribute,除了setFeature之外,也可以处理这个事件,保存相应的prefix-uri mapping endPrefixMapping(String prefix); //此事件在包含xmlns attribute的节点结束之后被触发。对于wsdl来说,就是在触发了wsdl:definitions的endElement之后触发。 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。 endElement(String uri, String localName, String qName); //在节点处理完毕后触发。参数值与startElement意义相同。 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。还有需要注意的一点是,创建出来的字符串已经包含了回车换行 ignorableWhitespace(char[], int, int); // 文档说Receive notification of ignorable whitespace in element content. 具体啥意思没试过。好像和validator有关。求解答。。。 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"。 skippedEntity(String); // 文档说Receive notification of a skipped entity. 不知道啥意思,求解答。。。 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
简单来说就是在处理完毕,确定不需要继续处理的时候,直接抛个异常。。。