首页 > 代码库 > C语言创建Json的使用法则

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数字
[cpp] view plain copy
 
 技术分享技术分享
  1. void create_single_number(void) {  
  2.     cJSON *root;  
  3.     char *out;  
  4.     int value = 24;  
  5.   
  6.     root = cJSON_CreateObject(); // 创建根  
  7.   
  8.     cJSON_AddItemToObject(root, "value", cJSON_CreateNumber(value));  
  9.   
  10.     // 打印并释放  
  11.     out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);  
  12.   
  13.     // 控制台输出  
  14. #if 0  
  15.     {  
  16.         "value": 24  
  17.     }  
  18. #endif  
  19. }  
    【简单说明】
    【1】cJSON_AddItemToObject(root, "value", cJSON_CreateNumber(value)); 
    【2】cJSON_AddNumberToObject(root, "value", value); 
    【1】和【2】效果完全相同。
 
    【2】JSON字符串
[cpp] view plain copy
 
 技术分享技术分享
  1. void create_single_string(void) {  
  2.     cJSON *root;  
  3.     char *out;  
  4.     char *name = "xukai871105";  
  5.   
  6.     root = cJSON_CreateObject(); // 创建根  
  7.     // 方法 使用cJSON_AddItemToObject,推荐使用  
  8.     cJSON_AddItemToObject(root, "name", cJSON_CreateString(name));  
  9.   
  10.     // 打印并释放  
  11.     out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);  
  12.   
  13.     // 控制台输出  
  14. #if 0  
  15.     {  
  16.         "name": "xukai871105"  
  17.     }  
  18. #endif  
  19. }  
    【简单说明】
    【1】 cJSON_AddItemToObject(root, "name", cJSON_CreateString(name));
    【2】 cJSON_AddStringToObject(root, "name",name);
    【1】和【2】效果完全相同。
 
    【3】JSON布尔类型
[cpp] view plain copy
 
 技术分享技术分享
  1. void create_bool(void) {  
  2.     cJSON *root;  
  3.     char *out;  
  4.   
  5.     root = cJSON_CreateObject(); // 创建根  
  6.   
  7.     cJSON_AddItemToObject(root, "success", cJSON_CreateFalse());  
  8.   
  9.     // 打印并释放  
  10.     out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);  
  11.   
  12.     // 控制台输出  
  13. #if 0  
  14.     {  
  15.         "success": false  
  16.     }  
  17. #endif  
  18. }  
    【简单说明】
    【1】布尔类型不需要加引号。
 
3.JSON格式嵌套
    JSON格式在使用时往往存在嵌套,例如JSON对象中嵌套JSON数组而JSON数组中嵌套JSON对象,下面就通过几个简单的例子说明问题。
    【1】JSON简单嵌套
[cpp] view plain copy
 
 技术分享技术分享
  1. void create_simple(void) {  
  2.     cJSON *root;  
  3.     char *out;  
  4.     int list[4] = {5,6,7,8};  
  5.   
  6.     root = cJSON_CreateObject(); // 创建根  
  7.     cJSON_AddItemToObject(root, "lists", cJSON_CreateIntArray(list, 4));  
  8.   
  9.     // 打印并释放  
  10.     out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);  
  11.   
  12.     // 控制台输出  
  13. #if 0  
  14.     {  
  15.         "lists": [5, 6, 7, 8]  
  16.     }  
  17. #endif  
  18. }  
    【2】JSON复杂嵌套
[cpp] view plain copy
 
 技术分享技术分享
  1. void create_complex(void) {  
  2. cJSON *root, *rows, *row;  
  3. char *out;  
  4. int i = 0;  
  5.   
  6. char *title[3] = { "树莓派学习笔记——索引博文",  
  7. "树莓派学习笔记——GPIO功能学习",  
  8. "物联网学习笔记——索引博文"};  
  9. char *url[3] = { "http://blog.csdn.net/xukai871105/article/details/23115627",  
  10. "http://blog.csdn.net/xukai871105/article/details/12684617",  
  11. "http://blog.csdn.net/xukai871105/article/details/23366187"};  
  12.   
  13. root = cJSON_CreateObject(); // 创建根  
  14. cJSON_AddNumberToObject(root, "total", 3);  
  15.   
  16. // 在object中加入array  
  17. cJSON_AddItemToObject(root, "rows", rows = cJSON_CreateArray());  
  18.   
  19. for(i = 0; i < 3; i++) {  
  20. // 在array中加入object  
  21. cJSON_AddItemToArray(rows, row = cJSON_CreateObject());  
  22. cJSON_AddItemToObject(row, "title", cJSON_CreateString(title[i]));  
  23. cJSON_AddItemToObject(row, "url", cJSON_CreateString(url[i]));  
  24. }  
  25.   
  26. // 打印并释放  
  27. out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);  
  28.   
  29. // 控制台输出  
  30. #if 0  
  31. {  
  32. "total": 3,  
  33. "rows": [{  
  34. "title": "树莓派学习笔记——索引博文",  
  35. "url": "http://blog.csdn.net/xukai871105/article/details/23115627"  
  36. }, {  
  37. "title": "树莓派学习笔记——GPIO功能学习",  
  38. "url": "http://blog.csdn.net/xukai871105/article/details/12684617"  
  39. }, {  
  40. "title": "物联网学习笔记——索引博文",  
  41. "url": "http://blog.csdn.net/xukai871105/article/details/23366187"  
  42. }]  
  43. }  
  44. #endif  
  45. }  
    【简单说明】
