tinyxml
本文转自：朱金灿
源博客地址：http://blog.csdn.net/clever101
对于xml文件，目前我的工作只是集中在配置文件和作为简单的信息文件来用，因此我不太喜欢使用msxml这种重量级的xml解析器，特别是使用msxml解析xml涉及到复杂的com类型转换，更是令人感觉繁琐。因此对于简单的xml文件的解析，我更愿意使用开源的tinyxml。
首先介绍一下TinyXml吧。TinyXML是目前非常流行的一款基于DOM模型的XML解析器，简单易用且小巧玲珑，非常适合存储简单数据，配置文件，对象序列化等数据量不是很大的操作，其主页是：http://www.grinninglizard.com/tinyxml/ ，目前最新版本是2.5.3 版本。
TinyXml网上的教程很多，但是我觉得写得都不怎样（感觉就是看完之后就没学会）。没办法，只得自己整理一篇适合自己的，至于适不适合别人，就见仁见智了。我感觉xml文件本质就是小型的数据库，换个角度来说就是，你对数据库有什么操作你对xml文件就应能实现什么操作。一般而言，对数据库的操作包括以下几种：新建数据库、查询数据库、修改数据库和删除数据库。那么对应xml文件就是新建xml文件、查询xml文件的指定节点的值，修改xml文件中节点的值和删除xml文件中节点的值。
首先我们认识一下xml文件有哪几种形式。下面我列出一些常用的xml文件的形式：
example1.xml:
<?xml version="1.0" ?>
<Hello>World</Hello>
example2.xml:
<?xml version="1.0" ?>
<poetry>
<verse>
Alas
Great World
Alas (again)
</verse>
</poetry>
example3.xml:
<?xml version="1.0" ?>
<shapes>
<circle name="int-based" x="20" y="30" r="50" />
<point name="float-based" x="3.5" y="52.1" />
</shapes>
example4.xml:
<?xml version="1.0" ?>
<MyAPP>
<messages>
<Welcome>Welcome to MyApp</Welcome>
<Farewell>Thank you for using MyApp</Farewell>
</Messages>
<windows>
<Window name="mainframe" x="5" y="15" w="400" h="250" />
</Windows>
<Connection ip="192.168.0.1" timeout="123.456000" />
</MyApp>
上面的例子摘自《TinyXML Tutorial 中文指南》。上面有四个例子，你看到了xml文件的几种表现形式？我看到了本质来说不过是两种表现形式：属性值值在尖括号内，如<Window name="MainFrame" x="5" y="15" w="400" h="250" />和文本在尖括号外，如<Welcome>Welcome to MyApp</Welcome>。
鉴于example4.xml比较复杂，下面我将以此为例介绍tinyxml的使用。
Tinyxml使用了两种编译选择：使用标准C的char *类型或者使用STL中的std::string,其中使用预处理器TIXML_USE_STL进行控制，即添加了TIXML_USE_STL为使用std::string的。鉴于STL的广泛使用以及其强大功能，下面我以使用std::string的tinyxml说明。
首先使用VS 2005打开tinyxmlSTL.dsp的工程文件，将其编译成一个静态库，debug版本为：tinyxmld_STL.lib，然后开始测试tinyxml库。我的测试计划是这样的：首先使用tinyxml库创建example4.xml，然后将其读出来，然后查询指定节点的属性或文本，再修改example4.xml（修改其中的一些节点值和删除其中一个节点，增加一个节点），然后再读出来以判断是否修改成功。具体是在VS 2005上新建一个控制台工程：Test，注意使用多字节字符集进行编译，同时添加。首先是创建xml文件的代码：
/*!
* /brief 创建xml文件。
*
* /param XmlFile xml文件全路径。
* /return 是否成功。true为成功，false表示失败。
*/
bool CreateXml(std::string XmlFile)
{
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument;
if (NULL==pDoc)
{
return false;
}
TiXmlDeclaration *pDeclaration = new TiXmlDeclaration(_T("1.0"),_T(""),_T(""));
if (NULL==pDeclaration)
{
return false;
}
pDoc->linkendChild(pDeclaration);
// 生成一个根节点：MyApp
TiXmlElement *pRootEle = new TiXmlElement(_T("MyApp"));
if (NULL==pRootEle)
{
return false;
}
pDoc->LinkEndChild(pRootEle);
// 生成子节点：Messages
TiXmlElement *pMsg = new TiXmlElement(_T("Messages"));
if (NULL==pMsg)
{
return false;
}
pRootEle->LinkEndChild(pMsg);
// 生成子节点：Welcome
TiXmlElement *pWelcome = new TiXmlElement(_T("Welcome"));
if (NULL==pWelcome)
{
return false;
}
pMsg->LinkEndChild(pWelcome);
// 设置Welcome节点的值
std::string strValue = _T("Welcome to MyApp");
TiXmlText *pWelcomeValue = new TiXmlText(strValue);
pWelcome->LinkEndChild(pWelcomeValue);
// 生成子节点：Farewell
TiXmlElement *pFarewell = new TiXmlElement(_T("Farewell"));
if (NULL==pFarewell)
{
return false;
}
pMsg->LinkEndChild(pFarewell);
// 设置Farewell节点的值
strValue = _T("Thank you for using MyApp");
TiXmlText *pFarewellValue = new TiXmlText(strValue);
pFarewell->LinkEndChild(pFarewellValue);
// 生成子节点：Windows
TiXmlElement *pWindows = new TiXmlElement(_T("Windows"));
if (NULL==pWindows)
{
return false;
}
pRootEle->LinkEndChild(pWindows);
// 生成子节点：Window
TiXmlElement *pWindow = new TiXmlElement(_T("Window"));
if (NULL==pWindow)
{
return false;
}
pWindows->LinkEndChild(pWindow);
// 设置节点Window的值
pWindow->SetAttribute(_T("name"),_T("MainFrame"));
pWindow->SetAttribute(_T("x"),_T("5"));
pWindow->SetAttribute(_T("y"),_T("15"));
pWindow->SetAttribute(_T("w"),_T("400"));
pWindow->SetAttribute(_T("h"),_T("250"));
// 生成子节点：Window
TiXmlElement *pConnection = new TiXmlElement(_T("Connection"));
if (NULL==pConnection)
{
return false;
}
pRootEle->LinkEndChild(pConnection);
// 设置节点Connection的值
pConnection->SetAttribute(_T("ip"),_T("192.168.0.1"));
pConnection->SetAttribute(_T("timeout"),_T("123.456000"));
pDoc->SaveFile(XmlFile);
return true;
}
不知你注意到上面的规律没有？首先父节点连接字节点使用函数LinkEndChild，使用方法是：pparentNode-> LinkEndChild(pChild);其次设置类似这种结构<Window name="MainFrame" x="5" y="15" w="400" h="250" />采用SetAttribute函数，这个函数有两个参数，前一个参数表示键，后一个参数表示键值，设置<Farewell>Thank you for using MyApp</Farewell>这种结构采用TiXmlText类，使用LinkEndChild函数进行连结。
上面是创建xml文件的代码，下面介绍读取xml文件的代码。打印整个xml文件的代码很简单，代码如下：
/*!
* /brief 打印xml文件。
*
* /param XmlFile xml文件全路径。
* /return 是否成功。true为成功，false表示失败。
*/
bool PaintXml(std::string XmlFile)
{
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
pDoc->print();
return true;
}
首先是获取xml文件声明。xml文件声明包括三方面的内容：Version、standalone和Encoding。其源码如下：
/*!
* /brief 获取xml文件的声明。
*
* /param XmlFile xml文件全路径。
* /param strVersion Version属性值
* /param strStandalone Standalone属性值
* /param strEncoding Encoding属性值
* /return 是否成功。true为成功，false表示失败。
*/
bool GetXmlDeclare(std::string XmlFile,
std::string &strVersion,
std::string &strStandalone,
std::string &strEncoding)
{
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
TiXmlNode* pXmlFirst = pDoc->FirstChild();
if (NULL != pXmlFirst)
{
TiXmlDeclaration* pXmlDec = pXmlFirst->ToDeclaration();
if (NULL != pXmlDec)
{
strVersion = pXmlDec->Version();
strStandalone = pXmlDec->Standalone();
strEncoding = pXmlDec->Encoding();
}
}
return true;
}
我们发现无论查询节点、删除节点、修改节点和增加节点，其实都离不开一个函数，就是根据节点名获取相关节点指针。那么我们就先实现一个根据节点名获取节点指针的函数：
/*!
* /brief 通过根节点和节点名获取节点指针。
*
* /param pRootEle xml文件的根节点。
* /param strNodeName 要查询的节点名
* /param Node 需要查询的节点指针
* /return 是否找到。true为找到相应节点指针，false表示没有找到相应节点指针。
*/
bool GetNodePointerByName(TiXmlElement* pRootEle,std::string &strNodeName,TiXmlElement* &Node)
{
// 假如等于根节点名，就退出
if (strNodeName==pRootEle->Value())
{
Node = pRootEle;
return true;
}
TiXmlElement* pEle = pRootEle;
for (pEle = pRootEle->FirstChildElement(); pEle; pEle = pEle->nextsiblingElement())
{
//递归处理子节点，获取节点指针
if(GetNodePointerByName(pEle,strNodeName,Node))
return true;
}
return false;
}
有了这个函数，我们就很容易实现查询节点的相应文本或属性值。
/*!
* /brief 通过节点查询。
*
* /param XmlFile xml文件全路径。
* /param strNodeName 要查询的节点名
* /param strText 要查询的节点文本
* /return 是否成功。true为成功，false表示失败。
*/
bool QueryNode_Text(std::string XmlFile,std::string strNodeName,std::string &strText)
{
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
TiXmlElement *pRootEle = pDoc->RootElement();
if (NULL==pRootEle)
{
return false;
}
TiXmlElement *pNode = NULL;
GetNodePointerByName(pRootEle,strNodeName,pNode);
if (NULL!=pNode)
{
strText = pNode->GetText();
return true;
}
else
{
return false;
}
}
/*!
* /brief 通过节点查询。
*
* /param XmlFile xml文件全路径。
* /param strNodeName 要查询的节点名
* /param AttMap 要查询的属性值，这是一个map，前一个为属性名，后一个为属性值
* /return 是否成功。true为成功，false表示失败。
*/
bool QueryNode_Attribute(std::string XmlFile,std::string strNodeName,std::map<std::string,std::string> &AttMap)
{
// 定义一个TiXmlDocument类指针
typedef std::pair <std::string,std::string> String_Pair;
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
TiXmlElement *pRootEle = pDoc->RootElement();
if (NULL==pRootEle)
{
return false;
}
TiXmlElement *pNode = NULL;
GetNodePointerByName(pRootEle,strNodeName,pNode);
if (NULL!=pNode)
{
TiXmlAttribute* pAttr = NULL;
for (pAttr = pNode->FirstAttribute(); pAttr; pAttr = pAttr->Next())
{
std::string strAttName = pAttr->Name();
std::string strAttValue = pAttr->Value();
AttMap.insert(String_Pair(strAttName,strAttValue));
}
return true;
}
else
{
return false;
}
return true;
}
下面是删除指定节点的函数，其中考虑了删除根节点的情况:
/*!
* /brief 删除指定节点的值。
*
* /param XmlFile xml文件全路径。
* /param strNodeName 指定的节点名。
* /return 是否成功。true为成功，false表示失败。
*/
bool DelNode(std::string XmlFile,std::string strNodeName)
{
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
TiXmlElement *pRootEle = pDoc->RootElement();
if (NULL==pRootEle)
{
return false;
}
TiXmlElement *pNode = NULL;
GetNodePointerByName(pRootEle,strNodeName,pNode);
// 假如是根节点
if (pRootEle==pNode)
{
if(pDoc->RemoveChild(pRootEle))
{
pDoc->SaveFile(XmlFile);
return true;
}
else
return false;
}
// 假如是其它节点
if (NULL!=pNode)
{
TiXmlNode *pParNode = pNode->Parent();
if (NULL==pParNode)
{
return false;
}
TiXmlElement* pParentEle = pParNode->ToElement();
if (NULL!=pParentEle)
{
if(pParentEle->RemoveChild(pNode))
pDoc->SaveFile(XmlFile);
else
return false;
}
}
else
{
return false;
}
return false;
}
修改节点其实和查询指定节点的值有点类似，也分为两个函数，一个实现修改文本。另一个负责修改属性。
/*!
* /brief 修改指定节点的文本。
*
* /param XmlFile xml文件全路径。
* /param strNodeName 指定的节点名。
* /param strText 重新设定的文本的值
* /return 是否成功。true为成功，false表示失败。
*/
bool ModifyNode_Text(std::string XmlFile,std::string strNodeName,std::string strText)
{
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
TiXmlElement *pRootEle = pDoc->RootElement();
if (NULL==pRootEle)
{
return false;
}
TiXmlElement *pNode = NULL;
GetNodePointerByName(pRootEle,strNodeName,pNode);
if (NULL!=pNode)
{
pNode->Clear(); // 首先清除所有文本
// 然后插入文本，保存文件
TiXmlText *pValue = new TiXmlText(strText);
pNode->LinkEndChild(pValue);
pDoc->SaveFile(XmlFile);
return true;
}
else
return false;
}
/*!
* /brief 修改指定节点的属性值。
*
* /param XmlFile xml文件全路径。
* /param strNodeName 指定的节点名。
* /param AttMap 重新设定的属性值，这是一个map，前一个为属性名，后一个为属性值
* /return 是否成功。true为成功，false表示失败。
*/
bool ModifyNode_Attribute(std::string XmlFile,std::string strNodeName,
std::map<std::string,std::string> &AttMap)
{
typedef std::pair <std::string,std::string> String_Pair;
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
TiXmlElement *pRootEle = pDoc->RootElement();
if (NULL==pRootEle)
{
return false;
}
TiXmlElement *pNode = NULL;
GetNodePointerByName(pRootEle,strNodeName,pNode);
if (NULL!=pNode)
{
TiXmlAttribute* pAttr = NULL;
std::string strAttName = _T("");
std::string strAttValue = _T("");
for (pAttr = pNode->FirstAttribute(); pAttr; pAttr = pAttr->Next())
{
strAttName = pAttr->Name();
std::map<std::string,std::string>::iterator iter;
for (iter=AttMap.begin();iter!=AttMap.end();iter++)
{
if (strAttName==iter->first)
{
pAttr->SetValue(iter->second);
}
}
}
pDoc->SaveFile(XmlFile);
return true;
}
else
{
return false;
}
}
对于ModifyNode_Attribute函数，这里稍微介绍一下如何使用，比如对于下面这样一个xml文件：
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<MyApp>
<Messages>
<Welcome>Welcome to MyApp</Welcome>
<Farewell>Thank you for using MyApp</Farewell>
</Messages>
<Windows>
<Window name="MainFrame" x="5" y="15" w="400" h="250" />
</Windows>
<Connection ip="192.168.0.1" timeout="123.456000" />
</MyApp>
我们如果要修改节点的Connection的ip为192.168.0.100，timeout为1000，我们可以这样用：
std::string XmlFile = _T("E://TestTinyxml//example4.xml");
std::string strNodeName = _T("Connection");
typedef std::pair <std::string,std::string> String_Pair;
std::map<std::string,std::string> AttMap;
AttMap.insert(String_Pair(_T("ip"),_T("192.168.0.100")));
AttMap.insert(String_Pair(_T("timeout"),_T("1000")));
ModifyNode_Attribute(XmlFile,strNodeName,AttMap);
下面是增加节点的两个函数：
/*!
* /brief 增加指定节点的文本。
*
* /param XmlFile xml文件全路径。
* /param strParNodeName 要增加的节点的父节点。
* /param strNodeName 指定的节点名。
* /param strText 要增加的文本
* /return 是否成功。true为成功，false表示失败。
*/
bool AddNode_Text(std::string XmlFile,std::string strParNodeName,std::string strNodeName,std::string strText)
{
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
TiXmlElement *pRootEle = pDoc->RootElement();
if (NULL==pRootEle)
{
return false;
}
TiXmlElement *pNode = NULL;
GetNodePointerByName(pRootEle,strParNodeName,pNode);
if (NULL!=pNode)
{
// 生成子节点：pNewNode
TiXmlElement *pNewNode = new TiXmlElement(strNodeName);
if (NULL==pNewNode)
{
return false;
}
// 设置节点文本，然后插入节点
TiXmlText *pNewValue = new TiXmlText(strText);
pNewNode->LinkEndChild(pNewValue);
pNode->InsertEndChild(*pNewNode);
pDoc->SaveFile(XmlFile);
return true;
}
else
return false;
}
/*!
* /brief 增加节点。
*
* /param XmlFile xml文件全路径。
* /param strParNodeName 要增加的节点的父节点。
* /param strNodeName 指定的节点名。
* /param AttMap 要增加的节点设定的属性值，这是一个map，前一个为属性名，后一个为属性值
* /return 是否成功。true为成功，false表示失败。
*/
bool AddNode_Attribute(std::string XmlFile,std::string strParNodeName,std::string strNodeName,std::map<std::string,std::string> &AttMap)
{
// 定义一个TiXmlDocument类指针
TiXmlDocument *pDoc = new TiXmlDocument();
if (NULL==pDoc)
{
return false;
}
pDoc->LoadFile(XmlFile);
TiXmlElement *pRootEle = pDoc->RootElement();
if (NULL==pRootEle)
{
return false;
}
TiXmlElement *pNode = NULL;
GetNodePointerByName(pRootEle,strParNodeName,pNode);
if (NULL!=pNode)
{
// 生成子节点：pNewNode
TiXmlElement *pNewNode = new TiXmlElement(strNodeName);
if (NULL==pNewNode)
{
return false;
}
// 设置节点的属性值，然后插入节点
std::map<std::string,std::string>::iterator iter;
for (iter=AttMap.begin();iter!=AttMap.end();iter++)
{
pNewNode->SetAttribute(iter->first,iter->second);
}
pNode->InsertEndChild(*pNewNode);
pDoc->SaveFile(XmlFile);
return true;
}
else
return false;
}
至此tinyxml入门文章全部完成，相关源码下载请访问：
Tinyxml库及测试源码下载