cJSON学习笔记

原文链接

0.前言

    本文试图说明如何使用CJSON构造各种各样的JSON数据包。在前段时间已经写过一篇cJSON的文章，所以本文成为“续集”。

    【相关博文】

    【前端学习——JSON学习】——学习各种各样的JSON格式

    【cJSON学习笔记】——本学习笔记的前一“集”。

 

    【代码仓库】——cJSON-Example

    代码仓库位于bitbucket使用Hg(而不是Git)，Hg在windows或ubuntu上均有很好用的GUI工具——TortoiseHg，本人愚笨没能熟练掌握git。

    【TortoiseHg使用说明】——如果没有使用过Hg请参考博文，参考clone部分操作即可。

 

    【测试工具】

    【ubuntu】eclipse+gcc

    【windows】eclipse+mingw

 

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数字

void create_single_number(void) {
    cJSON *root;
    char *out;
    int value = 24;
 
    root = cJSON_CreateObject(); // 创建根
 
    cJSON_AddItemToObject(root, "value", cJSON_CreateNumber(value));
 
    // 打印并释放
    out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
 
    // 控制台输出
#if 0
    {
        "value": 24
    }
#endif
}

    【简单说明】

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

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

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

 

    【2】JSON字符串

void create_single_string(void) {
    cJSON *root;
    char *out;
    char *name = "xukai871105";
 
    root = cJSON_CreateObject(); // 创建根
    // 方法 使用cJSON_AddItemToObject，推荐使用
    cJSON_AddItemToObject(root, "name", cJSON_CreateString(name));
 
    // 打印并释放
    out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
 
    // 控制台输出
#if 0
    {
        "name": "xukai871105"
    }
#endif
}

    【简单说明】

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

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

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

 

    【3】JSON布尔类型

void create_bool(void) {
    cJSON *root;
    char *out;
 
    root = cJSON_CreateObject(); // 创建根
 
    cJSON_AddItemToObject(root, "success", cJSON_CreateFalse());
 
    // 打印并释放
    out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
 
    // 控制台输出
#if 0
    {
        "success": false
    }
#endif
}

    【简单说明】

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

 

3.JSON格式嵌套

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

    【1】JSON简单嵌套

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

【2】JSON复杂嵌套

void create_complex(void) {
cJSON *root, *rows, *row;
char *out;
int i = 0;
 
char *title[3] = { "树莓派学习笔记——索引博文",
"树莓派学习笔记——GPIO功能学习",
"物联网学习笔记——索引博文"};
char *url[3] = { "http://blog.csdn.net/xukai871105/article/details/23115627",
"http://blog.csdn.net/xukai871105/article/details/12684617",
"http://blog.csdn.net/xukai871105/article/details/23366187"};
 
root = cJSON_CreateObject(); // 创建根
cJSON_AddNumberToObject(root, "total", 3);
 
// 在object中加入array
cJSON_AddItemToObject(root, "rows", rows = cJSON_CreateArray());
 
for(i = 0; i < 3; i++) {
// 在array中加入object
cJSON_AddItemToArray(rows, row = cJSON_CreateObject());
cJSON_AddItemToObject(row, "title", cJSON_CreateString(title[i]));
cJSON_AddItemToObject(row, "url", cJSON_CreateString(url[i]));
}
 
// 打印并释放
out = cJSON_Print(root); cJSON_Delete(root); printf("%s\n",out); free(out);
 
// 控制台输出
#if 0
{
"total": 3,
"rows": [{
"title": "树莓派学习笔记——索引博文",
"url": "http://blog.csdn.net/xukai871105/article/details/23115627"
}, {
"title": "树莓派学习笔记——GPIO功能学习",
"url": "http://blog.csdn.net/xukai871105/article/details/12684617"
}, {
"title": "物联网学习笔记——索引博文",
"url": "http://blog.csdn.net/xukai871105/article/details/23366187"
}]
}
#endif
}

    【简单说明】

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