C语言创建及解析Json的使用法则

参考原文：http://blog.csdn.net/xukai871105/article/details/33013455

JSON(JavaScriptObject Notation)是一种轻量级的数据交换格式。它基于JavaScript的一个子集。JSON采用完全独立于语言的文本格式，但是也使用了类似于C语言家族的习惯。这些特性使JSON成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成。

cJSON结构体：
 
typedefstruct cJSON {
 
structcJSON *next,*prev;
 
struct cJSON *child;
 
int type;
 
char * valuestring;
 
int valueint;
 
double valuedouble;
 
char *string;
 
}cJSON;

几点说明

1.cJOSN结构体为一个双向列表，并可通过child指针访问下一层。

2.type变量决定数据项类型（键的类型），数据项可以是字符串可以是整形，也可以是浮点型。如果是整形值的话可从valueint，如果是浮点型的话可从valuedouble取出，以此类推。

3.string可理解为节点的名称，综合此处的第2点可理解为“键”的名称。

 

1.重要函数说明

    【1】两个创建

    【创建JSON对象】cJSON *cJSON_CreateObject(void);

    【创建JSON数组】cJSON *cJSON_CreateArray(void);

    

    【2】两种添加

    【向对象中添加】voidcJSON_AddItemToObject(cJSON *object,const char *string,cJSON *item);

    【向数组中添加】void cJSON_AddItemToArray(cJSON *array, cJSON *item);

 

    【3】常用几招

    【向对象中增加数字】cJSON_AddItemToObject(root, "value", cJSON_CreateNumber(value));

    【向对象中增加文件】cJSON_AddItemToObject(root, "string", cJSON_CreateString(string));

 

    【4】JSON嵌套

    【向对象中增加数组】cJSON_AddItemToObject(root, "rows", rows = cJSON_CreateArray());

    【向数组中增加对象】cJSON_AddItemToArray(rows, row = cJSON_CreateObject());

 

2.创建各种各样的JSON数据包

    在这里通过代码举几个例子，更多的内容请查看代码仓库中的相关文件。

    【1】JSON数字

1. void create_single_number(void) {
2. cJSON *root;
3. char *out;
4. int value = 24;
5. root = cJSON_CreateObject(); // 创建根
6. cJSON_AddItemToObject(root, "value", cJSON_CreateNumber(value));
7. // 打印并释放
8. out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
9. // 控制台输出
10. #if 0
11. {
12. "value": 24
13. }
14. #endif
15. }

    【简单说明】

    【1】cJSON_AddItemToObject(root, "value", cJSON_CreateNumber(value)); 

    【2】cJSON_AddNumberToObject(root, "value", value); 

    【1】和【2】效果完全相同。

 

    【2】JSON字符串

1. void create_single_string(void) {
2. cJSON *root;
3. char *out;
4. char *name = "xukai871105";
5. root = cJSON_CreateObject(); // 创建根
6. // 方法 使用cJSON_AddItemToObject，推荐使用
7. cJSON_AddItemToObject(root, "name", cJSON_CreateString(name));
8. // 打印并释放
9. out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
10. // 控制台输出
11. #if 0
12. {
13. "name": "xukai871105"
14. }
15. #endif
16. }

    【简单说明】

    【1】 cJSON_AddItemToObject(root, "name", cJSON_CreateString(name));

    【2】 cJSON_AddStringToObject(root, "name",name);

    【1】和【2】效果完全相同。

 

    【3】JSON布尔类型

1. void create_bool(void) {
2. cJSON *root;
3. char *out;
4. root = cJSON_CreateObject(); // 创建根
5. cJSON_AddItemToObject(root, "success", cJSON_CreateFalse());
6. // 打印并释放
7. out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
8. // 控制台输出
9. #if 0
10. {
11. "success": false
12. }
13. #endif
14. }

    【简单说明】

    【1】布尔类型不需要加引号。

 

3.JSON格式嵌套

    JSON格式在使用时往往存在嵌套，例如JSON对象中嵌套JSON数组而JSON数组中嵌套JSON对象，下面就通过几个简单的例子说明问题。

    【1】JSON简单嵌套

1. void create_simple(void) {
2. cJSON *root;
3. char *out;
4. int list[4] = {5,6,7,8};
5. root = cJSON_CreateObject(); // 创建根
6. cJSON_AddItemToObject(root, "lists", cJSON_CreateIntArray(list, 4));
7. // 打印并释放
8. out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
9. // 控制台输出
10. #if 0
11. {
12. "lists": [5, 6, 7, 8]
13. }
14. #endif
15. }

    【2】JSON复杂嵌套

1. void create_complex(void) {
2. cJSON *root, *rows, *row;
3. char *out;
4. int i = 0;
5. char *title[3] = { "树莓派学习笔记——索引博文",
6. "树莓派学习笔记——GPIO功能学习",
7. "物联网学习笔记——索引博文"};
8. char *url[3] = { "http://blog.csdn.net/xukai871105/article/details/23115627",
9. "http://blog.csdn.net/xukai871105/article/details/12684617",
10. "http://blog.csdn.net/xukai871105/article/details/23366187"};
11. root = cJSON_CreateObject(); // 创建根
12. cJSON_AddNumberToObject(root, "total", 3);
13. // 在object中加入array
14. cJSON_AddItemToObject(root, "rows", rows = cJSON_CreateArray());
15. for(i = 0; i < 3; i++) {
16. // 在array中加入object
17. cJSON_AddItemToArray(rows, row = cJSON_CreateObject());
18. cJSON_AddItemToObject(row, "title", cJSON_CreateString(title[i]));
19. cJSON_AddItemToObject(row, "url", cJSON_CreateString(url[i]));
20. }
21. // 打印并释放
22. out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
23. // 控制台输出
24. #if 0
25. {
26. "total": 3,
27. "rows": [{
28. "title": "树莓派学习笔记——索引博文",
29. "url": "http://blog.csdn.net/xukai871105/article/details/23115627"
30. }, {
31. "title": "树莓派学习笔记——GPIO功能学习",
32. "url": "http://blog.csdn.net/xukai871105/article/details/12684617"
33. }, {
34. "title": "物联网学习笔记——索引博文",
35. "url": "http://blog.csdn.net/xukai871105/article/details/23366187"
36. }]
37. }
38. #endif
39. }

    【简单说明】

