用libxml2操作xml文档的例子

1   创建xml文档

有了上面的基础，创建一个xml文档显得非常简单，其流程如下：

l         用xmlNewDoc函数创建一个文档指针doc；

l         用xmlNewNode函数创建一个节点指针root_node；

l         用xmlDocSetRootElement将root_node设置为doc的根结点；

l         给root_node添加一系列的子节点，并设置子节点的内容和属性；

l         用xmlSaveFile将xml文档存入文件；

l         用xmlFreeDoc函数关闭文档指针，并清除本文档中所有节点动态申请的内存。

注意，有多种方式可以添加子节点：第一是用xmlNewTextChild直接添加一个文本子节点；第二是先创建新节点，然后用xmlAddChild将新节点加入上层节点。

源代码文件是CreateXmlFile.cpp，如下：

/********************************************************************

    created:   2007/11/09

    created:   9:11:2007   15:34

    filename: CreateXmlFile.cpp

    author:       Wang xuebin

    depend:       libxml2.lib

    build:     nmake TARGET_NAME=CreateXmlFile

    purpose:   创建一个xml文件

*********************************************************************/

#include <stdio.h>

#include <libxml/parser.h>

#include <libxml/tree.h>

#include <iostream.h>

int main()

{

    //定义文档和节点指针

    xmlDocPtr doc = xmlNewDoc(BAD_CAST"1.0");

    xmlNodePtr root_node = xmlNewNode(NULL,BAD_CAST"root");

    //设置根节点

    xmlDocSetRootElement(doc,root_node);

    //在根节点中直接创建节点

    xmlNewTextChild(root_node, NULL, BAD_CAST "newNode1", BAD_CAST "newNode1 content");

    xmlNewTextChild(root_node, NULL, BAD_CAST "newNode2", BAD_CAST "newNode2 content");

    xmlNewTextChild(root_node, NULL, BAD_CAST "newNode3", BAD_CAST "newNode3 content");

    //创建一个节点，设置其内容和属性，然后加入根结点

    xmlNodePtr node = xmlNewNode(NULL,BAD_CAST"node2");

    xmlNodePtr content = xmlNewText(BAD_CAST"NODE CONTENT");

    xmlAddChild(root_node,node);

    xmlAddChild(node,content);

    xmlNewProp(node,BAD_CAST"attribute",BAD_CAST "yes");

    //创建一个儿子和孙子节点

    node = xmlNewNode(NULL, BAD_CAST "son");

    xmlAddChild(root_node,node);

    xmlNodePtr grandson = xmlNewNode(NULL, BAD_CAST "grandson");

    xmlAddChild(node,grandson);

    xmlAddChild(grandson, xmlNewText(BAD_CAST "This is a grandson node"));

    //存储xml文档

    int nRel = xmlSaveFile("CreatedXml.xml",doc);

    if (nRel != -1)

    {

       cout<<"一个xml文档被创建,写入"<<nRel<<"个字节"<<endl;

    }

    //释放文档内节点动态申请的内存

    xmlFreeDoc(doc);

    return 1;

}

编译链接命令如下：

nmake TARGET_NAME=CreateXmlFile

然后执行可执行文件CreateXmlFile.exe，会生成一个xml文件CreatedXml.xml，打开后如下所示：

<?xml version="1.0"?>

<root>

    <newNode1>newNode1 content</newNode1>

    <newNode2>newNode2 content</newNode2>

    <newNode3>newNode3 content</newNode3>

    <node2 attribute="yes">NODE CONTENT</node2>

    <son>

       <grandson>This is a grandson node</grandson>

    </son>

</root>

最好使用类似XMLSPY这样的工具打开，因为这些工具可以自动整理xml文件的栅格，否则很有可能是没有任何换行的一个xml文件，可读性较差。

2   解析xml文档

解析一个xml文档，从中取出想要的信息，例如节点中包含的文字，或者某个节点的属性，其流程如下：

l         用xmlReadFile函数读出一个文档指针doc；

l         用xmlDocGetRootElement函数得到根节点curNode；

l         curNode->xmlChildrenNode就是根节点的子节点集合；

l         轮询子节点集合，找到所需的节点，用xmlNodeGetContent取出其内容；

