cJSON的简介
JSON(JavaScript Object Notation)是一种轻量级的文本数据交换格式,易于让人阅读。同时也易于机器解析和生成。尽管JSON是Javascript的一个子集,但JSON是独立于语言的文本格式,并且采用了类似于C语言家族的一些习惯。
JSON 名称/值对
基于方便引用的考虑,我们希望这个JSON解析库是用C语言实现的。同时,为了避免太过复杂的C源码包含关系,希望最好是一个C文件来实现。通过在网络上的查找,发现cJSON是比较符合要求的。cJSON只有一个C文件,一个头文件,包含到项目源码中非常方便,而且其实现效率也是非常高的。
1.JSON指的是JavaScript对象表示法(JavaScript Object Notation)
2.JSON是轻量级的文本数据交换格式
3.JSON独立于语言
4.JSON具有自我描述性,更易理解
5.JSON 使用 JavaScript 语法来描述数据对象,但是 JSON仍然独立于语言和平台。JSON 解析器和 JSON 库支持许多不同的编程语言。
JSON语法简单来说就是四条
JSON 语法是 JavaScript 对象表示语法的子集。
数据在名称/值对中
数据由逗号分隔
大括号 {} 保存对象
中括号 [] 保存数组,数组可以包含多个对象
JSON 数据的书写格式是:
key : value
名称/值对包括字段名称(在双引号中),后面写一个冒号,然后是值:
"name" : "张三"
这很容易理解,等价于这条 JavaScript 语句:
name = "张三"
JSON 数字
JSON 数字可以是整型或者浮点型:
{ "age":30 }
JSON 对象
JSON 对象在大括号 {} 中书写:
{key1 : value1, key2 : value2, ... keyN : valueN }
对象可以包含多个名称/值对:
{ "name":"百度" , "url":"www.baibu.com" }
JSON 数组
JSON 数组在中括号[ ] 中书写:
数组可包含多个对象:
{
"sites": [
{ "name":"百度" , "url":"www.baidu.com" },
{ "name":"google" , "url":"www.google.com" },
{ "name":"阿里云" , "url":"www.alyun.com" }
]
}
cJSON库下载
git clone https://github.com/DaveGamble/cJSON.git
下载完成后进入文件夹可以看到cJSON.c cJSON.h二个.c文件.
把这两个放入你的项目中即可。编译时加上选项-lm因为cJSON源码中用到了math库。或者可以直接链接动态库和静态库.(运行make)
cJSON库函数
cJSON的核心结构体就是一个cJSON,理解了这个结构体,基本上对cJSON的使用就有了个基本概念了,该结构体具体定义如下:
typedef struct cJSON
{
struct cJSON*next,*prev; /* 遍历数组或对象链的前向或后向链表指针*/
struct cJSON *child; /*数组或对象的孩子节点*/
int type; /* key的类型*/
char *valuestring; /*字符串值*/
int valueint; /* 整数值*/
double valuedouble; /* 浮点数值*/
char *string; /* key的名字*/
} cJSON;
说明:
1.cJSON是使用链表来存储数据的,其访问方式很像一棵树。每一个节点可以有兄弟节点,通过next/prev指针来查找,它类似双向链表;每个节点也可以有孩子节点,通过child指针来访问,进入下一层。只有节点是对象或数组时才可以有孩子节点。
2.type是键(key)的类型,一共有种取值,分别是:False,True,null,Number,String,Array,Object。
若是Number类型,则valueint或valuedouble种存储着值,如期望的是int,则访问valueint,如期望的是double,则访问valuedouble,可以得到值。
若是String类型的,则valuestring中存储着值,可以访问valuestring得到值。
3.string中存放的是这个节点的名字,可以理解位key的名称。
CJSON库常用库函数
cJSON *cJSON_CreateObject();
//创建一个json对象,返回一个cJSON结构体类型的指针。
cJSON *cJSON_CreateArray();
//创建一个数组对象,返回一个cJSON结构体类型的指针。
cJSON *cJSON_CreateString(const char *string);
//创建一个字符串对象,传入一个char *类型的字符串,返回一个cJSON结构体类型的指针。
extern cJSON *cJSON_CreateNumber(double num);
// 创建一个数值类型。
void cJSON_AddItemToArray(cJSON *array, cJSON *item);
//向数组对象中添加一个元素,传入参数array为cJSON *结构体类型的指针,为数组对象,item为添加如数字对象中的对象指针。
void cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);
//向json对象中添加一对元素,object为json对象,string为加入一对元素中的name,item为加入一对元素中的value。
char *cJSON_Print(cJSON *item);
//将一个cJSON结构体代表的json对象转换为一个json格式的字符串。
void cJSON_Delete(cJSON *c)
//释放一个cJSON对象占用的内存空间。
测试代码
#include <stdio.h>
#include "cJSON.h"
int main()
{
cJSON*root = cJSON_CreateObject();
cJSON *item = cJSON_CreateObject();
cJSON_AddItemToObject(root, "MQTT",cJSON_CreateString("MQTT->ID"));
cJSON_AddItemToObject(root, "id",cJSON_CreateString("Yangpeng"));
cJSON_AddItemToObject(root, "params",cJSON_CreateString("666"));
cJSON_AddItemToObject(root, "temperature",cJSON_CreateNumber("30"));
char *msg = cJSON_Print(root);
printf("%s\n",msg);
cJSON_Delete(root);
return 0;
}