【cJSon】cJSON学习笔记

转载地址:http://blog.csdn.net/dengjin20104042056/article/details/47831011

1.JSON格式简述

JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。易于人阅读和编写,同时也易于机器解析和生成。它基于JavaScript(Standard ECMA-262 3rd Edition - December 1999)的一个子集。 JSON采用完全独立于语言的文本格式,但是也使用了类似于C语言家族的习惯(包括C, C++, C#, Java, JavaScript, Perl, Python等)。这些特性使JSON成为理想的数据交换语言。
cJSON是一个超轻巧,携带方便,单文件,简单的可以作为ANSI-C标准的JSON解析器。
接触yeelink平台之后,慢慢接触到JSON格式,虽然一些简单的情况可以通过string库函数解析和组装JSON数据包,但是若有cJSON库的帮助,解析和组装JSON数据包的工作便会变得简单的多,下面就从两个例子出发说明cJSON数据包的使用方法。

2.JSON结构体

熟悉使用cJSON库函数可从cJSON结构体入手,cJSON结构体如下所示:
[cpp]  view plain copy 在CODE上查看代码片 派生到我的代码片
  1. typedef struct cJSON {  
  2.  struct cJSON *next,*prev;   
  3.  struct cJSON *child;   
  4.  int type;   
  5.  char *valuestring;   
  6.  int valueint;  
  7.  double valuedouble;   
  8.  char *string;   
  9. } cJSON;  
cJSon类型
/* cJSON Types: */
#define cJSON_False 0
#define cJSON_True 1
#define cJSON_NULL 2
#define cJSON_Number 3
#define cJSON_String 4
#define cJSON_Array 5
#define cJSON_Object 6
    
#define cJSON_IsReference 256
#define cJSON_StringIsConst 512

说明

1.cJOSN结构体为一个双向列表,并可通过child指针访问下一层。
2.type变量决定数据项类型(键的类型),数据项可以是字符串可以是整形,也可以是浮点型。如果是整形值的话可从valueint,如果是浮点型的话可从valuedouble取出,以此类推。
3.string可理解为节点的名称,综合此处的第2点可理解为“键”的名称。

3.解析JSON数据包

例如在QCA平台中读取一个开关量的结果,向QCA平台请求之后可以获得以下JSON数据包:
{"timestamp":"2013-11-19T08:50:11","value":1}
在这个JSON数据包中有两个数据项(键值对),一个是时间戳,该时间戳为字符串形式;另一个是开关值,该开关值为整型。该例子主要用于模拟向QCA平台请求开关量数据。

参考代码

[cpp]  view plain copy 在CODE上查看代码片 派生到我的代码片
  1. #include <stdio.h>  
  2. #include <stdlib.h>  
  3. #include "cJSON.h"  
  4. // 被解析的JSON数据包  
  5. char text[] = "{\"timestamp\":\"2013-11-19T08:50:11\",\"value\":1}";  
  6. int main (int argc, const char * argv[])  
  7. {  
  8.     cJSON *json , *json_value , *json_timestamp;  
  9.     // 解析数据包  
  10.     json = cJSON_Parse(text);  
  11.     if (!json)  
  12.     {  
  13.         printf("Error before: [%s]\n",cJSON_GetErrorPtr());  
  14.     }  
  15.     else  
  16.     {  
  17.         // 解析开关值  
  18.         json_value = cJSON_GetObjectItem( json , "value");  
  19.         if( json_value->type == cJSON_Number )  
  20.         {  
  21.             // 从valueint中获得结果  
  22.             printf("value:%d\r\n",json_value->valueint);  
  23.         }  
  24.         // 解析时间戳  
  25.         json_timestamp = cJSON_GetObjectItem( json , "timestamp");  
  26.         if( json_timestamp->type == cJSON_String )  
  27.         {  
  28.             // valuestring中获得结果  
  29.             printf("%s\r\n",json_timestamp->valuestring);  
  30.         }  
  31.         // 释放内存空间  
  32.         cJSON_Delete(json);  
  33.     }  
  34.     return 0;  
  35. }  

运行结果

value:1
2013-11-19T08:50:11

若干说明

1.cJSON_Parse函数负责解析JSON数据包,并按照cJSON结构体的结构序列化整个数据包。使用该函数会通过malloc函数在内存中开辟一个空间,使用完成需要手动释放。
2.cJSON_GetObjectItem函数可从cJSON结构体中查找某个子节点名称(键名称),如果查找成功可把该子节点序列化到cJSON结构体中。
3.如果需要使用cJSON结构体中的内容,可通过cJSON结构体中的valueint和valuestring取出有价值的内容(即键的值)
4.可通过cJSON_Delete释放内存空间。

4.组装JSON数据包

组装数据包的过程和解析数据包的过程相反,下面的例子描述如何组装以下数据包,该数据包只有一个数据项(键值对)。该例子主要用于模拟向QCA平台上传传感器数据。
{
 "value": 123.400000
}

参考代码

[cpp]  view plain copy 在CODE上查看代码片 派生到我的代码片
  1. #include <stdio.h>  
  2. #include <stdlib.h>  
  3. #include "cJSON.h"  
  4. int main (int argc, const char * argv[])  
  5. {  
  6.     // 创建JSON Object  
  7.     cJSON *root = cJSON_CreateObject();  
  8.     // 加入节点(键值对),节点名称为value,节点值为123.4  
  9.     cJSON_AddNumberToObject(root,"value",123.4);  
  10.     // 打印JSON数据包  
  11.     char *out = cJSON_Print(root);  
  12.     printf("%s\n",out);  
  13.     // 释放内存  
  14.     cJSON_Delete(root);  
  15.     free(out);  
  16.     return 0;  
  17. }  

若干说明

1. cJSON_CreateObject函数可创建一个根数据项,之后便可向该根数据项中添加string或int等内容
2. cJSON_AddNumberToObject向节点中添加子节点,例如此处添加value节点,节点值为123.4
3. cJSON_Print函数可以打印根数据项,加入制表符换行符等标识符使得JSON数据包更易阅读
4. 使用free函数释放被out占用的内存空间

1.重要函数说明
    【1】两个创建
    【创建JSON对象】cJSON *cJSON_CreateObject(void);
    【创建JSON数组】cJSON *cJSON_CreateArray(void);
    
    【2】两种添加
    【向对象中添加】void cJSON_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 在CODE上查看代码片 派生到我的代码片
  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 在CODE上查看代码片 派生到我的代码片
  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 在CODE上查看代码片 派生到我的代码片
  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 在CODE上查看代码片 派生到我的代码片
  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 在CODE上查看代码片 派生到我的代码片
  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。

2015/08/19 17:50

【其他参考示例】

1. 函数的使用

宏的定义原型:
/* Macros for creating things quickly. */
#define cJSON_AddNullToObject(object,name)      cJSON_AddItemToObject(object, name, cJSON_CreateNull())
#define cJSON_AddTrueToObject(object,name)      cJSON_AddItemToObject(object, name, cJSON_CreateTrue())
#define cJSON_AddFalseToObject(object,name)     cJSON_AddItemToObject(object, name, cJSON_CreateFalse())
#define cJSON_AddBoolToObject(object,name,b)    cJSON_AddItemToObject(object, name, cJSON_CreateBool(b))
#define cJSON_AddNumberToObject(object,name,n)  cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n))
#define cJSON_AddStringToObject(object,name,s)  cJSON_AddItemToObject(object, name, cJSON_CreateString(s))

示例:
    cJSON *root = cJSON_CreateObject();   //先创建一个对象
    cJSON_AddNumberToObject(root, "value", 123.4);
    cJSON_AddStringToObject(root, "year", "2015");
    cJSON_AddNullToObject(root, "secret");
    cJSON_AddTrueToObject(root, "Bool");
    cJSON_AddFalseToObject(root, "false");
    cJSON_AddBoolToObject(root, "Yes", 3);
    cJSON_AddBoolToObject(root, "Yes", 0);
    out = cJSON_Print(root);     //打印对象
    //out = cJSON_PrintUnformatted(root);   //非格式化的打印
    //printf("===> 2: %s\n", out);
    printf("%s\n", out);
    cJSON_Delete(root);   //释放对象所占的内存
    free(out);

函数的原型:
/* These calls create a cJSON item of the appropriate type. */
extern cJSON *cJSON_CreateNull(void);
extern cJSON *cJSON_CreateTrue(void);
extern cJSON *cJSON_CreateFalse(void);
extern cJSON *cJSON_CreateBool(int b);
extern cJSON *cJSON_CreateNumber(double num);
extern cJSON *cJSON_CreateString(const char *string);
extern cJSON *cJSON_CreateArray(void);
extern cJSON *cJSON_CreateObject(void);

示例:参考上面博客的代码

函数原型:
/* These utilities create an Array of count items. */
extern cJSON *cJSON_CreateIntArray(const int *numbers,int count);
extern cJSON *cJSON_CreateFloatArray(const float *numbers,int count);
extern cJSON *cJSON_CreateDoubleArray(const double *numbers,int count);
extern cJSON *cJSON_CreateStringArray(const char **strings,int count);

/* Append item to the specified array/object. */
extern void cJSON_AddItemToArray(cJSON *array, cJSON *item);
extern void cJSON_AddItemToObject(cJSON *object,const char *string,cJSON *item);
extern void cJSON_AddItemToObjectCS(cJSON *object,const char *string,cJSON *item); 

示例:
    char *out = NULL;  
    int array[] = {1, 2, 3, 4};
    int array1[] = {1, 2, 3, 4, 5, 6};
    cJSON *json = NULL;
    cJSON *item = NULL;
    cJSON *tmp = NULL;

    json  = cJSON_CreateObject();
    //cJSON_AddItemToObject(json,"array",  cJSON_CreateIntArray(array, 4));   //与下面两行等价
    item = cJSON_CreateIntArray(array, 4);
    cJSON_AddItemToObject(json, "array", item);
    out = cJSON_Print(json);
    printf("%s\n", out);

    printf("=========================\n");
    printf("size: %d\n", cJSON_GetArraySize(item));   //输出为4  4个元素

    tmp = cJSON_GetArrayItem(json, 0);   //获取json中的第一个节点
    if (NULL != tmp)
    {  
        printf("ok..\n");  
        printf("size: %d\n", cJSON_GetArraySize(tmp));
    }  
    else
        printf("error...\n");

    //此时item数组中的元素有  1 2 3 4 5 6 7 
    printf("=========================\n");
    cJSON_AddItemToArray(item, cJSON_CreateNumber(5));
    cJSON_AddItemToArray(item, cJSON_CreateNumber(6));
    cJSON_AddItemToArray(item, cJSON_CreateNumber(7));
    printf("size: %d\n", cJSON_GetArraySize(item));
    out = cJSON_Print(json);
    printf("%s\n", out);

    tmp = cJSON_CreateIntArray(array1, 6);
    //cJSON_AddItemToObject(json, "array1", tmp);   //好像与下面一句话等价呢
    cJSON_AddItemReferenceToObject(json, "array1", tmp);
    out = cJSON_Print(json);
    printf("%s\n", out);


    //整形数组的参考示例
    int array3[] = {1, 3, 5, 7, 9};
    json = cJSON_CreateIntArray(array3, 5);
    out = cJSON_Print(json);    cJSON_Delete(json);     printf("%s\n", out);    free(out); 

    //字符指针数组
    const char *strings[7]={"Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"};
    json = cJSON_CreateStringArray(strings, 7);  
    out = cJSON_Print(json);     cJSON_Delete(json);    printf("%s\n", out);    free(out); 


5.总结

整体来说cJSON简单易用,解决了JSON数据包解析和组装的问题,几乎就掌握了CJSON。
Engineer-Bruce_Yang CSDN认证博客专家 嵌入式硬件 单片机 arm开发
本科毕业于华南理工大学,现美国卡罗尔工商管理硕士研究生在读,曾就职于世界名企伟易达、联发科技等,多年嵌入式产品开发经验,在智能玩具、安防产品、平板电脑、手机开发有丰富的实战开发经验,现任深圳市云之手科技有限公司副总经理、研发总工程师。
已标记关键词 清除标记
相关推荐
©️2020 CSDN 皮肤主题: Age of Ai 设计师:meimeiellie 返回首页