cjson：json字符串的理解

一、cjson概念
cJSON是一款开源的轻量级数据格式解析封装库&＃xff0c;在嵌入式中的应用场景是非常多的&＃xff0c;其中就有我们日常使用的天气&＃xff0c;还有很多公司让cJSON和MQTT协议相结合&＃xff0c;终端用它来向服务器上报参数、日志信息或者服务器向终端发送指令。这就需要用到cJSON来将这串字符串解析成我们需要的数据&＃xff0c;或者将需要上报的信息封装成cJSON格式&＃xff0c;这样相互通信的两端才能得到自己想要的数据。过一个具体的例子来说明一下&＃xff0c;首先去官网把这个库下载下来&＃xff0c;官网的地址&＃xff1a;https://sourceforge.net/projects/cjson/&＃xff0c;下载下来后有两个文件是需要提取出来的就是cJSON.c和cJSON.h。然后通过GET请求接收一段天气的内容。具体的GET请求涉及到socket网络编程和HTTP协议。
JSON里面主要是按照键值对&＃xff08;key : value&＃xff09;的方式来存储数据的&＃xff0c;所以我们提取数据就按照键的名字直接提取&＃xff0c;存入数据&＃xff0c;就将想要存入的数据取一个名字&＃xff08;即字符串&＃xff09;然后放到JSON结构体里面就可以了。
这是一个典型的JSON结构体&＃xff0c;我们可以看到&＃xff0c;键名为“name”的值对应为"John Doe"&＃xff0c;而键名“address”的值则是一个用大括号括起来的数据&＃xff0c;这是区别于c语言的一种数据类型&＃xff0c;我们把它叫做对象。
给出一个json例子&＃xff0c;让大家有个体会&＃xff1a;
{
“name”: “John Doe”,
“age”: 18,
“address”: {“country” : “china”, “zip-code”: “10000”}
}

二、json是干什么的
其实使用CJSON和JSON其实只是为了干一件事&＃xff1a;那就是解析收到的数据和发送对方能够解析的数据&＃xff0c;那么cjson就是我们用的工具&＃xff0c;我们用这个工具来编辑和解析JSON格式的数据。

三、json数据分类
作为熟悉C语言的大家&＃xff0c;json其实只有两种区别于c语言的数据类型&＃xff0c;我们看看这两种就可以啦。
1、对象&＃xff1a;json数据的主要单位&＃xff0c;也就是一个用大括号括起来的数据&＃xff0c;他包含的所有数据是各种键值对&＃xff0c;键值对之间用逗号加以区分。注意我们用cjson操作时&＃xff0c;也主要是对对象的操作
2、键值对&＃xff1a;json数据的基本单位&＃xff0c;键值对的键名必须是一个字符串&＃xff0c;而键值则可以是int,double,string,array等各种数据。中间用冒号链接。
例如&＃xff1a;
/**对象/
//对象:用大括号括起来的数据&＃xff1a;
{“name”:“hello”}

/*键值对/
//数组&＃xff1a;用中括号括起来的数据&＃xff1a;
{“array”:[1,2,3]}
//字符串键值对
“key”:“value”
//number键值对
“number”:2

四、json数据如何传输
我们现在已经知道json数据是一个结构体&＃xff0c;那么如何传输结构体了&＃xff1f;要知道&＃xff0c;数据在网络或者无线通信中传输的都是二进制数据&＃xff0c;我们如果要按照特殊的通讯协议来传输的话&＃xff0c;我们就要按照这个协议解析。所以按照这个规则&＃xff0c;我们直接双方都采用json格式的数据&＃xff0c;然后采用相同的方式解析就可以啦。
这种方式大家都非常熟悉&＃xff0c;我们直接将JSON数据转换成为字符串&＃xff0c;然后传输&＃xff0c;之后将字符串解析成JSON数据就可以啦。

五、cjson结构体
/* The cJSON structure: */
typedef struct cJSON
{
//这些不用管
struct cJSON *next;
struct cJSON *prev;
struct cJSON *child;

//这些都要知道
//该json对象的类型&＃xff0c;可以是字符串&＃xff0c;int&＃xff0c;double…
int type;
/* The item’s string, if typecJSON_String and type &＃61;&＃61; cJSON_Raw */
//如果类型是字符串&＃xff0c;那么键值的字符串的值存在这里
char valuestring;
/ writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead /
//如果类型是int&＃xff0c;那么值存在这里
int valueint;
/ The item’s number, if typecJSON_Number /
//如果类型是double&＃xff0c;那么值存在这里
double valuedouble;
/ The item’s name string, if this item is the child of, or is in the list of subitems of an object. */
//存放名字的地方
char *string;
} cJSON;

