说明:
基于 C 语言的 Json 库 – cJson。cJSON 是一个超轻巧,携带方便,单文件,简单的可以作为 ANSI-C 标准的 JSON 解析器。
cJSON 是一个开源项目,github 下载地址:
https://github.com/DaveGamble/cJSON
编译指令:
mkdir build
cd build
cmake ..
make install如果需要,请安装它。默认情况下,它将头文件/usr/local/include/cjson和库安装到/usr/local/lib
cJSON,目前来说,主要的文件有两个,一个 cJSON.c 一个 cJSON.h。使用的时候,将头文件 include 进去即可。
如果是在 Linux 操作系统中使用,编译 到时候需要添加数学库 libm.so
cJSON 结构体:
typedef struct cJSON {
struct cJSON *next,*prev;
struct cJSON *child;
int type;
char *valuestring; // value值是字符串类型
int valueint;
double valuedouble;
char *string; // 对象中的key
} cJSON;
数据结构说明如下:
- cJOSN 结构体是一个双向链表,并且可通过 child 指针访问下一层。
- 结构体成员 type 变量用于描述数据元素的类型(如果是键值对表示 value 值的类型),数据元素可以是字符串可以是整形,也可以是浮点型。
- 如果是整形值的话可通过 valueint 将值取出
- 如果是浮点型的话可通过 valuedouble 将值取出
- 如果是字符串类型的话可通过 valuestring 将值取出
- 结构体成员 string 表示键值对中键值的名称。
- cJSON 作为 Json 格式的解析库,其主要功能就是构建和解析 Json 格式了,比如要发送数据:用途就是发送端将要发送的数据以 json 形式封装,然后发送,接收端收到此数据后,还是按 json 形式解析,就得到想要的数据了。
cJson API
Json 格式的数据无外乎有两种 Json对象和 Json数组,创建的 Json 数据串可能是二者中 的一种,也可能是二者的组合,不管哪一种通过调用相关的 API 函数都可以轻松的做到这一点。
主要使用函数
检查元素类型
/* These functions check the type of an item */
CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);
基本数据的封装
在 cJSON.h 头文件中可以看到一些函数声明,通过调用这些创建函数就可以将 Json 支持的数据类型封装为 cJSON 结构体类型:
// 空值类型
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);
// json数组(创建空数组)
extern cJSON *cJSON_CreateArray(void);
// json对象(创建空对象)
extern cJSON *cJSON_CreateObject(void);
数组数据的封装
// 创建一个Json数组, 元素为整形
extern cJSON *cJSON_CreateIntArray(const int *numbers,int count);
// 创建一个Json数组, 元素为浮点
extern cJSON *cJSON_CreateFloatArray(const float *numbers,int count);
extern cJSON *cJSON_CreateDoubleArray(const double *numbers,int count);
// 创建一个Json数组, 元素为字符串类型
extern cJSON *cJSON_CreateStringArray(const char **strings,int count);
Json 对象操作
当得到一个 Json 对象之后,就可以往对象中添加键值对了,可以使用 cJSON_AddItemToObject()
extern void cJSON_AddItemToObject(cJSON *object,const char *string,cJSON *item);
在 cJSON 库中节点的从属关系是通过树来维护的,每一层节点都是通过链表来维护的,这样就能分析出该函数参数的含义:
- object:要添加的键值对从属于那个节点
- string:添加的键值对的键值
- item:添加的键值对的 value 值(需要先将其封装为 cJSON 类型的结构体)
为了让我的操作更加方便,cJson 库还给我们提供了一些宏函数,方便我们快速的往 Json 对象中添加键值对
cJSON_AddItemToObject(object, name, cJSON_CreateNull())
cJSON_AddItemToObject(object, name, cJSON_CreateTrue())
cJSON_AddItemToObject(object, name, cJSON_CreateFalse())
cJSON_AddItemToObject(object, name, cJSON_CreateBool(b))
cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n))
cJSON_AddItemToObject(object, name, cJSON_CreateString(s))
cJSON 格式化输出
extern char *cJSON_Print(cJSON *item);
extern char *cJSON_PrintUnformatted(cJSON *item);
extern char *cJSON_PrintBuffered(cJSON *item,int prebuffer,int fmt);
- 调用 cJSON_Print() 函数我们可以得到一个带格式的 Json 字符串(有换行,看起来更直观)
- 调用 cJSON_PrintUnformatted() 函数会得到一个没有格式的 Json 字符串(没有换行,所有的数据都在同一行)。
-
调用 cJSON_PrintBuffered() 函数使用缓冲策略将 Json 实体转换为字符串,参数 prebuffer
是指定缓冲区的大小,参数 fmt0 表示未格式化,fmt1 表示格式化。
Json 字符串的解析
如果我们得到了一个 Json 格式的字符串,想要读出里边的数据,就需要对这个字符串进行解析,处理方式就是将字符串转换为 cJSON 结构体,然后再基于这个结构体读里边的原始数据,转换函数的函数原型如下:
extern cJSON *cJSON_Parse(const char *value);
cJSON 内存释放
当我们将数据封装为 cJSON 结构类型的节点之后都会得到一块堆内存,当我们释放某个节点的时候可以调用 cJson 库提供的删除函数 cJSON_Delete(),函数原型如下:
extern void cJSON_Delete(cJSON *c);
在进行内存地址释放的时候,当前节点以及其子节点都会被删除。
Json 数据的封装
#include<stdio.h>
#include<stdlib.h>
#include<string.h>
#include<cjson/cJSON.h>
int main()
{
cJSON * root;
cJSON *arry;
root=cJSON_CreateObject(); // 创建根数据对象
cJSON_AddStringToObject(root,"name","hou"); // 添加键值对
cJSON_AddStringToObject(root,"sex","女"); // 添加键值对
cJSON_AddNumberToObject(root,"age",24); // 添加键值对
char *out = cJSON_Print(root); // 将json形式转换成字符串
printf("%s\n",out);
// 释放内存
cJSON_Delete(root);
free(out);
}
运行结构:
{
"name": "hou",
"sex": "女",
"age": 24
}
- cJSON_CreateObject 函数可创建一个根对象,返回的是一个 cJSON 指针,在这个指针用完了以后,需要手动调用cJSON_Delete(root) 进行内存回收。
- 函数 cJSON_Print() 内部封装了 malloc 函数,所以需要使用 free() 函数释放被 out 占用的内存空间。
Json 数组操作
创建一个数组,并向数组添加一个字符串和一个数字。
int main(int argc, char **argv)
{
cJSON *root;
root = cJSON_CreateArray();
cJSON_AddItemToArray(root, cJSON_CreateString("xian"));
cJSON_AddItemToArray(root, cJSON_CreateNumber(10));
// char *s = cJSON_Print(root);
char *s = cJSON_PrintUnformatted(root);
if(s)
{
printf(" %s \n",s);
free(s);
}
cJSON_Delete(root);
return 0;
}
运行结果:
["xian",10]
Json 对象、数组嵌套使用
int main(int argc, char **argv)
{
cJSON *root, *body, *list;
// josn 对象 root
root = cJSON_CreateObject();
// root 添加键值对 person:json数组A
cJSON_AddItemToObject(root,"person", body = cJSON_CreateArray());
// json数组A 添加Json对象B
cJSON_AddItemToArray(body, list = cJSON_CreateObject());
// 在json对象B中添加键值对: "name":"hou"
cJSON_AddStringToObject(list,"name","hou");
// 在json对象B中添加键值对: "age":24
cJSON_AddNumberToObject(list,"age",24);
// char *s = cJSON_Print(root);
char *s = cJSON_PrintUnformatted(root);
if(s)
{
printf(" %s \n",s);
free(s);
}
if(root)
{
cJSON_Delete(root);
}
return 0;
}
{
"person":[{
"name":"hou",
"age":24
}]
}
解析 Json 字符串
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include<cjson/cJSON.h>
int main()
{
cJSON *json, *name, *sex, *age;
char* out="{\"name\":\"hou\",\"sex\":\"man\",\"age\":24}";
json = cJSON_Parse(out); //解析成json形式
name = cJSON_GetObjectItem(json, "name"); //获取键值内容
sex = cJSON_GetObjectItem(json, "sex");
age = cJSON_GetObjectItem(json, "age");
printf("name:%s,sex:%s,age:%d\n", name->valuestring, sex->valuestring, age->valueint);
cJSON_Delete(json); //释放内存
}
解析嵌套的 Json 对象
int main()
{
char *s = "{\"list\":{\"name\":\"hou\",\"age\":24},\"other\":{\"name\":\"qiushi\"}}";
cJSON *root = cJSON_Parse(s);
if(!root)
{
printf("get root faild !\n");
return -1;
}
cJSON *js_list = cJSON_GetObjectItem(root, "list");
if(!js_list)
{
printf("no list!\n");
return -1;
}
printf("list type is %d\n",js_list->type);
cJSON *name = cJSON_GetObjectItem(js_list, "name");
if(!name)
{
printf("No name !\n");
return -1;
}
printf("name type is %d\n",name->type);
printf("name is %s\n",name->valuestring);
cJSON *age = cJSON_GetObjectItem(js_list, "age");
if(!age)
{
printf("no age!\n");
return -1;
}
printf("age type is %d\n", age->type);
printf("age is %d\n",age->valueint);
cJSON *js_other = cJSON_GetObjectItem(root, "other");
if(!js_other)
{
printf("no list!\n");
return -1;
}
printf("list type is %d\n",js_other->type);
cJSON *js_name = cJSON_GetObjectItem(js_other, "name");
if(!js_name)
{
printf("No name !\n");
return -1;
}
printf("name type is %d\n",js_name->type);
printf("name is %s\n",js_name->valuestring);
if(root)
{
cJSON_Delete(root);
}
return 0;
}
解析 Json 数组
int main(int argc, char **argv)
{
char *s = "{\"names\":[\"hou\",\"cai\"]}";
cJSON *root = cJSON_Parse(s);
if(!root)
{
printf("get root faild !\n");
return -1;
}
cJSON *js_list = cJSON_GetObjectItem(root, "names");
if(!js_list)
{
printf("no list!\n");
return -1;
}
int array_size = cJSON_GetArraySize(js_list);
printf("array size is %d\n",array_size);
for(int i=0; i< array_size; i++)
{
cJSON *item = cJSON_GetArrayItem(js_list, i);
printf("item type is %d\n",item->type);
printf("%s\n",item->valuestring);
}
if(root)
{
cJSON_Delete(root);
}
return 0;
}
解析嵌套的 Json 对象和数组
- 根节点是一个 Json 对象,基于根节点中的 key 值取出对应的 value 值,得到一个 Json 数组.
- 读出 Json 数组的大小,遍历里边的各个元素,每个元素都是一个 Json 对象.
- 将 Json 对象中的键值对根据 key 值取出对应的 value 值.
- 从取出的 Value 值中读出实际类型对应的数值.
#include "cJSON.h"
#include <stdio.h>
#include <stdlib.h>
int main(int argc, char **argv)
{
char *s = "{\"list\":[{\"name\":\"luffy\",\"age\":19},{\"name\":\"sabo\",\"age\":21}]}";
cJSON *root = cJSON_Parse(s);
if(!root)
{
printf("get root faild !\n");
return -1;
}
cJSON *list = cJSON_GetObjectItem(root, "list");
if(!list)
{
printf("no list!\n");
return -1;
}
int array_size = cJSON_GetArraySize(list);
printf("array size is %d\n",array_size);
for(int i=0; i< array_size; i++)
{
cJSON* item = cJSON_GetArrayItem(list, i);
cJSON* name = cJSON_GetObjectItem(item, "name");
printf("name is %s\n",name->valuestring);
cJSON* age = cJSON_GetObjectItem(item, "age");
printf("age is %d\n",age->valueint);
}
if(root)
{
cJSON_Delete(root);
}
return 0;
}