libxml2的安裝及使用[總結] - Anker－IT工程師數位筆記本

文章出處

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的提供的接口，可以參考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

（1）創建xml文件

測試程序如下所示：

  1 /****************************************
  2  *練習libxml庫，創建通訊錄xml文檔，新增一個通訊錄，
  3  *如果xml文件存在，則添加一個新節點
  4  *如果xml文件不存在，則新建一個xml文件
  5  *
  6  *@author: Anker  @date: 2014/02/09
  7  * ***************************************/
  8 
  9 #include <stdio.h>
 10 #include <string.h>
 11 #include <unistd.h>
 12 #include <assert.h>
 13 
 14 #include <libxml/parser.h>
 15 #include <libxml/tree.h>
 16 #include <libxml/xmlmemory.h>
 17 
 18 #define PHONE_BOOK_FILE     "phone_book.xml"
 19 #define ID_STR_LEN        16
 20 #define NAME_STR_LEN         32
 21 #define TEL_STR_LEN         16
 22 #define ADDR_STR_LEN         128
 23 
 24 //電話通訊錄結構體
 25 typedef struct phone_t {
 26     int id;              //編號
 27     char name[NAME_STR_LEN];     //姓名
 28     char tel[TEL_STR_LEN];       //電話
 29     char address[ADDR_STR_LEN];  //地址
 30 }phone;
 31 
 32 //設置通訊錄項
 33 static void set_phone_item(phone *phone_item)
 34 {
 35     assert(phone_item);
 36 
 37     phone_item->id = 10;
 38     snprintf(phone_item->name, NAME_STR_LEN, "%s", "Anker");
 39     snprintf(phone_item->tel, TEL_STR_LEN, "%s", "13223246599");
 40     snprintf(phone_item->address, ADDR_STR_LEN, "%s", "Shenzheng");
 41 }
 42 
 43 //創建phone節點
 44 static xmlNodePtr create_phone_node(const phone *phone_item)
 45 {
 46     assert(phone_item);
 47     
 48     char id[ID_STR_LEN] = {0};
 49     xmlNodePtr phone_node = NULL;
 50     
 51     phone_node = xmlNewNode(NULL, BAD_CAST"phone");
 52     if (phone_node == NULL) {
 53     fprintf(stderr, "Failed to create new node.\n");
 54     return NULL;
 55     }
 56     //設置屬性
 57     snprintf(id, ID_STR_LEN, "%d", phone_item->id);
 58     xmlNewProp(phone_node, BAD_CAST"id", (xmlChar*)id);
 59 
 60     xmlNewChild(phone_node, NULL, BAD_CAST"name", (xmlChar *)phone_item->name);
 61     xmlNewChild(phone_node, NULL, BAD_CAST"tel", (xmlChar *)phone_item->tel);
 62     xmlNewChild(phone_node, NULL, BAD_CAST"address", (xmlChar *)phone_item->address);
 63 
 64     return phone_node;
 65 }
 66 
 67 //向根節點中添加一個phone節點
 68 static int add_phone_node_to_root(xmlNodePtr root_node)
 69 {
 70     xmlNodePtr phone_node = NULL;
 71     phone *phone_item = NULL;
 72 
 73     //創建一個新的phone
 74     phone_item = (phone *)malloc(sizeof(phone));
 75     if (phone_item == NULL) {
 76     fprintf(stderr, "Failed to malloc memory.\n");
 77     return -1;
 78     }
 79     set_phone_item(phone_item);
 80 
 81     //創建一個phone節點
 82     phone_node = create_phone_node(phone_item); 
 83     if (phone_node == NULL) {
 84     fprintf(stderr, "Failed to create phone node.\n");
 85     goto FAILED;
 86     }
 87     //根節點添加一個子節點
 88     xmlAddChild(root_node, phone_node);
 89     free(phone_item);
 90 
 91     return 0;
 92 FAILED:
 93     if (phone_item){
 94     free(phone_item);
 95     }
 96     return -1;
 97 }
 98 
 99 //創建phone_books
