cJSON使用以及在stm32中的应用

1. cJSON使用

最近一段时间在整理本身进入研究生阶段后学习过程当中的一些内容，以前在进行相关代码调试过程当中，也的确耗费了比较大的精力去搜寻资料，而后整合代码到本身所须要的系统中，如在stm32中使用cJSON格式，因为stm32的资源较小，而JSON格式用C语言实现又比较耗费资源，因此在调试的过程当中，要及时释放内存空间。下面简单总结一下在stm32中使用cJSON的经验，时间比较久了，不免有所疏漏，望各位大神指正！另外，在学习总结博客的过程当中，参考了不少网上的博客、文章，在此致以深深的谢意！

对于JSON以及Cjson的介绍，能够参考上一篇博文<JSON以及cJSON介绍>，下面以一个例程来简单介绍一下如何使用cJSON进行JSON数据格式的解析以及封装，以下为主函数：
#include <stdio.h>
#include <stdlib.h>
#include "cJSON.h" // 将cJSON.c、cJSON.h放到工程目录下，并包含头文件
int main(void)
{
char *packtext; // 字符指针，用于接收JSON封装以后所转换的字符串
char parsetext[] = // 初始化定义一个字符串，用于JSON的解析
"{\n"
"\"state\":{\n"
"\"desired\":{\n"
"\"message\":\"Hello,cJSON!\"\n"
"},\n"
"\"reported\":{\n"
"\"int_data\":1999,\n"
"\"double_data\":6.666\n"
"}\n"
"},\n"
"\"version\":1234\n"
"}\n";
printf("\n");
parseJSON(parsetext); // JSON解析函数
printf("\n---------------------- Repack the JSON ------------------\n\n");
packtext = packJSON(); // JSON解析函数
parseJSON(packtext);
printf("\n");
return 0;
}
运行结果

1.1  JSON解析

这里先介绍cJSON中对于JSON格式的解析；能够看到，在主函数main中定义了一个字符数组 parsetext，其本质上就是一个JSON的字符串（在实际的stm32系统中，是经过串口与通讯模块传输的），因此在对该JSON进行解析的时候，首先须要将其转换为JSON对象的格式，而后才能使用JSON的key来进行数据的读取操做，如下是对于形式如parsetext的JSON格式的数据解析函数：

/* Parse text to JSON, then render back to text, and print! */
void parseJSON(char *text)
{
// 变量的定义
int jversion = 0;
int jint_data = 0;
char *out = NULL;
char *jmessage = NULL;
double jdouble_data = 0;
// cJSON指针的定义
cJSON *json = NULL; // root
cJSON *jver = NULL, *jsta = NULL; // first
cJSON *jdes = NULL, *jrep = NULL; // second
cJSON *jmes = NULL, *jint = NULL, *jdou = NULL; // third

json = cJSON_Parse(text); // 将字符串处理成JSON对象
if (!json) // 若是转化错误，则报错退出
{
printf("Error before: [%s]\n", cJSON_GetErrorPtr());
}
else
{
/* print the json */
out = cJSON_Print(json); // first string print 将JSON对象“按照格式”打印输出
printf("%s\n", out);

out = cJSON_PrintUnformatted(json); // second string print将JSON对象“无格式”打印输出
printf("%s\n", out);

/* get the version of the json */
jver = cJSON_GetObjectItem(json,"version"); //获取JSON格式中，键值为”version”的对象
jversion = jver->valueint; // 读取 version的值，version值为整型数
printf("(1) version: %d\n",jversion);

/* get the state->desired->message of the json */
jsta = cJSON_GetObjectItem(json,"state"); //获取JSON格式中，键值为”state”的对象
jdes = cJSON_GetObjectItem(jsta,"desired"); //获取JSON格式中，键值为”desired”的对象
jmes = cJSON_GetObjectItem(jdes,"message");//获取JSON格式中，键值为”message”的对象
jmessage = jmes->valuestring; // 读取 message的值，message为字符串
printf("(2) The message of desired in state is: %s\n",jmessage);

/* get the state->reported value of the json */
jrep = cJSON_GetObjectItem(jsta,"reported"); //获取JSON格式中，键值为”reported”的对象
jint = cJSON_GetObjectItem(jrep,"int_data"); //获取JSON格式中，键值为”int_data”的对象
jdou = cJSON_GetObjectItem(jrep,"double_data");//获取JSON格式中，键值为”double_data”的对象
jint_data = jint->valueint; // 读取int_data的值
jdouble_data = jdou->valuedouble; // 读取double_data的值

printf("(3) int_data = %d , double_data = %f \n"\
,jint_data, jdouble_data);

cJSON_Delete(json); // 释放内存
free(out);
}
}
在上面的JSON解析函数例程中，介绍了cJSON所组成的JSON结构的解析，其中对于嵌套的JSON结构，只须要一层一层的剥开便可。如下对几个主要函数进行总结（能够参考【4】【5】）：

（1）cJSON_Parse函数能够将字符串解析为JSON数据包，并按照cJSON结构体的结构序列化整个数据包。使用该函数会经过malloc函数在内存中开辟一个空间，使用完成须要手动释放；

