libxml2的安装及使用[总结]

1、前言

　　xml广泛应用于网络数据交换，配置文件、Web服务等等。近段时间项目中做一些配置文件，原来是用ini，现在改用xml。xml相对来说可视性更为直观，很容易看出数据之间的层次关系。关于xml的详细介绍可以参考http://baike.baidu.com/view/159832.htm?fromId=63。本文重点介绍解析xml的libxml2库的安装及使用，举例说明创建和解析xml的过程。

2、libxml2的安装

　　关于libxml2的介绍请参考官方网址http://xmlsoft.org/，下载最新的libxml2库http://xmlsoft.org/downloads.html。

具体安装步骤：
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目录下

3、xml文档结构

　　xml按照树形结构进行存储，节点分为元素和文本，必须有根节点。如下的xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<phone_books>
<phone id="1">
<name>Anker</name>
<tel>18923873456</tel>
<address>Shenzheng</address>
</phone>
<phone id="2">
<name>Jermey</name>
<tel>18623873456</tel>
<address>Beijing</address>
</phone>
<phone id="3">
<name>Lili</name>
<tel>13223873456</tel>
<address>Shanghai</address>
</phone>
</phone_books>

xml结构图如下所示：



4、测试例子

关于libxml2的提供的接口，可以参考/article/2841362.html。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 <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;
}

编译命令如下：gcc -g create_phone_book.c -o create_phone_book -I /usr/local/include/libxml2/ -lxml2

执行结果如下图所示：


（2）解析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;
}

测试结果如下所示：