100 static int create_phone_books(const char *phone_book_file)
101 {
102     assert(phone_book_file);
103 
104     xmlDocPtr doc = NULL;
105     xmlNodePtr root_node = NULL;
106 
107     //創建一個xml 文檔
108     doc = xmlNewDoc(BAD_CAST"1.0");
109     if (doc == NULL) {
110     fprintf(stderr, "Failed to new doc.\n");
111     return -1;
112     }
113 
114     //創建根節點
115     root_node = xmlNewNode(NULL, BAD_CAST"phone_books");
116     if (root_node == NULL) {
117     fprintf(stderr, "Failed to new root node.\n");
118     goto FAILED;
119     }
120     //將根節點添加到文檔中
121     xmlDocSetRootElement(doc, root_node);
122 
123     if (add_phone_node_to_root(root_node) != 0) {
124     fprintf(stderr, "Failed to add a new phone node.\n");
125     goto FAILED;
126     }
127     //將文檔保存到文件中，按照utf-8編碼格式保存
128     xmlSaveFormatFileEnc(phone_book_file, doc, "UTF-8", 1);
129     //xmlSaveFile("test.xml", doc);
130     xmlFreeDoc(doc);
131 
132     return 0; 
133 FAILED:
134     if (doc) {
135     xmlFreeDoc(doc);
136     }
137 
138     return -1;
139 }
140 
141 static int add_phone_node(const char *phone_book_file)
142 {
143     assert(phone_book_file);
144 
145     xmlDocPtr doc = NULL;
146     xmlNodePtr root_node = NULL;
147     xmlNodePtr phone_node = NULL;
148     phone *phone_item = NULL;
149     
150     doc = xmlParseFile(phone_book_file);
151     if (doc == NULL) {
152     fprintf(stderr, "Failed to parser xml file:%s\n", phone_book_file);
153     return -1;
154     }
155 
156     root_node = xmlDocGetRootElement(doc);
157     if (root_node == NULL) {
158     fprintf(stderr, "Failed to get root node.\n");
159     goto FAILED;
160     }
161     
162     if (add_phone_node_to_root(root_node) != 0) {
163     fprintf(stderr, "Failed to add a new phone node.\n");
164     goto FAILED;
165     }
166     //將文檔保存到文件中，按照utf-8編碼格式保存
167     xmlSaveFormatFileEnc(phone_book_file, doc, "UTF-8", 1);
168     xmlFreeDoc(doc);
169 
170     return 0;
171 FAILED:
172     if (doc) {
173     xmlFreeDoc(doc);
174     }
175 
176     return -1;
177 }
178 
179 int main(int argc, char *argv[])
180 {
181     char *phone_book_file = PHONE_BOOK_FILE;
182 
183     if (argc == 2) {
184     phone_book_file = argv[1];
185     }
186 
187     if (access(phone_book_file, F_OK) == 0) {
188     //文件存在，添加一個新的phone節點
189     add_phone_node(phone_book_file);
190     }
191     else {
192     //文件不存在，創建一個信息的phone book
193     create_phone_books(phone_book_file);
194     }
195 
196     return 0;
197 }

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

執行結果如下圖所示：

（2）解析xml文檔

測試程序如下所示：

  1 /************************************
  2  * 調用libxml2庫解析xml，提取出電話薄信息
  3  *
  4  * @author:Anker  @date:2014/02/09
  5  * *********************************/
  6 
  7 #include <stdio.h>
  8 #include <assert.h>
  9 
 10 #include <libxml/xmlmemory.h>
 11 #include <libxml/parser.h>
 12 
 13 #define DEFAULT_XML_FILE "phone_book.xml"
 14 
 15 //解析每一個phone，提取出name、tel、address
 16 static int parse_phone(xmlDocPtr doc, xmlNodePtr cur)
 17 {
 18     assert(doc || cur);
 19     xmlChar *key;
 20 
 21     cur = cur->xmlChildrenNode;
 22     while (cur != NULL) {
 23     //獲取name
 24     if ((!xmlStrcmp(cur->name, (const xmlChar *)"name"))) {
 25         key = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
 26         printf("name: %s\t", key);
 27         xmlFree(key);
 28     }
 29     //獲取tel
 30     if ((!xmlStrcmp(cur->name, (const xmlChar *)"tel"))) {
 31         key = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
 32         printf("tel: %s\t", key);
 33         xmlFree(key);
 34     }
 35     //獲取address
 36     if ((!xmlStrcmp(cur->name, (const xmlChar *)"address"))) {
 37         key = xmlNodeListGetString(doc, cur->xmlChildrenNode, 1);
 38         printf("address: %s\n", key);
 39         xmlFree(key);
 40     }
 41     cur = cur->next;
 42     }
 43     return 0;
 44 }
 45 
 46 static int parse_phone_book(const char *file_name)
 47 {
 48     assert(file_name);
 49 
 50     xmlDocPtr doc;   //xml整個文檔的樹形結構
 51     xmlNodePtr cur;  //xml節點
 52     xmlChar *id;     //phone id
 53 
 54     //獲取樹形結構
 55     doc = xmlParseFile(file_name);
 56     if (doc == NULL) {
 57     fprintf(stderr, "Failed to parse xml file:%s\n", file_name);
 58     goto FAILED;
 59     }
 60 
 61     //獲取根節點
 62     cur = xmlDocGetRootElement(doc);
 63     if (cur == NULL) {
 64     fprintf(stderr, "Root is empty.\n");
 65     goto FAILED;
 66     }
 67 
 68     if ((xmlStrcmp(cur->name, (const xmlChar *)"phone_books"))) {
 69     fprintf(stderr, "The root is not phone_books.\n");
 70     goto FAILED;
 71     }
 72 
 73     //遍歷處理根節點的每一個子節點
 74     cur = cur->xmlChildrenNode;
 75     while (cur != NULL) {
 76     if ((!xmlStrcmp(cur->name, (const xmlChar *)"phone"))) {
 77         id = xmlGetProp(cur, "id");
 78         printf("id:%s\t",id);
 79         parse_phone(doc, cur);
 80     }
 81     cur = cur->next;
 82     }
 83     xmlFreeDoc(doc);
 84     return 0;
 85 FAILED:
 86     if (doc) {
 87     xmlFreeDoc(doc);
 88     }
 89     return -1;
 90 }
 91 
 93 int main(int argc, char*argv[])
 94 {
 95     char *xml_file = DEFAULT_XML_FILE;
 96 
 97     if (argc == 2) {
 98     xml_file = argv[1];
 99     }
100 
101     if (parse_phone_book(xml_file) != 0) {
102     fprintf(stderr, "Failed to parse phone book.\n");
103     return -1;
104     }
105 
106     return 0;
107 }