六、cjson解析和构造函数
下面都是将JSON结构体转换为字符串数据的操作函数&＃xff1a;
//将CJSON数据转换为字符串&＃xff08;保留原来的格式&＃xff1a;例如会保留空格和回车&＃xff09;
CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);
//将CJSON数据转换为字符串&＃xff08;删除所有格式&＃xff0c;只保留文本&＃xff09;
CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item);
//将CJSON数据转换为字符串&＃xff08;并且存储到一个buffer里面&＃xff09;
CJSON_PUBLIC(char *) cJSON_PrintBuffered(const cJSON *item, int prebuffer, cJSON_bool fmt);
//将CJSON数据转换为字符串&＃xff08;储存到一个动态申请的空间中&＃xff09;
CJSON_PUBLIC(cJSON_bool) cJSON_PrintPreallocated(cJSON *item, char *buffer, const int length, const cJSON_bool format);

下面都是将JSON字符串转换为JSON结构体的操作&＃xff1a;


//将json字符串转换为结构体&＃xff0c;并且将其赋给一个指针
CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value);
//将json字符串转换为结构体&＃xff0c;并且将其赋给一个指针&＃xff0c;这个函数会提供一些操作选项来帮助开发者使用
CJSON_PUBLIC(cJSON *) cJSON_ParseWithOpts(const char *value, const char **return_parse_end, cJSON_bool require_null_terminated);

七、cjson创建键值的两种方法
1、将cjson对象加入&＃xff1a;这个方法关键在于&＃xff0c;首先需要先创建一个对象然后再将他加入进去。
//常用
//将对象加入数组或者对象
CJSON_PUBLIC(void) cJSON_AddItemToArray(cJSON *array, cJSON *item);
CJSON_PUBLIC(void) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);

//按照需求
/* Use this when string is definitely const (i.e. a literal, or as good as), and will definitely survive the cJSON object.

• WARNING: When this function was used, make sure to always check that (item->type & cJSON_StringIsConst) is zero before
• writing to item->string */
  CJSON_PUBLIC(void) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON item);
  / Append reference to item to the specified array/object. Use this when you want to add an existing cJSON to a new cJSON, but don’t want to corrupt your existing cJSON. */
  //这两个就是加入的时候不会覆盖原来的CJSON结构体
  CJSON_PUBLIC(void) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
  CJSON_PUBLIC(void) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item);

2、 直接将键值和名字填入构建为一个键值对&＃xff1a;不需要构建新的结构体。
/* Helper functions for creating and adding items to an object at the same time.

• They return the added item or NULL on failure. /
  //我们想添加什么数据就可以直接添加&＃xff0c;不用另外构建CJSON结构体
  CJSON_PUBLIC(cJSON) cJSON_AddNullToObject(cJSON * const object, const char * const name);
  CJSON_PUBLIC(cJSON*) cJSON_AddTrueToObject(cJSON * const object, const char * const name);
  CJSON_PUBLIC(cJSON*) cJSON_AddFalseToObject(cJSON * const object, const char * const name);
  CJSON_PUBLIC(cJSON*) cJSON_AddBoolToObject(cJSON * const object, const char * const name, const cJSON_bool boolean);
  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*) cJSON_AddRawToObject(cJSON * const object, const char * const name, const char * const raw);
  CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object, const char * const name);
  CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object, const char * const name);

八、cjson获取键值对的方法
从json结构体里面提取我们想要的键值:
/* Returns the number of items in an array (or object). */
//获取数组大小
CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON array);
/ Retrieve item number “index” from array “array”. Returns NULL if unsuccessful. */
//获取数组里面的某一个值
CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON array, int index);
/ Get item “string” from object. Case insensitive. */
//这个函数将某一个键值对&＃xff0c;提取出来放到一个结构体中
CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string);

//以下都不常用
CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string);
CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char string);
/ For analysing failed parses. This returns a pointer to the parse error. You’ll probably need to look a few chars back to make sense of it. Defined when cJSON_Parse() returns 0. 0 when cJSON_Parse() succeeds. */
CJSON_PUBLIC(const char *) cJSON_GetErrorPtr(void);

/* Check if the item is a string and return its valuestring */
CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item);

九、cjson操作实例
我们使用CJSON其实只有两种操作&＃xff1a;
1、构建JSON结构&＃xff0c;然后转换为字符串来发送或者做其他的。
2、解析别人发来的JSON字符串&＃xff0c;然后转换为结构体&＃xff0c;然后读取里面的数据&＃xff0c;找到对应的值

3、创建自己的&＃xff1a;创建、添加、变换
/创建******/
//构建最后用于存放JSON数据的字符串
char * json_buffer &＃61; { 0 };
//首先构造一个根对象指针&＃xff1a;
cJSON* root &＃61; NULL;
//创建String对象指针&＃xff1a;
cJSON* string &＃61; NULL;
//创建int对象指针&＃xff1a;
cJSON* int_number &＃61; NULL;
//创建数组指针&＃xff1a;
cJSON* array &＃61; NULL;
int the_array[3] &＃61; { 1,2,3 };
//创建一个根对象&＃xff0c;给root
root &＃61; cJSON_CreateObject();
//创建一个字符串对象&＃xff0c;给string
string &＃61; cJSON_CreateString(“hello world”);
//创建一个int对象&＃xff0c;给int_number
int_number &＃61; cJSON_CreateNumber(10);
//创建一个array对象&＃xff0c;给array
array &＃61; cJSON_CreateIntArray(the_array, 3);
/添加******/
//将字符串string加入根对象&＃xff0c;成为一个键值对&＃xff1a;