（2）cJSON_GetObjectItem函数可从cJSON结构体中查找某个子键名称，若是查找成功可把该子节点序列化到cJSON结构体中；

（3）若是须要使用cJSON结构体中的内容，可经过cJSON结构体中的valueint、valuedouble和valuestring取出有价值的内容（即键的值）；

（4）cJSON_Delete函数用于释放JSON所占的内存空间；

（5） JSON 格式的数据，本质上是一个字符串，但这个时候没法当成普通的字符串进行使用，须要调用 cJSON_PrintUnformatted(json) 或者 cJSON_Print(json)将JSON对象转换成普通的字符串，而且都是以该json对象的根为基点。其中二者的区别便是：一个是没有格式的：也就是转换出的字符串中间不会有"\n" "\t"之类的东西存在，在串传输的时候，使用“无格式”，而cJSON_Print(json)打印出来是人看起来舒服、明了的JSON格式。

1.2  JSON封装

/* Pack the JSON as the parseJSON, return the char pointer of the JSON string */
char *packJSON()
{
cJSON *root,*staj,*desj,*repj; // cJSON指针
char *out;

root=cJSON_CreateObject(); // 建立root对象，返回值为cJSON指针
staj=cJSON_CreateObject();
desj=cJSON_CreateObject();
repj=cJSON_CreateObject();

cJSON_AddItemToObject(staj, "desired", desj); // 向staj中添加一个对象 desj
cJSON_AddStringToObject(desj, "message", "cJSON Test!");// 向desj中添加一个字符串，键为“message”，键值为“cJSON Test!”
cJSON_AddItemToObject(staj, "reported", repj);
cJSON_AddNumberToObject(repj, "int_data",9999); // 向repj中添加一个整数，键为“int_data”，键值为“9999”

cJSON_AddNumberToObject(repj, "double_data",8.888); // 向repj中添加一个浮点数，键为“double_data”，键值为“8.888”

cJSON_AddItemToObject(root, "state", staj); //将staj对象添加到 root中，键为“state”
cJSON_AddNumberToObject(root, "version", 4321); // 向root中添加整数，键为“version”，键值为4321

out = cJSON_Print(root); // 将 root 转化为普通字符串，并返回指针

cJSON_Delete(root); //释放内存
return out;
}
在上面JSON封装的例程中，介绍了如何使用cJSON封装相似于parsetext的JSON数据，并向其中的键赋值，下面简单介绍一下主要使用的函数：

（1）cJSON_CreateObject函数用于建立一个JSON对象，返回值为一个指向所建立JSON的cJSON指针，使用完成后，注意要使用cJSON_Delete函数进行内存的释放；

（2）cJSON_AddItemToObject函数用于向JSON对象中添加一个对象，而且指定了对象的键；

（3）cJSON_AddStringToObject函数用于向JSON对象中添加一个字符串，而且指定了字符串的键以及键值；

（4）cJSON_AddNumberToObject函数用于向JSON对象中添加一个数据，能够是整型数，也能够是浮点数。

OK，对于cJSON的使用就先介绍这么多了；另外，看其余资料，还可使用Cjson结构体中的type来进行对键的判断（对象、数、字符串等）。

2.  cJSON在stm32中的使用

对于cJSON的使用，主要是用来实现stm32链接一个上网模块来与云平台进行交互，而云平台上面所解析的数据格式是JSON格式，所以在stm32中，须要实现将数据封装成JSON格式，而后经过串口将数据由上网模块（WiFi、LTE等）上报给云平台。

cJSON是由C语言所编写的，因此理论上是能够跨平台使用的，可是因为stm32中内存资源的限制，所以在使用完JSON结构数据以后，要尽快释放内存；另外，还须要对 malloc、free、以及size_t等进行从新定义，其中，对于malloc以及free的修改以下：

（1）  cJSON.c中须要修改的地方

static void *(*cJSON_malloc)(size_t sz)= malloc; static void (*cJSON_free)(void *ptr) = free; ----------------------------------- modify -------------------------------------static void *(*cJSON_malloc)(size_t sz)= mymalloc; // modifystatic void (*cJSON_free)(void *ptr) = myfree; // modifyvoid cJSON_InitHooks(cJSON_Hooks* hooks){ if (!hooks) { /* Reset hooks */ cJSON_malloc = malloc; cJSON_free = free; return; } cJSON_malloc = (hooks->malloc_fn)?hooks->malloc_fn:malloc; cJSON_free = (hooks->free_fn)?hooks->free_fn:free; }----------------------------------- modify -------------------------------------void cJSON_InitHooks(cJSON_Hooks* hooks){ if (!hooks) { /* Reset hooks */ cJSON_malloc = mymalloc; // modify cJSON_free = myfree; // modify return; } cJSON_malloc = (hooks->malloc_fn)?hooks->malloc_fn:mymalloc; // modify cJSON_free = (hooks->free_fn)?hooks->free_fn:myfree; // modify }