简单的一个汇总。(时间关系没有做整理,供自己在阅读相关源码时可以直接【ctrl + f 】查一下相关变量和函数的大致功能与意义)
先附上各转载原文地址:
http://sblig.iteye.com/blog/814323
https://www.cnblogs.com/Anker/p/3542058.html
http://blog.csdn.net/u012398362/article/details/49835453
l xmlChar 替代char,使用UTF-8编码的一字节字符串
l xmlDoc 包含由解析文档建立的树结构,xmlDocPtr是指向这个结构的指针。
l xmlNodePtr 和 xmlNode 包含单一结点的结构,xmlNodePtr是指向这个结构的指针,它被用于遍历文档树。
--------------------------------------------------------------------------------------------------
l xmlDocPtr doc; //定义文档指针
l doc = xmlNewDoc ("1.0"); //以version = 1.0建立文档
l doc = xmlParseFile(docname); //解析文档,给文档指针赋值
l doc = xmlReadFile(docname,"GB2312",XML_PARSE_RECOVER); //以GB2312编码解析文档
l xmlFreeDoc(doc); //释放解析文档时获取到的内存
l int nRel = xmlSaveFile("-",doc); //将文档以默认方式存入一个文件。
l xmlSaveFormatFile (docname, doc, 1); //保存文件到磁盘,第一个参数是写入文件的名,第二个参数是一个xmlDoc结构指针,第三个参数设定为1,保证在输出上写入。
l xmlSaveFormatFileEnc("-", doc, encoding, 1);//将文档以某种编码/格式存入一个文件中。
--------------------------------------------------------------------------------------------------
l xmlNodePtr cur; //定义结点指针
l xmlDocSetRootElement(doc, rootnode);
l cur = xmlDocGetRootElement(doc); //获取文档根结点
l cur = cur->xmlChildrenNode; //获取结点的子结点
l while (cur != NULL) {
……
cur = cur->next;
}
l xmlChar *key;
key = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1); //获取文本结点的文本,需用其子结点
l xmlFree(key); //释放xmlNodeListGetString为其返回的字符串分配的内存
l xmlNewTextChild (cur, NULL, "keyword", "123"); //为当前节点添加一个新的子元素文本结点<keyword>123</keyword>,其中NULL是命名空间
l rootnode = xmlNewDocNode(doc, NULL, (const xmlChar*)"root", out);
l rootnode = xmlNewNode(NULL, (const xmlChar*)"root");
l xmlNodePtr content = xmlNewText((xmlChar *)"NODE CONTENT"); //注意不是xmlNewTextChild()
l xmlAddChild(root_node,node);//为root_node添加子结点node
l xmlNewChild(root_node, NULL, (xmlChar *) "node1",(xmlChar *) szOut);//为root_node添加子结点node1
l xmlNodeSetContent(curNode, (xmlChar *) "content changed");
l mlUnlinkNode(curNode); //将当前节点从文档中断链(unlink),这样本文档就不会再包含这个子节点
l xmlFreeNode(curNode); //手动删除断链节点的内存, 若没有xmlDelNode或者xmlRemoveNode,使用此函数
--------------------------------------------------------------------------------------------------
l xmlAttrPtr newattr;
newattr = xmlNewProp (newnode, "uri", "123"); //为结点newnode添加属性uri,属性值为123
l if (xmlHasProp(curNode,(xmlChar *)"attribute")) //判断结点curNode是否具有属性attribute
l xmlAttrPtr attrPtr = propNodePtr->properties; //属性集是链表
l xmlChar *uri;
uri = xmlGetProp(cur, "uri"); //获取属性值
xmlFree(uri); //释放内存
l xmlSetProp(curNode,BAD_(xmlChar *)"attribute", (xmlChar *) "no"); //设置当前结点的attribute属性的属性值为no
--------------------------------------------------------------------------------------------------
l xmlXPathContextPtr context;
l context = xmlXPathNewContext(doc); //获取context指针
l xmlXPathObjectPtr result;
l result = xmlXPathEvalExpression(xmlChar *xpath, context); //根据条件xpath以及context来进行查询,条件格式:xmlChar *szXpath =(xmlChar *) ("/root/node2[@attribute='yes']");
l xmlXPathFreeContext(context); //释放context内存
l if(xmlXPathNodeSetIsEmpty(result->nodesetval)) //判断查询后的结果是否为空
l xmlNodeSetPtr nodeset; //创建节点集指针
l nodeset = result->nodesetval; //这个结点集对象包含在集合中的元素数目(nodeNr)及一个结点数组(nodeTab)。
l for (i=0; i < nodeset->nodeNr; i++)
l keyword = xmlNodeListGetString(doc, nodeset->nodeTab[i]->xmlChildrenNode, 1)
l xmlXPathFreeObject (result); //释放内存
l xmlCleanupParser();
--------------------------------------------------------------------------------------------------
l xmlMalloc是动态分配内存的函数;xmlFree是配套的释放内存函数;xmlStrcmp是字符串比较函数;
l 基本上xmlChar字符串相关函数都在xmlstring.h中定义;而动态内存分配函数在xmlmemory.h中定义。
l xml2-config –cflags //取得预处理和编译标志
l xml2-config –libs //取得链接标志
1.创建文件时常用的函数及其作用
创建xml文档中需要:新建文件、新建节点、设置节点内容、设置节点属性、建立节点之间的关系、保存文档等;
(1)xmlNewDoc()
原型:xmlDocPtr xmlNewDoc (const xmlChar *version);
参数:version : xmlChar string giving the version of XML “1.0”
返回值:Returns : a new document
功能:生成一个xml文档
(2)xmlNewNode()
函数原型:xmlNodePtr xmlNewNode (xmlNsPtr ns, const xmlChar *name);
参数: ns : namespace if any
name : the node name
返回值:Returns : a pointer to the new node object.
功能:Creation of a new node element. ns is optional (NULL).
(3)xmlNodeSetContent ()
函数原型:void xmlNodeSetContent (xmlNodePtr cur, const xmlChar *content);
参数:cur : the node being modified
content : the new value of the content
功能:Replace the content of a node.
(4)xmlNewProp ()
函数原型:xmlAttrPtr xmlNewProp (xmlNodePtr node, const xmlChar *name, const xmlChar *value);
参数:node : the holding node
name : the name of the attribute
value : the value of the attribute
返回值:Returns : a pointer to the attribute
功能:Create a new property carried by a node.
(5)xmlAddChild ()
xmlNodePtr xmlAddChild (xmlNodePtr parent, xmlNodePtr cur);
参数:parent : the parent node
cur : the child node
返回值:Returns : the child or NULL in case of error.
功能:将一个节点设置为另外一个节点的子节点
(6)xmlDocSetRootElement ()
函数原型:xmlNodePtr xmlDocSetRootElement (xmlDocPtr doc, xmlNodePtr root);
参数:doc : the document
root : the new document root element
Returns : the old root element if any was found
功能:Set the root element of the document (doc->children is a list containing possibly comments, PIs, etc …).
设置某个节点为整个文档的根节点
(7)xmlDocDumpMemory ()
函数原型:void xmlDocDumpMemory (xmlDocPtr cur,xmlChar **mem,int *size);
参数:cur : the document
mem : OUT: the memory pointer
size : OUT: the memory length
功能:Dump an XML document in memory and return the xmlChar * and it’s size. It’s up to the caller to free the memory with xmlFree().
将生成的xml DOM树保存到内存中(不是硬盘)
(8)xmlDocDumpFormatMemory ()
void xmlDocDumpFormatMemory (xmlDocPtr cur,xmlChar **mem, int *size,int format);
与xmlDocDumpMemory ()类似,区别在于可以选择保存的格式
此系列函数还包括:
xmlDocDump、xmlDocDumpFormatMemoryEnc、 xmlDocDumpMemory、xmlDocDumpMemoryEnc、xmlDocFormatDump
(9)xmlSaveFormatFileEnc ()
函数原型:int xmlSaveFormatFileEnc (const char *filename,xmlDocPtr cur,const char *encoding,int format);
参数:filename : the filename or URL to output
cur : the document being saved
encoding : the name of the encoding to use or NULL.
format : should formatting spaces be added.
Returns : the number of bytes written or -1 in case of error.
功能:将xml文件保存在硬盘
此系列的函数还包括:xmlSaveFileEnc
特别注意一种情况:将xml形式的字符串转换为xml文档的函数xmlParseMemory()和xmlParseDoc();
2.解析xml文档
解析xml文档的过程中可能有的操作:将文件导入、获得节点的属性、获得节点的内容、
(1)获得节点内容函数xmlNodeGetContent ()
函数原型:xmlChar* xmlNodeGetContent (xmlNodePtr cur);
参数: cur : the node being read
返回值:Returns : a new xmlChar * or NULL if no content is available. It’s up to the caller to free the memory with xmlFree().
功能:Read the value of a node, this can be either the text carried directly by this node if it’s a TEXT node or the aggregate string of the values carried by this node child’s (TEXT and ENTITY_REF). Entity references are substituted.
(2)获得节点属性函数xmlGetProp ()
函数原型:xmlChar* xmlGetProp (xmlNodePtr node,const xmlChar *name);
参数:node : the node
name : the attribute name
返回值:Returns : the attribute value or NULL if not found. It’s up to the caller to free the memory with xmlFree().
功能:Search and get the value of an attribute associated to a node This does the entity substitution. This function looks in DTD attribute declaration for FIXED or default declaration values unless DTD use has been turned off.
(3)读入xml字符形式的文件xmlReadfile()
使用xmlSaveFormatFileEnc()将xml文档存为文件之后,可以使用xmlReadfile读入
xmlDocPtr doc=xmlReadFile(szDocname,”UTF-8”,XML_PARSE_RECOVER);
doc = xmlReadFile(szDocName, “GB2312”, XML_PARSE_RECOVER);//以GB2312的编码方式读入解析文件
(4)获得根节点
xmlNodePtr xmlDocGetRootElement(xmlDocPtr doc)
(5)设置xml文档的上下文指针
context = xmlXPathNewContext(pdoc);
(6)计算满足xpath表达式的节点
result = xmlXPathEvalExpression(xpath, context);
相关链接:http://www.open-open.com/lib/view/open1422537148658.html
http://blog.csdn.net/iamlate/article/details/6955698
http://blog.csdn.net/hanchaoman/article/details/42557195
http://blog.chinaunix.net/uid-114518-id-2873824.html
示例:
// 解析xml字符串
xmlDocPtr doc = xmlParseMemory(pXml, length);
//根据xmldoc获得xml的根节点
xmlNodePtr cur = xmlDocGetRootElement(doc);
//获得子节点:->children获得不是第一个子节点,必须用next才能获得第一个子节点
cur = cur->children;
cur = cur->next;
// 获得节点信息中的内容: 注意释放资源
xmlChar* key = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
xmlFree(key);
//获得节点信息属性的值:属性name,注意释放资源
xmlChar* fversion = xmlGetProp(cur, "version");
xmlFree(fversion);
//根节点相关函数
xmlNodePtr xmlDocGetRootElement (xmlDocPtr doc) //获取文档根节点
xmlNodePtr xmlDocSetRootElement (xmlDocPtr doc, xmlNodePtr root) //设置文档根节点
//创建子节点相关函数
xmlNodePtr xmlNewNode (xmlNsPtr ns, const xmlChar * name) //创建新节点
xmlNodePtr xmlNewChild (xmlNodePtr parent, xmlNsPtr ns, const xmlChar * name, const xmlChar * content) //创建新的子节点
xmlNodePtr xmlCopyNode (const xmlNodePtr node, int extended) //复制当前节点
//添加子节点相关函数
xmlNodePtr xmlAddChild (xmlNodePtr parent, xmlNodePtr cur) //给指定节点添加子节点
xmlNodePtr xmlAddNextSibling (xmlNodePtr cur, xmlNodePtr elem) //添加后一个兄弟节点
xmlNodePtr xmlAddPrevSibling (xmlNodePtr cur, xmlNodePtr elem) //添加前一个兄弟节点
xmlNodePtr xmlAddSibling (xmlNodePtr cur, xmlNodePtr elem) //添加兄弟节点
//属性相关函数
xmlAttrPtr xmlNewProp (xmlNodePtr node, const xmlChar * name, const xmlChar * value) //创建新节点属性
xmlChar * xmlGetProp (xmlNodePtr node, const xmlChar * name) //读取节点属性
xmlAttrPtr xmlSetProp (xmlNodePtr node, const xmlChar * name, const xmlChar * value) //设置节点属性
=xmlNodeListGetstring(doc, cur->xmlChildrenNode, 1);
=xmlNodeContent(cur);
void CCommunicationThread::parseXml_doc(xmlDocPtr doc, xmlNodePtr cur, const char* path)
{
//1.进入xml的目录时:判断该目录是否存在?否则创建
cur = cur->children;
if (cur == NULL)
return;
cur = cur->next;
if (cur == NULL)
return;
check_and_create_path(path);
SVN_MAP file_map;
char* pMapBuffer = this->get_fileInfor_list(path, file_map);
//2.将服务器的新版、新增文件信息,压入准备下载的队列,启动线程开始下载.
xmlChar* fileName;
xmlChar* fileVersion;
SVN_MAP map_new;
while ( cur != NULL)
{
if (strcmp((char*)cur->name, "folder") == 0)
{
string curPath = path;
fileName = xmlGetProp(cur, (const xmlChar *)"name");
curPath = curPath + "\\" + (char*)fileName;
parseXml_doc(doc, cur, curPath.c_str());
}
else if (strcmp((char*)cur->name, "file") == 0)
{
// 判断一个文件是否存在?文件是否修改?文件版本号是否与当前的版本号相同?
fileName = xmlGetProp(cur, (const xmlChar *)"name");
fileVersion = xmlGetProp(cur, (const xmlChar *)"version");
FILE_SVN_INFOR* svn_infor = new FILE_SVN_INFOR;
strcpy(svn_infor->filename, (const char*)fileName);
svn_infor->version = 0;
SVN_MAP::iterator it = file_map.find((char*)fileName);
if (it != file_map.end())
{
// 找到该信息,查看版本号
if (atoi((const char*)fileVersion) > it->second->version)//新版本
{
File_Infor* infor = new File_Infor();
strcpy(infor->command, CMD_DOWNLOAD);
strcpy(infor->param.download.fileName, (const char*)fileName);
this->push_list(infor);
}
svn_infor->md5 = it->second->md5;
}
else
{
// 新增
File_Infor* infor = new File_Infor();
strcpy(infor->command, CMD_DOWNLOAD);
strcpy(infor->param.download.fileName, (const char*)fileName);
this->push_list(infor);
memset(&svn_infor->md5, 0, sizeof(MD5));
}
// 组织新的.svn文件
map_new[svn_infor->filename] = svn_infor;
xmlFree(fileName);
xmlFree(fileVersion);
}
cur = cur->next;
}
//3.在退出xml目录时:根据文件新的版本存储.svn文件
free(pMapBuffer);
set_fileInfor_list(path, map_new);
for ( SVN_MAP::iterator it = map_new.begin(); it != map_new.end(); it++ )
{
delete it->second;
}
map_new.clear();
return;
}
关于libxml2的提供的接口,可以参考http://blog.csdn.net/shanzhizi/article/details/7726679。libxml2常用的接口如下:
内部字符类型:xmlChar,定义为:typedef unsigned char xmlChar,用无符号型的char方便表示utf-8编码。libxml2提供了一个宏进行转换,#define BAD_CAST (xmlChar *)。
文档类型xmlDoc,指针类型xmlDocPtr。xmlDoc是个struct,保存了一个xml的相关信息,例如文件名、文件类型、子节点等等;xmlDocPtr等于xmlDoc*。
xmlNewDoc函数创建一个新的文件指针。
xmlParseFile函数以默认方式读入一个UTF-8格式的文件,并返回文件指针。
xmlReadFile函数读入一个带有某种编码的xml文件,并返回文件指针;细节见libxml2参考手册。
xmlFreeDoc释放文件指针。特别注意,当你调用xmlFreeDoc时,该文件所有包含的节点内存都被释放。
xmlFreeNodeList来释放动态分配的节点内存,除非你把该节点从文件中移除了。
xmlSaveFile将文件以默认方式存入一个文件。
xmlSaveFormatFileEnc可将文件以某种编码/格式存入一个文件中。
节点类型xmlNode、指针xmlNodePtr
节点应该是xml中最重要的元素了,xmlNode代表了xml文件中的一个节点,实现为一个struct,内容非常丰富:tree.h
xmlDocSetRootElement函数能将一个节点设置为某个文件的根节点
xmlNewNode函数创建一个节点指针root_node
创建xml文件:
/****************************************
*练习libxml库,创建通讯录xml文档,新增一个通讯录,
*如果xml文件存在,则添加一个新节点
*如果xml文件不存在,则新建一个xml文件
*
*@author: Anker @date: 2014/02/09
* ***************************************/
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <assert.h>
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xmlmemory.h>
#define PHONE_BOOK_FILE "phone_book.xml"
#define ID_STR_LEN 16
#define NAME_STR_LEN 32
#define TEL_STR_LEN 16
#define ADDR_STR_LEN 128
//电话通讯录结构体
typedef struct phone_t {
int id; //编号
char name[NAME_STR_LEN]; //姓名
char tel[TEL_STR_LEN]; //电话
char address[ADDR_STR_LEN]; //地址
}phone;
//设置通讯录项
static void set_phone_item(phone *phone_item)
{
assert(phone_item);
phone_item->id = 10;
snprintf(phone_item->name, NAME_STR_LEN, "%s", "Anker");
snprintf(phone_item->tel, TEL_STR_LEN, "%s", "13223246599");
snprintf(phone_item->address, ADDR_STR_LEN, "%s", "Shenzheng");
}
//创建phone节点
static xmlNodePtr create_phone_node(const phone *phone_item)
{
assert(phone_item);
char id[ID_STR_LEN] = {0};
xmlNodePtr phone_node = NULL;
phone_node = xmlNewNode(NULL, BAD_CAST"phone");
if (phone_node == NULL) {
fprintf(stderr, "Failed to create new node.\n");
return NULL;
}
//设置属性
snprintf(id, ID_STR_LEN, "%d", phone_item->id);
xmlNewProp(phone_node, BAD_CAST"id", (xmlChar*)id);
xmlNewChild(phone_node, NULL, BAD_CAST"name", (xmlChar *)phone_item->name);
xmlNewChild(phone_node, NULL, BAD_CAST"tel", (xmlChar *)phone_item->tel);
xmlNewChild(phone_node, NULL, BAD_CAST"address", (xmlChar *)phone_item->address);
return phone_node;
}
//向根节点中添加一个phone节点
static int add_phone_node_to_root(xmlNodePtr root_node)
{
xmlNodePtr phone_node = NULL;
phone *phone_item = NULL;
//创建一个新的phone
phone_item = (phone *)malloc(sizeof(phone));
if (phone_item == NULL) {
fprintf(stderr, "Failed to malloc memory.\n");
return -1;
}
set_phone_item(phone_item);
//创建一个phone节点
phone_node = create_phone_node(phone_item);
if (phone_node == NULL) {
fprintf(stderr, "Failed to create phone node.\n");
goto FAILED;
}
//根节点添加一个子节点
xmlAddChild(root_node, phone_node);
free(phone_item);
return 0;
FAILED:
if (phone_item){
free(phone_item);
}
return -1;
}
//创建phone_books
static int create_phone_books(const char *phone_book_file)
{
assert(phone_book_file);
xmlDocPtr doc = NULL;
xmlNodePtr root_node = NULL;
//创建一个xml 文档
doc = xmlNewDoc(BAD_CAST"1.0");
if (doc == NULL) {
fprintf(stderr, "Failed to new doc.\n");
return -1;
}
//创建根节点
root_node = xmlNewNode(NULL, BAD_CAST"phone_books");
if (root_node == NULL) {
fprintf(stderr, "Failed to new root node.\n");
goto FAILED;
}
//将根节点添加到文档中
xmlDocSetRootElement(doc, root_node);
if (add_phone_node_to_root(root_node) != 0) {
fprintf(stderr, "Failed to add a new phone node.\n");
goto FAILED;
}
//将文档保存到文件中,按照utf-8编码格式保存
xmlSaveFormatFileEnc(phone_book_file, doc, "UTF-8", 1);
//xmlSaveFile("test.xml", doc);
xmlFreeDoc(doc);
return 0;
FAILED:
if (doc) {
xmlFreeDoc(doc);
}
return -1;
}
static int add_phone_node(const char *phone_book_file)
{
assert(phone_book_file);
xmlDocPtr doc = NULL;
xmlNodePtr root_node = NULL;
xmlNodePtr phone_node = NULL;
phone *phone_item = NULL;
doc = xmlParseFile(phone_book_file);
if (doc == NULL) {
fprintf(stderr, "Failed to parser xml file:%s\n", phone_book_file);
return -1;
}
root_node = xmlDocGetRootElement(doc);
if (root_node == NULL) {
fprintf(stderr, "Failed to get root node.\n");
goto FAILED;
}
if (add_phone_node_to_root(root_node) != 0) {
fprintf(stderr, "Failed to add a new phone node.\n");
goto FAILED;
}
//将文档保存到文件中,按照utf-8编码格式保存
xmlSaveFormatFileEnc(phone_book_file, doc, "UTF-8", 1);
xmlFreeDoc(doc);
return 0;
FAILED:
if (doc) {
xmlFreeDoc(doc);
}
return -1;
}
int main(int argc, char *argv[])
{
char *phone_book_file = PHONE_BOOK_FILE;
if (argc == 2) {
phone_book_file = argv[1];
}
if (access(phone_book_file, F_OK) == 0) {
//文件存在,添加一个新的phone节点
add_phone_node(phone_book_file);
}
else {
//文件不存在,创建一个信息的phone book
create_phone_books(phone_book_file);
}
return 0;
}
解析xml文档:
/************************************
* 调用libxml2库解析xml,提取出电话薄信息
*
* @author:Anker @date:2014/02/09
* *********************************/
#include <stdio.h>
#include <assert.h>
#include <libxml/xmlmemory.h>
#include <libxml/parser.h>
#define DEFAULT_XML_FILE "phone_book.xml"
//解析每一个phone,提取出name、tel、address
static int parse_phone(xmlDocPtr doc, xmlNodePtr cur)
{
assert(doc || cur);
xmlChar *key;
cur = cur->xmlChildrenNode;
while (cur != NULL) {
//获取name
if ((!xmlStrcmp(cur->name, (const xmlChar *)"name"))) {
key = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
printf("name: %s\t", key);
xmlFree(key);
}
//获取tel
if ((!xmlStrcmp(cur->name, (const xmlChar *)"tel"))) {
key = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
printf("tel: %s\t", key);
xmlFree(key);
}
//获取address
if ((!xmlStrcmp(cur->name, (const xmlChar *)"address"))) {
key = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
printf("address: %s\n", key);
xmlFree(key);
}
cur = cur->next;
}
return 0;
}
static int parse_phone_book(const char *file_name)
{
assert(file_name);
xmlDocPtr doc; //xml整个文档的树形结构
xmlNodePtr cur; //xml节点
xmlChar *id; //phone id
//获取树形结构
doc = xmlParseFile(file_name);
if (doc == NULL) {
fprintf(stderr, "Failed to parse xml file:%s\n", file_name);
goto FAILED;
}
//获取根节点
cur = xmlDocGetRootElement(doc);
if (cur == NULL) {
fprintf(stderr, "Root is empty.\n");
goto FAILED;
}
if ((xmlStrcmp(cur->name, (const xmlChar *)"phone_books"))) {
fprintf(stderr, "The root is not phone_books.\n");
goto FAILED;
}
//遍历处理根节点的每一个子节点
cur = cur->xmlChildrenNode;
while (cur != NULL) {
if ((!xmlStrcmp(cur->name, (const xmlChar *)"phone"))) {
id = xmlGetProp(cur, "id");
printf("id:%s\t",id);
parse_phone(doc, cur);
}
cur = cur->next;
}
xmlFreeDoc(doc);
return 0;
FAILED:
if (doc) {
xmlFreeDoc(doc);
}
return -1;
}
int main(int argc, char*argv[])
{
char *xml_file = DEFAULT_XML_FILE;
if (argc == 2) {
xml_file = argv[1];
}
if (parse_phone_book(xml_file) != 0) {
fprintf(stderr, "Failed to parse phone book.\n");
return -1;
}
return 0;
}
Libxml2中的数据类型和函数
一个函数库中可能有几百种数据类型及几千个函数,不过记住大师的话,90%的功能都是由30%的内容提供的。对于libxml2(http://blog.csdn.net/shanzhizi),我认为搞懂以下的数据类型和函数就足够了。
2.1 内部字符类型xmlChar
xmlChar是Libxml2中的字符类型,库中所有字符、字符串都是基于这个数据类型。事实上他的定义是:xmlstring.h
typedef unsigned char xmlChar;
使用unsigned char作为内部字符格式是考虑到他能非常好适应UTF-8编码,而UTF-8编码正是libxml2的内部编码,其他格式的编码要转换为这个编码才能在libxml2中使用。
还经常能看到使用xmlChar*作为字符串类型,非常多函数会返回一个动态分配内存的xmlChar*变量,使用这样的函数时记得要手动删除内存。
2.2 xmlChar相关函数
如同标准c中的char类型相同,xmlChar也有动态内存分配、字符串操作等相关函数。例如xmlMalloc是动态分配内存的函数;xmlFree是配套的释放内存函数;xmlStrcmp是字符串比较函数等等。
基本上xmlChar字符串相关函数都在xmlstring.h中定义;而动态内存分配函数在xmlmemory.h中定义。
2.3 xmlChar*和其他类型之间的转换
另外要注意,因为总是要在xmlChar*和char*之间进行类型转换,所以定义了一个宏BAD_CAST,其定义如下:xmlstring.h
#define BAD_CAST (xmlChar *)
原则上来说,unsigned char和char之间进行强制类型转换是没有问题的。
2.4 文件类型xmlDoc、指针xmlDocPtr
xmlDoc是个struct,保存了一个xml的相关信息,例如文件名、文件类型、子节点等等;xmlDocPtr等于xmlDoc*,他搞成这个样子总让人以为是智能指针,其实不是,要手动删除的。
xmlNewDoc函数创建一个新的文件指针。
xmlParseFile函数以默认方式读入一个UTF-8格式的文件,并返回文件指针。
xmlReadFile函数读入一个带有某种编码的xml文件,并返回文件指针;细节见libxml2参考手册。
xmlFreeDoc释放文件指针。特别注意,当你调用xmlFreeDoc时,该文件所有包含的节点内存都被释放,所以一般来说不必手动调用xmlFreeNode或xmlFreeNodeList来释放动态分配的节点内存,除非你把该节点从文件中移除了。一般来说,一个文件中所有节点都应该动态分配,然后加入文件,最后调用xmlFreeDoc一次释放所有节点申请的动态内存,这也是为什么我们非常少看见xmlNodeFree的原因。
xmlSaveFile将文件以默认方式存入一个文件。
xmlSaveFormatFileEnc可将文件以某种编码/格式存入一个文件中。
2.5 节点类型xmlNode、指针xmlNodePtr
节点应该是xml中最重要的元素了,xmlNode代表了xml文件中的一个节点,实现为一个struct,内容非常丰富:tree.h
typedef struct _xmlNode xmlNode;
typedef xmlNode *xmlNodePtr;
struct _xmlNode {
void *_private;/* application data */
xmlElementType type; /* type number, must be second ! */
const xmlChar *name; /* the name of the node, or the entity */
struct _xmlNode *children; /* parent->childs link */
struct _xmlNode *last; /* last child link */
struct _xmlNode *parent;/* child->parent link */
struct _xmlNode *next; /* next sibling link */
struct _xmlNode *prev; /* previous sibling link */
struct _xmlDoc *doc;/* the containing document */
/* End of common part */
xmlNs *ns; /* pointer to the associated namespace */
xmlChar *content; /* the content */
struct _xmlAttr *properties;/* properties list */
xmlNs *nsDef; /* namespace definitions on this node */
void *psvi;/* for type/PSVI informations */
unsigned short line; /* line number */
unsigned short extra; /* extra data for XPath/XSLT */
};
能看到,节点之间是以链表和树两种方式同时组织起来的,next和prev指针能组成链表,而parent和children能组织为树。同时更有以下重要元素:
l 节点中的文字内容:content;
l 节点所属文件:doc;
l 节点名字:name;
l 节点的namespace:ns;
l 节点属性列表:properties;
Xml文件的操作其根本原理就是在节点之间移动、查询节点的各项信息,并进行增加、删除、修改的操作。
xmlDocSetRootElement函数能将一个节点设置为某个文件的根节点,这是将文件和节点连接起来的重要手段,当有了根结点以后,所有子节点就能依次连接上根节点,从而组织成为一个xml树。
2.6 节点集合类型xmlNodeSet、指针xmlNodeSetPtr
节点集合代表一个由节点组成的变量,节点集合只作为Xpath的查询结果而出现(XPATH的介绍见后面),因此被定义在xpath.h中,其定义如下:
/*
* A node-set (an unordered collection of nodes without duplicates).
*/
typedef struct _xmlNodeSet xmlNodeSet;
typedef xmlNodeSet *xmlNodeSetPtr;
struct _xmlNodeSet {
int nodeNr; /* number of nodes in the set */
int nodeMax; /* size of the array as allocated */
xmlNodePtr *nodeTab;/* array of nodes in no particular order */
/* @@ with_ns to check wether namespace nodes should be looked at @@ */
};
能看出,节点集合有三个成员,分别是节点集合的节点数、最大可容纳的节点数,及节点数组头指针。对节点集合中各个节点的访问方式非常简单,如下:
xmlNodeSetPtr nodeset = XPATH查询结果;
for (int i = 0; i nodeNr; i++)
{
nodeset->nodeTab;
}
注意,libxml2是个c函数库,因此其函数和数据类型都使用c语言的方式来处理。如果是c++,我想我宁愿用STL中的vector来表示一个节点集合更好,而且没有内存泄漏或溢出的担忧。
3. 简单xml操作例子
了解以上基本知识之后,就能进行一些简单的xml操作了。当然,还没有涉及到内码转换(使得xml中能处理中文)、xpath等较复杂的操作。
3.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
#include
#include
#include
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文件被创建,写入"个字节" }
//释放文件内节点动态申请的内存
xmlFreeDoc(doc);
return 1;
}
编译链接命令如下:
nmake TARGET_NAME=CreateXmlFile
然后执行可执行文件CreateXmlFile.exe,会生成一个xml文件CreatedXml.xml,打开后如下所示:
root>
newNode1>newNode1 contentnewNode1>
newNode2>newNode2 contentnewNode2>
newNode3>newNode3 contentnewNode3>
node2 attribute="yes">NODE CONTENTnode2>
son>
grandson>This is a grandson nodegrandson>
son>
root>
最佳使用类似XMLSPY这样的工具打开,因为这些工具能自动整理xml文件的栅格,否则非常有可能是没有所有换行的一个xml文件,可读性较差。
3.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
#include
int main(int argc, char* argv[])
{
xmlDocPtr doc; //定义解析文件指针
xmlNodePtr curNode; //定义结点指针(你需要他为了在各个结点间移动)
xmlChar *szKey; //临时字符串变量
char *szDocName;
if (argc {
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 xmlFree(szAttr);
}
attrPtr = attrPtr->next;
}
xmlFreeDoc(doc);
return 0;
}
编译链接命令如下:
nmake TARGET_NAME=ParseXmlFile
执行命令如下,使用第一次创建的xml文件作为输入:
ParseXmlFile.exe CreatedXml.xml
观察原始码可发现,所有以查询方式得到的xmlChar*字符串都必须使用xmlFree函数手动释放。否则会造成内存泄漏。
3.3 修改xml文件
有了上面的基础,修改xml文件的内容就非常简单了。首先打开一个已存在的xml文件,顺着根结点找到需要添加、删除、修改的地方,调用相应的xml函数对节点进行增、删、改操作。原始码见ChangeXmlFile,编译链接方法如上。执行下面的命令:
ChangeXmlFile.exe CreatedXml.xml
能得到一个修改后的xml文件ChangedXml.xml,如下:
root>
newNode2>content changednewNode2>
newNode3 newAttr="YES">newNode3 contentnewNode3>
node2 attribute="no">NODE CONTENTnode2>
son>
grandson>This is a grandson nodegrandson>
newGrandSon>new contentnewGrandSon>
son>
root>
需要注意的是,并没有xmlDelNode或xmlRemoveNode函数,我们删除节点使用的是以下一段代码:
if (!xmlStrcmp(curNode->name, BAD_CAST "newNode1"))
{
xmlNodePtr tempNode;
tempNode = curNode->next;
xmlUnlinkNode(curNode);
xmlFreeNode(curNode);
curNode = tempNode;
continue;
}
即将当前节点从文件中断链(unlink),这样本文件就不会再包含这个子节点。这样做需要使用一个临时变量来存储断链节点的后续节点,并记得要手动删除断链节点的内存。
3.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文件的方法,否则每寻找一个节点都要从根节点找起,会把人累死。
4. 用ICONV解决XML中的中文问题
Libxml2中默认的内码是UTF-8,所有使用libxml2进行处理的xml文件,必须首先显式或默认的转换为UTF-8编码才能被处理。
要在xml中使用中文,就必须能够在UTF-8和GB2312内码(较常用的一种简体中文编码)之间进行转换。Libxml2提供了默认的内码转换机制,并且在libxml2的Tutorial中有一个例子,事实证实这个例子并不适合用来转换中文。
所以需要我们显式的使用ICONV来进行内码转换,libxml2本身也是使用ICONV进行转换的。ICONV是个专门用来进行编码转换的库,基本上支持目前所有常用的编码。他是glibc库的一个部分,常常被用于UNIX系统中。当然,在windows下面使用也没有所有问题。前面已提到了ICONV的安装和使用方法,这里主要讲一下编程相关问题。
本节其实和xml及libxml2没有太大关系,你能把他简单看作是个编码转换方面的专题。我们仅仅需要学会使用两个函数就能了,即从UTF-8转换到GB2312的函数u2g,及反向转换的函数g2u,原始码在wxb_codeConv.c中:
/********************************************************************
created: 2007/11/15
created: 15:11:2007 10:30
filename: wxb_codeConv.c
author: Wang xuebin
depend: iconv.lib
build: 不必build,被包含到其他原始码中
purpose: 提供从UTF-8到GB2312的内码转换,及反向的转换
*********************************************************************/
#include "iconv.h"
#include
//代码转换:从一种编码转为另一种编码
int code_convert(char* from_charset, char* to_charset, char* inbuf,
int inlen, char* outbuf, int outlen)
{
iconv_t cd;
char** pin = &inbuf;
char** pout = &outbuf;
cd = iconv_open(to_charset,from_charset);
if(cd == 0)
return -1;
memset(outbuf,0,outlen);
if(iconv(cd,(const char**)pin,(unsigned int *)&inlen,pout,(unsigned int*)&outlen)
== -1)
return -1;
iconv_close(cd);
return 0;
}
//UNICODE码转为GB2312码
//成功则返回一个动态分配的char*变量,需要在使用完毕后手动free,失败返回NULL
char* u2g(char *inbuf)
{
int nOutLen = 2 * strlen(inbuf) - 1;
char* szOut = (char*)malloc(nOutLen);
if (-1 == code_convert("utf-8","gb2312",inbuf,strlen(inbuf),szOut,nOutLen))
{
free(szOut);
szOut = NULL;
}
return szOut;
}
//GB2312码转为UNICODE码
//成功则返回一个动态分配的char*变量,需要在使用完毕后手动free,失败返回NULL
char* g2u(char *inbuf)
{
int nOutLen = 2 * strlen(inbuf) - 1;
char* szOut = (char*)malloc(nOutLen);
if (-1 == code_convert("gb2312","utf-8",inbuf,strlen(inbuf),szOut,nOutLen))
{
free(szOut);
szOut = NULL;
}
return szOut;
}
使用的时候将这个c文件include到其他源文件中。include一个c文件并不奇怪,在c语言的年代我们常常这么干,唯一的害处的编译链接出来的可执行程式体积变大了。当然这时因为我们这段代码非常小的原因,再大一点我就要用dll了。
从UTF-8到GB2312的一个典型使用流程如下:
l 得到一个UTF-8的字符串szSrc;
l 定义一个char*的字符指针szDes,并不必给他动态审判内存;
l szDes = u2g(szSrc),这样就能得到转换后的GB2312编码的字符串;
l 使用完这个字符串后使用free(szDes)来释放内存。
本文并不准备讲述iconv中的函数细节,因为那几个函数及数据类型都非常简单,我们还是重点看一下怎么在libxml2中使用编码转换来处理带有中文的xml文件。下面是使用以上方法来创建一个带有中文的XML文件的例子程式CreateXmlFile_cn.cpp,原始码如下:
/********************************************************************
created: 2007/11/17
created: 9:11:2007 15:34
filename: CreateXmlFile.cpp
author: Wang xuebin
depend: libxml2.lib iconv.lib
build: nmake TARGET_NAME=CreateXmlFile_cn
purpose: 创建一个xml文件,其中包含中文
*********************************************************************/
#include
#include
#include
#include
#include "wxb_codeConv.c" //自己写的编码转换函数
int main(int argc, char **argv)
{
//定义文件和节点指针
xmlDocPtr doc = xmlNewDoc(BAD_CAST"1.0");
xmlNodePtr root_node = xmlNewNode(NULL,BAD_CAST"root");
//设置根节点
xmlDocSetRootElement(doc,root_node);
//一个中文字符串转换为UTF-8字符串,然后写入
char* szOut = g2u("节点1的内容");
//在根节点中直接创建节点
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");
xmlNewChild(root_node, NULL, BAD_CAST "node1",BAD_CAST szOut);
free(szOut);
//创建一个节点,设置其内容和属性,然后加入根结点
xmlNodePtr node = xmlNewNode(NULL,BAD_CAST"node2");
xmlNodePtr content = xmlNewText(BAD_CAST"NODE CONTENT");
xmlAddChild(root_node,node);
xmlAddChild(node,content);
szOut = g2u("属性值");
xmlNewProp(node,BAD_CAST"attribute",BAD_CAST szOut);
free(szOut);
//创建一个中文节点
szOut = g2u("中文节点");
xmlNewChild(root_node, NULL, BAD_CAST szOut,BAD_CAST "content of chinese node");
free(szOut);
//存储xml文件
int nRel = xmlSaveFormatFileEnc("CreatedXml_cn.xml",doc,"GB2312",1);
if (nRel != -1)
{
cout一个xml文件被创建,写入"个字节" }
xmlFreeDoc(doc);
return 1;
}
编译链接命令如下:
nmake TARGET_NAME=CreateXmlFile_cn
完成后执行CreateXmlFile_cn.exe能生成一个xml文件CreatedXml_cn.xml,其内容如下:
root>
newNode1>newNode1 contentnewNode1>
newNode2>newNode2 contentnewNode2>
newNode3>newNode3 contentnewNode3>
node1>节点1的内容node1>
node2 attribute="属性值">NODE CONTENTnode2>
中文节点>content of chinese node中文节点>
root>
观察可知,节点的名称、内容、属性都能使用中文了。在解析、修改和查找XML文件时都能使用上面的方法,只要记住,进入xml文件之前将中文编码转换为UTF-8编码;从XML中取出数据时,不管三七二十一都能转换为GB2312再用,否则你非常有可能见到传说中的乱码!
5. 用XML来做点什么
有了以上的基础,相信已能顺利的在c/c++程式中使用XML文件了。那么,我们到底要用XML来做什么呢?我随便说一说自己的想法:
第一,能用来作为设置文件。例如非常多组件就是用XML来做设置文件;当然,我们知道用INI做设置文件更简单,只要熟悉两个函数就能了;不过,复杂一点的设置文件我还是建议采用XML;
第二,能用来作为在程式之间传送数据的格式,这样的话最佳给你的xml先定义一个XML Schema,这样的数据首先能做一个良构校验,还能来一个Schema校验,如此的话出错率会比没有格式的数据小得多。目前XML已广泛作为网络之间的数据格式了;
第三,能用来作为你自定义的数据存储格式,例如对象持久化之类的功能;
最后,能用来显示你的技术非常高深,本来你要存储一个1,结果你这样存储了:
root>
My_Program_Code content="1">My_Program_Code>
root>