rows为JSON对象，rows对象中嵌套JSON数组，每一个JSON数组的元素又是一个JSON对象，该该对象名为row，row对象中具有两个键值对，分别是titile和url。

参考上面的使用进行如下运用举例：

 void PageListResponse()
 {
 cJSON * pJsonRoot = NULL;
 cJSON * nameList = cJSON_CreateArray();
 int i=;
 cJSON *pJsonSub=NULL;

 pJsonRoot = cJSON_CreateObject();

 if(NULL == pJsonRoot)
 {
 //error happend here
 return ;
 }

 if(NULL == nameList)
 {
 // create object faild, exit
 printf("create json array faild\n");
 return ;
 }

 cJSON_AddStringToObject(pJsonRoot, "cmd", "PageListRes");
 cJSON_AddItemToObject(pJsonRoot, "params", nameList);

 if(gPlayInfo.listinfo.audioInputSource==WIFI)
 {
 for(i=;i<LISTNAMENUMMAX;i++)
 {

 cJSON_AddItemToArray(nameList,pJsonSub= cJSON_CreateObject());
 //cJSON_AddStringToObject(pJsonSub, "name",(gPlayInfo.listbuf+i)->name);      //实验这种方式也OK，相对而言更简便！
 //cJSON_AddStringToObject(pJsonSub, "singer",(gPlayInfo.listbuf+i)->singer);
 cJSON_AddItemToObject(pJsonSub, "name", cJSON_CreateString((gPlayInfo.listbuf+i)->name));
 cJSON_AddItemToObject(pJsonSub, "singer", cJSON_CreateString((gPlayInfo.listbuf+i)->singer));
 }
 }
 else if(gPlayInfo.listinfo.audioInputSource==USB || gPlayInfo.listinfo.audioInputSource==SD)
 {
 for(i=;i<LISTNAMENUMMAX;i++)
 {
 //pJsonSub = cJSON_CreateObject();
 cJSON_AddItemToArray(nameList,pJsonSub = cJSON_CreateObject());
 //cJSON_AddStringToObject(pJsonSub, "name", paginglistname[i]);   //这种方式也相当下面的实现，也OK
 //cJSON_AddStringToObject(pJsonSub, "singer",“NULL”);  //注意为"NULL"

 cJSON_AddItemToObject(pJsonSub, "name", cJSON_CreateString(paginglistname[i]));
 cJSON_AddItemToObject(pJsonSub, "singer", cJSON_CreateString("NULL"));    //注意空字串为“NULL”，而不是NULL，开始调试的时候，写入NULL，则出现EPC。

 }
 }

 char * p = cJSON_Print(pJsonRoot);   // 将Json数组转成字符串指针，会产生内存，注意用free释放内存；

 if(NULL == p)
 {
 cJSON_Delete(pJsonRoot);
 return;
 }

 mosquitto_pub_start(p);

 cJSON_Delete(pJsonRoot);     //不管创建了多少层，不需要一个一个进行删除，用cJSON_Delete删除根节点就ok
 free(p);

 return ;
 }     

输出结果如下格式：

{

"cmd":"PageListRes",

"params":

[

{"name":"",”singer”:””},

{"name":"",”singer”:””},

{"name":"",”singer”:””},

......

{"name":"",”singer”:””},

]

}

========================================================================================

解析Json：

如下例子：

{

"cmd": "play",

"params": {

"listID": "abcdefg",  //32位md5值

"playIndex":0      //播放索引

"songList":

[{

"id": "111",

"name": "what name",

"uri": "http://www.xxx.com",

"img": "http://www.xxx.com/yyy.jpg",

"singer": "singerName",

"album": "title11"

},

{

"id": "222",

"name": "what name",

"uri": "http://www.xxx.com",

"img": "http://www.xxx.com/yyy.jpg",

"singer": "singerName",

"album": "title22"

}]

},

}

该json数据指针通过message->payload传递，

cJSON* cmd;
char* cmd_out;

cJSON* id;
char* id_out;

cJSON* name;
char* name_out;

cJSON* singer;
char* singer_out;

cJSON* param;

cJSON* songList;

int songNum;

cJSON* pArray_root = cJSON_Parse((char*)message->payload);//解析根节点

cmd = cJSON_GetObjectItem(pArray_root,"cmd");

param =  cJSON_GetObjectItem(pArray_root,"params");

playIndex = cJSON_GetObjectItem(param,"playIndex")->valueint;  

songList = cJSON_GetObjectItem(param,"songList");

songNum=cJSON_GetArraySize(songList);

int j=0;
for(j=0;j<songNum;j++)
{
    pArray = cJSON_GetArrayItem(songList, j);
						name = cJSON_GetObjectItem(pArray,"name");
						uri = cJSON_GetObjectItem(pArray,"uri");
						id = cJSON_GetObjectItem(pArray,"id");
						singer= cJSON_GetObjectItem(pArray,"singer");

						name_out = cJSON_Print(name);
						uri_out = cJSON_Print(uri);
						id_out = cJSON_Print(id);
						singer_out = cJSON_Print(singer);

.......

						free(name_out);
						free(uri_out);
						free(id_out);
						free(singer_out);

}