//方法一&＃xff1a;添加对象
cJSON_AddItemToObject(root,"string",string);
//方法二&＃xff1a;直接添加
cJSON_AddStringToObject(root,"string_1","bye world");//添加剩下的
cJSON_AddItemToObject(root,"int_number",int_number);
cJSON_AddItemToObject(root,"array ",array);/***************************变换*********************************/
json_buffer &＃61; cJSON_PrintUnformatted(root);
printf("json_buffer is %s\n", json_buffer);


创建后返回的结果如下&＃xff1a;
json_buffer is {“string”:“hello world”,“string_1”:“bye world”,“int_number”:10,"array ":[1,2,3]}

4、解析收到的&＃xff1a;解析、获取、打印
//JSON字符串
const char* json_str &＃61; “{“name”:“json_test”,“num”:“520”,“arry”:[1,2,3]}”;
cJSON* temp &＃61; 0;
/解析*******/
cJSON* json &＃61; NULL;
cJSON* name &＃61; NULL;
cJSON* num &＃61; NULL;
cJSON* arry &＃61; NULL;

/****************************获取***********************************/
//将字符串解析为一个结构体
json &＃61; cJSON_Parse(json_str);
name &＃61; cJSON_GetObjectItem(json,"name");
num &＃61; cJSON_GetObjectItem(json, "num");
arry &＃61; cJSON_GetObjectItem(json, "arry");printf("name is %s\n", name->valuestring);
printf("num is %d\n", num->valueint);
temp &＃61; cJSON_GetArrayItem(arry, 1);
printf("arry[0] is %d\n", temp->valueint);


解析后返回的结果如下&＃xff1a;
name is json_test
num is 0
arry[0] is 2

十、实例
/** CJSON使用例子

• CJSON template
• Author&＃xff1a;jiang shan (github: jianggogogo)
• date: 2019.12.25
• Note: This file is open to learning.
• licence:
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the “Software”), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
#include “stdio.h”
#include “cJSON.h”
#include “stdlib.h”

//创建一个JSON数据并且转换为字符串
void Create_print()
{
/创建******/
//构建最后用于存放JSON数据的字符串
char* json_buffer &＃61; { 0 };
//首先构造一个根对象指针&＃xff1a;
cJSON* root &＃61; NULL;
//创建String对象指针&＃xff1a;
cJSON* string &＃61; NULL;
//创建int对象指针&＃xff1a;
cJSON* int_number &＃61; NULL;
//创建数组指针&＃xff1a;
cJSON* array &＃61; NULL;
int the_array[3] &＃61; { 1,2,3 };
//创建一个根对象&＃xff0c;给root
root &＃61; cJSON_CreateObject();
//创建一个字符串对象&＃xff0c;给string
string &＃61; cJSON_CreateString(“hello world”);
//创建一个int对象&＃xff0c;给int_number
int_number &＃61; cJSON_CreateNumber(10);
//创建一个array对象&＃xff0c;给array
array &＃61; cJSON_CreateIntArray(the_array, 3);
/添加******/
//将字符串string加入根对象&＃xff0c;成为一个键值对&＃xff1a;

//方法一&＃xff1a;添加对象
cJSON_AddItemToObject(root, "string", string);
//方法二&＃xff1a;直接添加
cJSON_AddStringToObject(root, "string_1", "bye world");//添加剩下的
cJSON_AddItemToObject(root, "int_number", int_number);
cJSON_AddItemToObject(root, "array ", array);/***************************变换*********************************/
json_buffer &＃61; cJSON_PrintUnformatted(root);
printf("json_buffer is %s\n", json_buffer);cJSON_Delete(root);


}

//解析字符串并且读取里面的数据
void prase_print()
{
//JSON字符串
const char* json_str &＃61; “{“name”:“json_test”,“num”:“520”,“arry”:[1,2,3]}”;
cJSON* temp &＃61; 0;
/解析*******/
cJSON* json &＃61; NULL;
cJSON* name &＃61; NULL;
cJSON* num &＃61; NULL;
cJSON* arry &＃61; NULL;

/****************************获取***********************************/
//将字符串解析为一个结构体
json &＃61; cJSON_Parse(json_str);
name &＃61; cJSON_GetObjectItem(json,"name");
num &＃61; cJSON_GetObjectItem(json, "num");
arry &＃61; cJSON_GetObjectItem(json, "arry");printf("name is %s\n", name->valuestring);
printf("num is %d\n", num->valueint);
temp &＃61; cJSON_GetArrayItem(arry, 1);
printf("arry[0] is %d\n", temp->valueint);cJSON_Delete(json);
free(json);


}
int main()
{
printf(“hello world\n”);
Create_print();
return 0;
}