文章目录

一、 JSON简介二、 cJSON简介使用cJSON时的几个注意点可能会遇到的问题使用cJSON时的内存问题cJSON结构体cJSON常用库函数

三、使用cJSON构造JSON四、使用cJSON解析JSON

一、 JSON简介

JSON(JavaScriptObject Notation)是一种轻量级的数据交换格式。

它基于JavaScript的一个子集。JSON采用完全独立于语言的文本格式，但是也使用了类似于C语言家族的习惯。

这些特性使JSON成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，有效的提升了网络传输效率。

二、 cJSON简介

cJSON是一个超轻巧，方便，单文件，简单的可以作为ANSI-C标准的JSON解析器。由于c语言中，没有直接的字典，字符串数组等数据结构，所以要借助结构体定义，处理jsoncJSON对象的实现采用了树形结构，每个对象是树的一个节点，每个节点由cJSON这个结构体组成，对象中的元素也由cJSON这个结构体组成。同一层的对象和元素是双向链表结构，由next和prev指针链接。不同层的对象或元素由child指针链接起来。cJSON.h中有详细的注释cjson.h文件中包含了对于JSON格式的结构体定义以及一些操作JSON格式的功能函数，包括创建JSON、向JSON格式中添加数字，字符，布尔值等、读取JSON格式、将JSON格式转化为字符串等。cjson.c文件中就是功能函数的具体实现。下载连接：https://github.com/DaveGamble/cJSON

使用cJSON时的几个注意点

CJSON需要较多的堆栈空间，CJSON官方说：跑完他的test大概需要3k的空间。在单片机或者资源较少的地方使用CJSON时，注意空间分配 每一个CJOSN结构体都是一个比较大的空间，么使用完之后要及时delete，一旦子对象被添加到父对象之后，删除父对象就会删除子对象，所以一旦我们删除了父对象再删除子对象会出现问题。

可能会遇到的问题

对于绝大多数的STM32开发板，创建JSON对象、添加数据、将JSON转换为字符串是不会有问题的。

但是，使用cJSON_Parse()函数时会出错，什么数据都读不出来，究其原因，还是开发板内存不够，经不起JSON的折腾。

解决办法：修改启动文件中的Stack_Size和Heap_Size 。把堆栈的内存调大一些，再去编译基本就通过了。

使用cJSON时的内存问题

及时释放内存

构造JSON数据时，特别注意：cJSON_Print() 这种转换函数，会自动为指针申请空间，使用完之后一定要及时释放空间：free()cJSON的所有操作都是基于链表的，所以cJSON在使用过程中大量的使用malloc从堆中分配动态内存的，所以在使用完之后，应当及时调用下面的函数，清空cJSON指针所指向的内存，该函数也可用于删除某一条数据：

<code>(void) cJSON_Delete(cJSON *item);//该函数删除一条JSON数据时，如果有嵌套，会连带删除。

#include <stdio.h>

#include <stdlib.h>

#include "cJSON.h"

int main (int argc, const char * argv[])

{

// 创建JSON Object根数据项，之后便可向该根数据项中添加string或int等内容

cJSON *root = cJSON_CreateObject();

// 加入节点（键值对），节点名称为value，节点值为123.4

cJSON_AddNumberToObject(root,"value",123.4);

// 打印JSON数据包。cJSON_Print函数可以打印根数据项，加入制表符换行符等标识符使得JSON数据包更易阅读

char *out = cJSON_Print(root);

printf("%s\n",out);

// //释放json结构体

cJSON_Delete(root);

free(out);// 使用free函数释放被out字符串占用的内存空间

return 0;

}

内存钩子：cJSON在支持自定义malloc函数和free函数，方法如下：

// 使用cJSON_Hooks来连接自定义malloc函数和free函数：

typedef struct cJSON_Hooks

