关于开源的XML Parser expat的介绍和使用心得

转自：http://blog.csdn.net/exclusivepig/article/details/4566252

expat是使用C所写的XML解释器，采用流的方式来解析XML文件，并且基于事件通知型来调用分析到的数据，并不需要把所有XML文件全部加载到内存里，这样可以分析非常大的XML文件。由于expat库是由XML的主要负责人James Clark来实现的，因此它是符合W3C的XML标准的。

---------------------------以上为转载-------------------------------------

正因为源码全部是纯C所写，因此，非常容易移植，尤其是适用于嵌入式平台，我在往联芯的手机平台上移植时，几乎没改任何东西。

不过，优点也带来了缺点，因为是采用流的方式解析XML，所以不会像TinyXML那样在一块内存中生成基于DOM的树。

虽然这样解析起来略显麻烦，但是基于回调的机制，在我看来还是蛮方便的。

下面就说使用方法：

首先是用XML_ParserCreate(const XML_Char *encodingName)，参数一般为NULL，函数返回一个XML_Parser类型指针，我们就当他是一个句柄吧，类似于Windows里的内核对象，一般需要保存在一个全局的指针里。

 

然后调用XML_SetElementHandler(XML_Parser parser, 
                                                  XML_StartElementHandler start, 
                                                  XML_EndElementHandler end)

 

         第一个参数是那个Parser句柄，第二个和第三个参数则是整个Parser的核心，类型为CallBack的函数，不了解CallBack函数的，我在这里简单说下，函数调用一般分为两种，一种是主调，即编写代码者，自己调用的函数，还一种成为Callback函数，编码者写好，但他自己却不主动调用，而是在某些条件下（编码者并不清楚具体时间和流程），由其他函数调用，比如简单的，如设备驱动，操作系统提供了一组某个设备的函数指针，比如LCD屏驱动，由一组画点，画线，画块等函数组成，当更换LCD时，只需要把操作系统开放的函数指针，指向你提供的接口即可，操作系统再需要时，会自动调用你的驱动函数，这就是回调函数一个典型的例子。

       这二个回调分别是对应于解析<>和</>， 下面分别详细介绍这个2个回调函数。

       typedef void (XMLCALL *XML_StartElementHandler) (void *userData, 
                                                 const XML_Char *name, 
                                                 const XML_Char **atts);

       其中第一个参数userData, 可以由函数XML_SetUserData(XML_Parser parser, void *p)设置，参数就不用说了吧？

       后面两个参数，我用个具体的列子说明下，这样更好理解：

       比如有个标准XML，某个标签属性如下：

       <feed version="2.0" ctxt-id="9212" template-id="default" feed-type="ftti">

       那么StartElementHandler回调返回的name就是标签"feed", **atts是一个指针数组，分别指向标签的一组属性，atts[0]就是"version", atts[1]就是"2.0", 以此类推。应该很清楚了吧？呵呵。

       这时候必然有个对应的</feed>，

       typedef void (XMLCALL *XML_EndElementHandler) (void *userData, 
                                               const XML_Char *name);

       就是处理标签结束的，name就是"feed”了，这个回调一般是用户设置自己的状态机的。

       最后一个函数就是XML_SetCharacterDataHandler(XML_Parser parser,XML_CharacterDataHandlerhandler)

       这个函数是设置处理一个<>和</>之间的字段的回调。

       回调原型如下：

       typedef void (XMLCALL *XML_CharacterDataHandler) (void *userData, 
                                                  const XML_Char *s, 
                                                  int len);

       其中第二个参数是一块Buffer的指针，如果你单步DEBUG后，你会发现expat用的就是你传入的那块Buffer(这块Buffer下面讲解），比如：

       <title>天气</title>
       <summary>28日08时至29日08时，陕西中南部、山西西南部、河南中南部、湖北北部、四川中东部、重庆西部和北部、贵州西部等地的部分地区有大雨或暴雨，河南南部、湖北北部等地局部有大暴雨。【点击“更多”查询其他城市天气】</summary>

       假设目前解析到天气这个charData, 如果你看那个指针的所有内容的话，实际上是这样的：

       天气</title>
       <summary>28日08时至29日08时，陕西中南部、山西西南部、河南中南部、湖北北部、四川中东部、重庆西部和北部、贵州西部等地的部分地区有大雨或暴雨，河南南部、湖北北部等地局部有大暴雨。【点击“更多”查询其他城市天气】</summary>

       所有要根据第三个参数len来确定正确的数据。

       但这里有个非常隐晦的问题，如果不知道的话，会带来很大麻烦，下面说。

       最后就是parse，调用

       XML_Parse(XML_Parser parser, const char *s, int len, int isFinal)

       第二个参数是用户指定的Buffer指针， 第三个是这块Buffer中实际内容的字节数，最后参数代表是否这块Buffer已经结束。比如要解析的XML文件太大，但内存比较吃紧，Buffer比较小，则可以循环读取文件，然后丢给Parser，  在文件读取结束前，isFinal参数为FALSE，反之为TRUE。

      这里的Buffer如果太小则会造成上面提到那个隐晦的问题，

      XML_CharacterDataHandler一次返回的可能并不是完整的CharData,比如这个charData的Len大于你的Buffer大小，那这是会连续调用2次XML_CharacterDataHandler,我们需要将2次结果拼接起来，以得到正确结果，因此我们的状态机一定要考虑到这点。

      顺便说下XML_ParserReset(XML_Parser parser, const XML_Char *encodingName)函数，在某些时候，如果你不确定前后2次XML是否一样的情况下，比如网络上投递的XML，在一次解析后最好调用一次本函数，否则会出现意料之外的结果。比如前后两次XML完全一样，可这你并不知情，那么XML_Parse（）会返回失败。

      好了，开源的XML解析器expat就讲到这，下次说开源的SQL数据库sqlite3的移植和使用心得。