本文着重介绍解析xml的libxml2库的安装及使用,举例说明创建和解析xml的过程。是针对c语言开发人员使用
你若想详细学习前端的一套东西,即xml html css javascript(js)等,可以登录这个网站菜鸟教程 - 学的不仅是技术,更是梦想!
一、libxml2的安装
关于libxml2的介绍请参考官方网址http://xmlsoft.org/,下载最新的libxml2库releases · gnome / libxml2 · gitlab。
具体安装步骤:
1、解压:$tar zxvf libxml2-2.9.1.tar.gz
2、进入解压后的安装目录:$cd libxml2-2.9.1
3、安装三部曲:
1)$./configure
2) $make
3) $make install
安装完毕。
注意:libxml2默认安装到/usr/local/include/libxml2目录下
当然,如果你是centos系统也可以在命令行模式下,输入:yum install libxml
二、libxml2中的数据类型和函数
一个函数库中可能有几百种数据类型及几千个函数,不过记住大师的话,90%的功能都是由30%的内容提供的。对于libxml2,我认为搞懂以下的数据类型和函数就足够了。
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来表示一个节点集合更好,而且没有内存泄漏或溢出的担忧。
三、xml文档结构
xml按照树形结构进行存储,节点分为元素和文本,必须有根节点。如下的xml文件:
anker
18923873456
shenzheng
jermey
18623873456
beijing
lili
13223873456
shanghai
四、测试例子
关于libxml2的提供的接口,可以参考在linux是使用libxml2---从安装到使用_shanzhizi的博客-csdn博客_libxml2。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
(1)创建xml文件
测试程序如下所示:
/****************************************
*练习libxml库,创建通讯录xml文档,新增一个通讯录,
*如果xml文件存在,则添加一个新节点
*如果xml文件不存在,则新建一个xml文件
*
*@author: anker @date: 2014/02/09
* ***************************************/
#include
#include
#include
#include
#include
#include
#include
#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;
}
[root@nn test]# gcc -g create_phone_book.c -o create_phone_book -i /usr/local/include/libxml2/ -lxml2
[root@nn test]# ls
create_phone_book create_phone_book.c phone_book.c 新文件~
[root@nn test]# ./create_phone_book phone_book.xml
[root@nn test]# cat phone_book.xml
anker
13223246599
shenzheng
(2)解析xml文档
/************************************
* 调用libxml2库解析xml,提取出电话薄信息
*
* @author:anker @date:2014/02/09
* *********************************/
#include
#include
#include
#include
#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;
}
[root@nn test]# gcc -g phone_book.c -o phone_book -i /usr/local/include/libxml2/ -lxml2[root@nn test]# ./phone_book
id:10 name: anker tel: 13223246599 address: shenzheng