{

/* malloc/free are CDECL on Windows regardless of the default calling convention of the compiler, so ensure the hooks allow passing those functions directly. */

void *(CJSON_CDECL *malloc_fn)(size_t sz);

void (CJSON_CDECL *free_fn)(void *ptr);

} cJSON_Hooks;

(void) cJSON_InitHooks(cJSON_Hooks* hooks); // 初始化钩子cJSON_Hooks

cJSON结构体

//type一共有7种取值

#define cJSON_Invalid (0)

#define cJSON_False (1 << 0)

#define cJSON_True (1 << 1)

#define cJSON_NULL (1 << 2)

#define cJSON_Number (1 << 3)

#define cJSON_String (1 << 4)

#define cJSON_Array (1 << 5)

#define cJSON_Object (1 << 6)

#define cJSON_Raw (1 << 7) /* raw json */

//若是Number类型，则valueint或valuedouble中存储着值，若你期望的是int，则访问valueint，若期望的是double，则访问valuedouble，可以得到值。

#define cJSON_IsReference 256

#define cJSON_StringIsConst 512

typedef struct cJSON {

struct cJSON *next,*prev; /* 遍历数组或对象链的前向或后向链表指针*/

struct cJSON *child; //cJOSN结构体为一个双向列表，并可通过child指针访问下一层，对象的孩子节点

int type; //决定key的类型，数据项可以是字符串可以是整形，也可以是浮点型

char *valuestring; //若key的type是String，那么值就存在valuestring中，访问valuestring得到值

int valueint; //整数值

double valuedouble; //键值是浮点型的话，可以从valuedouble取出

char *string; //key名称

} cJSON;

cJSON常用库函数

//构造Json时会用到的函数

CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);//创建对象---常用

CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);//创建数组---常用

CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count);//创建整型数组

CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count);//创建双浮点型数组

CJSON_PUBLIC(cJSON*) cJSON_AddNullToObject(cJSON * const object, const char * const name);//在对象中添加null

CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name);//在对象中添加true

CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name);//在对象中添加false

CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number);//在对象中添加数字

CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string);//在对象中添加字符串

CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);//在对象中添加项目

CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item);//在数组中添加项目

CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);//JSON数据结构转换为JSON字符串---有格式

CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item);//JSON数据结构转换为JSON字符串---无格式

CJSON_PUBLIC(void) cJSON_Delete(cJSON *item); //清除结构体

//解析Json时会用到的函数

cJSON *cJSON_Parse(const char *value);

/*作用：将一个JSON数据包，按照cJSON结构体的结构序列化整个数据包，并在堆中开辟一块内存存储cJSON结构体

返回值：成功返回一个指向内存块中的cJSON的指针，失败返回NULL*/

cJSON *cJSON_GetObjectItem(cJSON *object,const char *string);

/*作用:获取JSON字符串字段值

返回值：成功返回一个指向cJSON类型的结构体指针，失败返回NULL*/

int cJSON_GetArraySize(cJSON *array);

/*作用：获取数组成员对象个数

返回值：数组成员对象个数*/

void cJSON_Delete(cJSON *c);

/*作用：释放位于堆中cJSON结构体内存

返回值：无*/

三、使用cJSON构造JSON

示例：

#include <stdio.h>

#include "cJSON.h"

int main(void)