l         用xmlHasProp查找含有某个属性的节点；

l         取出该节点的属性集合，用xmlGetProp取出其属性值；

l         用xmlFreeDoc函数关闭文档指针，并清除本文档中所有节点动态申请的内存。

注意：节点列表的指针依然是xmlNodePtr，属性列表的指针也是xmlAttrPtr，并没有xmlNodeList或者xmlAttrList这样的类型。看作列表的时候使用它们的next和prev链表指针来进行轮询。只有在Xpath中有xmlNodeSet这种类型，其使用方法前面已经介绍了。

源代码如下：ParseXmlFile.cpp

/********************************************************************

    created:   2007/11/15

    created:   15:11:2007   11:47

    filename: ParseXmlFile.cpp

    author:       Wang xuebin

    depend:       libxml2.lib

    build:     nmake TARGET_NAME=ParseXmlFile

    purpose:   解析xml文件

*********************************************************************/

#include <libxml/parser.h>

#include <iostream.h>

int main(int argc, char* argv[])

{

    xmlDocPtr doc;           //定义解析文档指针

    xmlNodePtr curNode;      //定义结点指针(你需要它为了在各个结点间移动)

    xmlChar *szKey;          //临时字符串变量

    char *szDocName;

    if (argc <= 1) 

    {

       printf("Usage: %s docname"n", argv[0]);

       return(0);

    }

    szDocName = argv[1];

    doc = xmlReadFile(szDocName,"GB2312",XML_PARSE_RECOVER); //解析文件

    //检查解析文档是否成功，如果不成功，libxml将指一个注册的错误并停止。

    //一个常见错误是不适当的编码。XML标准文档除了用UTF-8或UTF-16外还可用其它编码保存。

    //如果文档是这样，libxml将自动地为你转换到UTF-8。更多关于XML编码信息包含在XML标准中.

    if (NULL == doc)

    {  

       fprintf(stderr,"Document not parsed successfully. "n");    

       return -1;

    }

    curNode = xmlDocGetRootElement(doc); //确定文档根元素

    /*检查确认当前文档中包含内容*/

    if (NULL == curNode)

    {

       fprintf(stderr,"empty document"n");

       xmlFreeDoc(doc);

       return -1;

    }

    /*在这个例子中，我们需要确认文档是正确的类型。“root”是在这个示例中使用文档的根类型。*/

    if (xmlStrcmp(curNode->name, BAD_CAST "root"))

    {

       fprintf(stderr,"document of the wrong type, root node != root");

       xmlFreeDoc(doc);

       return -1;

    }

    curNode = curNode->xmlChildrenNode;

    xmlNodePtr propNodePtr = curNode;

    while(curNode != NULL)

    {

       //取出节点中的内容

       if ((!xmlStrcmp(curNode->name, (const xmlChar *)"newNode1")))

       {

           szKey = xmlNodeGetContent(curNode);

           printf("newNode1: %s"n", szKey);

           xmlFree(szKey);

       }

       //查找带有属性attribute的节点

       if (xmlHasProp(curNode,BAD_CAST "attribute"))

       {

           propNodePtr = curNode;

       }

       curNode = curNode->next;

    }

    //查找属性

    xmlAttrPtr attrPtr = propNodePtr->properties;

    while (attrPtr != NULL)

    {

       if (!xmlStrcmp(attrPtr->name, BAD_CAST "attribute"))

       {

           xmlChar* szAttr = xmlGetProp(propNodePtr,BAD_CAST "attribute");

           cout<<"get attribute = "<<szAttr<<endl;

           xmlFree(szAttr);

       }

       attrPtr = attrPtr->next;

    }

    xmlFreeDoc(doc);

    return 0;

}

编译链接命令如下：

nmake TARGET_NAME=ParseXmlFile

执行命令如下，使用第一次创建的xml文件作为输入：

ParseXmlFile.exe CreatedXml.xml

观察源代码可发现，所有以查询方式得到的xmlChar*字符串都必须使用xmlFree函数手动释放。否则会造成内存泄漏。

3   修改xml文档

有了上面的基础，修改xml文档的内容就很简单了。首先打开一个已经存在的xml文档，顺着根结点找到需要添加、删除、修改的地方，调用相应的xml函数对节点进行增、删、改操作。源代码见ChangeXmlFile，编译链接方法如上。执行下面的命令：

ChangeXmlFile.exe CreatedXml.xml

可以得到一个修改后的xml文档ChangedXml.xml，如下：

<?xml version="1.0"?>

<root>

    <newNode2>content changed</newNode2>

    <newNode3 newAttr="YES">newNode3 content</newNode3>

    <node2 attribute="no">NODE CONTENT</node2>

    <son>

       <grandson>This is a grandson node</grandson>

       <newGrandSon>new content</newGrandSon>

    </son>

</root>

需要注意的是，并没有xmlDelNode或者xmlRemoveNode函数，我们删除节点使用的是以下一段代码：

       if (!xmlStrcmp(curNode->name, BAD_CAST "newNode1"))

       {

           xmlNodePtr tempNode;

           tempNode = curNode->next;

           xmlUnlinkNode(curNode);

           xmlFreeNode(curNode);

           curNode = tempNode;

           continue;

       }

即将当前节点从文档中断链（unlink），这样本文档就不会再包含这个子节点。这样做需要使用一个临时变量来存储断链节点的后续节点，并记得要手动删除断链节点的内存。

4   使用XPATH查找xml文档

简而言之，XPATH之于xml，好比SQL之于关系数据库。要在一个复杂的xml文档中查找所需的信息，XPATH简直是必不可少的工具。XPATH语法简单易学，并且有一个很好的官方教程，见http://www.zvon.org/xxl/XPathTutorial/Output_chi/introduction.html。这个站点的XML各种教程齐全，并且有包括中文在内的各国语言版本，真是让我喜欢到非常！

使用XPATH之前，必须首先熟悉几个数据类型和函数，它们是使用XPATH的前提。在libxml2中使用Xpath是非常简单的，其流程如下：

l         定义一个XPATH上下文指针xmlXPathContextPtr context，并且使用xmlXPathNewContext函数来初始化这个指针；

l         定义一个XPATH对象指针xmlXPathObjectPtr result，并且使用xmlXPathEvalExpression函数来计算Xpath表达式，得到查询结果，将结果存入对象指针中；

l         使用result->nodesetval得到节点集合指针，其中包含了所有符合Xpath查询结果的节点；

l         使用xmlXPathFreeContext释放上下文指针；

l         使用xmlXPathFreeObject释放Xpath对象指针；

具体的使用方法可以看XpathForXmlFile.cpp的这一段代码，其功能是查找符合某个Xpath语句的对象指针：

xmlXPathObjectPtr getNodeSet(xmlDocPtr doc, const xmlChar *szXpath)

{

    xmlXPathContextPtr context;    //XPATH上下文指针

    xmlXPathObjectPtr result;       //XPATH对象指针，用来存储查询结果

    context = xmlXPathNewContext(doc);     //创建一个XPath上下文指针

    if (context == NULL)

    {  

       printf("context is NULL"n");

       return NULL;

    }

    result = xmlXPathEvalExpression(szXpath, context); //查询XPath表达式，得到一个查询结果

    xmlXPathFreeContext(context);             //释放上下文指针

    if (result == NULL)

    {

       printf("xmlXPathEvalExpression return NULL"n");

       return NULL; 

    }

    if (xmlXPathNodeSetIsEmpty(result->nodesetval))   //检查查询结果是否为空

    {

       xmlXPathFreeObject(result);

       printf("nodeset is empty"n");

       return NULL;

    }

    return result;   

}

一个完整的使用Xpath的例子在代码XpathForXmlFile.cpp中，它查找一个xml文件中符合"/root/node2[@attribute='yes']"语句的结果，并且将找到的节点的属性和内容打印出来。编译链接命令如下：

nmake TARGET_NAME=XpathForXmlFile

执行方式如下：

XpathForXmlFile.exe CreatedXml.xml

观察结果可以看出找到了一个节点，即root下面node2节点，它的attribute属性值正好等于yes。更多关于Xpath的内容可以参考XPATH官方手册。只有掌握了XPATH，才掌握了使用大型XML文件的方法，否则每寻找一个节点都要从根节点找起，会把人累死。