rows为JSON对象,rows对象中嵌套JSON数组,每一个JSON数组的元素又是一个JSON对象,该该对象名为row,row对象中具有两个键值对,分别是titile和url。

 

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

 

 1 void PageListResponse()
 2 {
 3 cJSON * pJsonRoot = NULL;
 4 cJSON * nameList = cJSON_CreateArray(); 
 5 int i=0;
 6 cJSON *pJsonSub=NULL;
 7 
 8 pJsonRoot = cJSON_CreateObject();
 9 
10 if(NULL == pJsonRoot)
11 {
12 //error happend here
13 return ;
14 }
15 
16 if(NULL == nameList)
17 {
18 // create object faild, exit
19 printf("create json array faild\n");
20 return ;
21 }
22 
23 cJSON_AddStringToObject(pJsonRoot, "cmd", "PageListRes");
24 cJSON_AddItemToObject(pJsonRoot, "params", nameList);
25 
26 if(gPlayInfo.listinfo.audioInputSource==WIFI)
27 {
28 for(i=0;i<LISTNAMENUMMAX;i++)    
29 {
30 
31 cJSON_AddItemToArray(nameList,pJsonSub= cJSON_CreateObject());
32 //cJSON_AddStringToObject(pJsonSub, "name",(gPlayInfo.listbuf+i)->name);      //实验这种方式也OK,相对而言更简便!
33 //cJSON_AddStringToObject(pJsonSub, "singer",(gPlayInfo.listbuf+i)->singer);
34 cJSON_AddItemToObject(pJsonSub, "name", cJSON_CreateString((gPlayInfo.listbuf+i)->name)); 
35 cJSON_AddItemToObject(pJsonSub, "singer", cJSON_CreateString((gPlayInfo.listbuf+i)->singer)); 
36 }
37 }
38 else if(gPlayInfo.listinfo.audioInputSource==USB || gPlayInfo.listinfo.audioInputSource==SD)
39 {
40 for(i=0;i<LISTNAMENUMMAX;i++)    
41 {
42 //pJsonSub = cJSON_CreateObject();
43 cJSON_AddItemToArray(nameList,pJsonSub = cJSON_CreateObject());
44 //cJSON_AddStringToObject(pJsonSub, "name", paginglistname[i]);   //这种方式也相当下面的实现,也OK
45 //cJSON_AddStringToObject(pJsonSub, "singer",“NULL”);  //注意为"NULL"
46 
47 cJSON_AddItemToObject(pJsonSub, "name", cJSON_CreateString(paginglistname[i])); 
48 cJSON_AddItemToObject(pJsonSub, "singer", cJSON_CreateString("NULL"));    //注意空字串为“NULL”,而不是NULL,开始调试的时候,写入NULL,则出现EPC。
49 
50 }
51 }
52 
53 
54 char * p = cJSON_Print(pJsonRoot);   // 将Json数组转成字符串指针,会产生内存,注意用free释放内存;
55 
56 if(NULL == p)
57 {
58 cJSON_Delete(pJsonRoot);
59 return;
60 }
61 
62 mosquitto_pub_start(p);
63 
64 cJSON_Delete(pJsonRoot);     //不管创建了多少层,不需要一个一个进行删除,用cJSON_Delete删除根节点就ok
65 free(p);
66 
67 return ;
68 }     
69 
70  

 

输出结果如下格式:

{

"cmd":"PageListRes",

"params":

[

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

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

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

......

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

]

}

 

C语言创建Json的使用法则