{

double grade[4]={ 66.51,118.52,61.53,128.54};

inttime[4]={ 123,456,789,150};

cJSON *TCP = cJSON_CreateObject();//创建一个对象

cJSON_AddStringToObject(TCP,"name","MQ");//添加字符串

cJSON_AddNumberToObject(TCP,"age",25); //添加整型数字

cJSON_AddNumberToObject(TCP,"height",183.52);//添加浮点型数字

cJSON_AddFalseToObject(TCP,"gender");//添加逻辑值false

cJSON *ADD= cJSON_CreateObject();//创建一个对象

cJSON_AddStringToObject(ADD,"country","China");//添加字符串

cJSON_AddNumberToObject(ADD,"zip-code",123456);//添加整型数字

cJSON_AddItemToObject(TCP,"address",ADD);

cJSON *SUB = cJSON_CreateArray();//创建一个数组

cJSON_AddStringToObject(SUB,"","政治"); //添加字符串到数组

cJSON_AddStringToObject(SUB,"","数学");

cJSON_AddStringToObject(SUB,"","英语");

cJSON_AddStringToObject(SUB,"","专业课");

cJSON_AddItemToObject(TCP,"subject",SUB);//添加数组到对象

cJSON *TIM = cJSON_CreateIntArray(time,4);//创建一个整型数组

cJSON_AddItemToObject(TCP,"time",TIM);

cJSON *GRA = cJSON_CreateDoubleArray(grade,4);//创建一个双浮点型数组

cJSON_AddItemToObject(TCP,"grade",GRA);

cJSON *STU = cJSON_CreateArray();//创建一个数组

cJSON *Z3 = cJSON_CreateObject();//创建一个对象

cJSON_AddStringToObject(Z3,"name","张三");//添加字符串

cJSON_AddNumberToObject(Z3,"age",24); //添加整型数字

cJSON_AddTrueToObject(Z3,"gender");//添加逻辑值

cJSON_AddItemToArray(STU,Z3);//添加对象到数组中

cJSON *L4 = cJSON_CreateObject();//创建一个对象

cJSON_AddStringToObject(L4,"name","李四");//添加字符串

cJSON_AddNumberToObject(L4,"age",25); //添加整型数字

cJSON_AddTrueToObject(L4,"gender");//添加逻辑值

cJSON_AddItemToArray(STU,L4);//添加对象到数组中

cJSON *W5 = cJSON_CreateObject();//创建一个对象

cJSON_AddStringToObject(W5,"name","王五");//添加字符串

cJSON_AddNumberToObject(W5,"age",26); //添加整型数字

cJSON_AddTrueToObject(W5,"gender");//添加逻辑值

cJSON_AddItemToArray(STU,W5);//添加对象到数组中

cJSON_AddItemToObject(TCP,"student",STU);//添加数组到对象中

char *json_data = cJSON_Print(TCP);//JSON数据结构转换为JSON字符串

printf("%s\n",json_data);//输出字符串

free(json_data);

cJSON_Delete(TCP);//清除结构体

return 0;

}

结果

{

"name": "MQ",//字符串

"age":25,//整数

"height": 183.5,//浮点数

"gender": false,//逻辑值

"address":{ "country": "China",

"zip-code": 123456

},//对象

"subject": ["政治", "数学", "英语", "专业课"],//字符型数组

"time": [123, 456, 789, 150], //整型数组

"grade": [66.51, 118.52, 61.53, 128.54],//浮点型数组

"student":[

{ "name":"张三","age":24,"gender":true},

{ "name":"李四","age":25,"gender":true},

{ "name":"王五","age":26,"gender":true}

]//对象型数组

}

四、使用cJSON解析JSON

实例：从中提取出我们想要获取的数据，然后进行分析和处理

#include <stdio.h>

#include "cJSON.h"

int main()

