C语言：cJSON库用法详解
C语言：使用cJSON库构造JSON
C语言：使用cJSON库解析JSON字符串
一、JSON、cJSON简介
1. JSON 简介
JSON格式详解
2. cJSON简介
cJSON对象的实现采用了树形结构，每个对象是树的一个节点，每个节点由cJSON这个结构体组成，对象中的元素也由cJSON这个结构体组成。同一层的对象和元素是双向链表结构，由next和prev指针链接。不同层的对象或元素由child指针链接起来。type表示对象或元素类型，string表示对象或节点的名称。元素的值存储在valuestring, valueint和valuedouble中，cJSON.h中有详细的注释。
为什么选择使用cJSON来构造和解析JSON字符串？因为它具有超轻便，可移植，单文件的特点，使用MIT开源协议。其中主要包括两个文件cjson.c和cjson.h。
- cjson.h文件中包含了对于JSON格式的结构体定义以及一些操作JSON格式的功能函数，包括创建JSON、向JSON格式中添加数字，字符，布尔值等等、读取JSON格式、将JSON格式转化为字符串等。
- cjson.c文件中就是功能函数的具体实现。
cJSON源码下载地址
下载下来，解压后，从里面找到两个文件（cJSON.c、cJSON.h），复制到我们的工程里面。只需在函数中包含头文件（#include “cJSON.h”），然后和cJSON.c一起编译即可使用。
cJSON数据结构体和宏定义
具体代码如下：
//逻辑值的宏定义
#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 */
#define cJSON_IsReference 256
#define cJSON_StringIsConst 512
typedef struct cJSON //cJSON结构体
{
struct cJSON *next,*prev; /* 遍历数组或对象链的前向或后向链表指针*/
struct cJSON *child; /* 数组或对象的孩子节点*/
int type; /* key的类型*/
char *valuestring; /* 字符串值*/
int valueint; /* 整数值*/
double valuedouble; /* 浮点数值*/
char *string; /* key的名字*/
} cJSON;
二、使用cJSON构造JSON
1. cJSON库函数介绍
介绍一些构造JSON时，经常用到的函数，使用以下函数，就可以完成大部分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); //清除结构体
以下是一些不常用到的函数，我一般用不到，有些函数使用总出错。
具体代码如下：
CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num);//创建数字
CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string);//创建字符串
/*不常用原因：一般数字和字符串都是加在对象和数组里的，可以使用带有Add的函数，直接完成创建和添加任务。*/
CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count);//创建浮点型数组---这个使用会出问题，需要浮点型可以使用双浮点。
CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char *const *strings, int count);//创建字符型数组---这个使用会出问题，下面有替代方法。
/*不常用原因:以上两个函数使用总是出错，有没有技术大佬知道原因，可以在评论区留言，谢谢！*/
cJSON库中还有其他函数，我暂时用不到，就不介绍了。
2. 使用cJSON构造JSON
具体示例代码如下：
#include <stdio.h>
#include "cJSON.h"
int main(void)
{
double grade[4]={
66.51,118.52,61.53,128.54};
int time[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);//输出字符串
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
1. cJSON库函数介绍
介绍一些解析JSON时，经常用到的函数，使用以下函数，就可以完成大部分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结构体内存
返回值：无*/
2. 使用cJSON解析JSON
我们使用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结构体
if(cjson == NULL) //判断转换是否成功
{
printf("cjson error...\r\n");
}
else
{
printf("%s\n",cJSON_Print(cjson));//打包成功调用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; //跳转到下一个对象中
}
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