{

char json_string[]="{\"name\":\"MQ\",\"age\":25,\"height\":183.5,\"gender\":false,\

\"address\":{\"country\":\"China\",\"zip-code\":123456},\

\"subject\":[\"政治\",\"数学\",\"英语\",\"专业课\"],\

\"time\":[123,456,789,150],\"grade\":[66.51,118.52,61.53,128.54],\

\"student\":[{\"name\":\"张三\",\"age\":24,\"gender\":false},\

{\"name\":\"李四\",\"age\":25,\"gender\":true},\

{\"name\":\"王五\",\"age\":26,\"gender\":null}]}";//定义JSON字符串

cJSON* cjson = cJSON_Parse(json_string);//将JSON字符串转换成JSON结构体

char *json_data = cJSON_Print(cjson);//JSON数据结构转换为JSON字符串

if(cjson == NULL)//判断转换是否成功

{

printf("cjson error...\r\n");

}

else

{

printf("%s\n",json_data);//输出字符串

//打包成功调用cJSON_Print打印输出

}

printf("/*********************以下就是提取的数据**********************/\n");

char *name = cJSON_GetObjectItem(cjson,"name")->valuestring;//解析字符串

printf("%s\n",name);

int age = cJSON_GetObjectItem(cjson,"age")->valueint;//解析整型

printf("%d\n",age);

double height = cJSON_GetObjectItem(cjson,"height")->valuedouble;//解析双浮点型

printf("%.1f\n",height);

int gender = cJSON_GetObjectItem(cjson,"gender")->type; //解析逻辑值---输出逻辑值对应的宏定义数值

printf("%d\n",gender);

cJSON* ADD = cJSON_GetObjectItem(cjson,"address");//解析对象

char * country = cJSON_GetObjectItem(ADD,"country")->valuestring;//解析对象中的字符串

printf("%s\n",country);

int zip = cJSON_GetObjectItem(ADD,"zip-code")->valueint;//解析对象中的整型数字

printf("%d\n",zip);

cJSON* SUB = cJSON_GetObjectItem(cjson,"subject");//解析数组

int SUB_size = cJSON_GetArraySize(SUB);//获取数组成员个数

int i=0;

for(i=0;i<SUB_size;i++)

{

printf("%s ",cJSON_GetArrayItem(SUB,i)->valuestring);//解析数组中的字符串

}

printf("\n");

cJSON* TIM = cJSON_GetObjectItem(cjson,"time");//解析数组

int TIM_size = cJSON_GetArraySize(TIM);//获取数组成员个数

for(i=0;i<TIM_size;i++)

{

printf("%d ",cJSON_GetArrayItem(TIM,i)->valueint);//解析数组中的整型数字

}

printf("\n");

cJSON* GRA = cJSON_GetObjectItem(cjson,"grade");//解析数组

int GRA_size = cJSON_GetArraySize(GRA);//获取数组成员个数

for(i=0;i<GRA_size;i++)

{

printf("%f ",cJSON_GetArrayItem(GRA,i)->valuedouble);//解析数组中的浮点型数字

}

printf("\n");

cJSON* STU = cJSON_GetObjectItem(cjson,"student");//解析数组

int STU_size = cJSON_GetArraySize(STU);//获取数组成员个数

cJSON* STU_item = STU->child;//获取子对象

for(i=0;i<STU_size;i++)

{

printf("%s ",cJSON_GetObjectItem(STU_item,"name")->valuestring);//解析数组中对象中的字符串

printf("%d ",cJSON_GetObjectItem(STU_item,"age")->valueint);//解析数组中对象中的整型数字

printf("%d\n",cJSON_GetObjectItem(STU_item,"gender")->type);//解析数组中对象中的逻辑值---输出逻辑值对应的宏定义数值

STU_item = STU_item->next;//跳转到下一个对象中

}

free(json_data);

cJSON_Delete(cjson);//清除结构体

return 0;

}

结果

{

"name": "MQ",//字符串

"age":25,//整数

"height": 183.5,//浮点数

"gender": false,//逻辑值

"address":{ "country": "China",

"zip-code": 123456

},//对象

"subject": ["政治", "数学", "英语", "专业课"],//字符型数组

"time": [123, 456, 789, 150], //整型数组

"grade": [66.51, 118.52, 61.53, 128.54],//浮点型数组

"student":[

{ "name":"张三","age":24,"gender":false},

{ "name":"李四","age":25,"gender":true},

{ "name":"王五","age":26,"gender":null}

]//对象型数组

}

/*********************以下就是提取的数据**********************/

MQ

25

183.5

1

China

123456

政治 数学 英语 专业课

123 456 789 150

66.510000 118.520000 61.530000 128.540000

张三 24 1

李四 25 2

王五 26 4