【C-Coding】cJSON使用以及在stm32中的应用

分类：Json作者：编程之家用户

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;      // modify
static void (*cJSON_free)(void *ptr) = myfree;          // modify

void 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 
}

（2） 对于malloc、free函数的重构，可以参考正点原子对于stm32中内存管理函数，可以参考【6】。

3. Reference

【1】https://github.com/DaveGamble/cJSON cJSON的github

【2】http://www.cnblogs.com/kuikui/p/3176806.html JSON介绍

【3】http://www.jb51.cc/article/p-odrmzwtl-bch.html JSON格式详解

【4】http://www.jb51.cc/article/p-vbtrbyni-bch.html cJSON学习笔记

【5】 http://www.cnblogs.com/chineseboy/p/3959852.html cJSON使用笔记（stm32）

【6】 http://openedv.com/thread-954-1-1.html 正点原子stm32内存管理函数

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 dio@foxmail.com 举报，一经查实，本站将立刻删除。

相关推荐

优化cesium里的热力图
文章浏览阅读2.4k次。最近要优化cesium里的热力图效果，浏览了网络上的各种方法，发现大多是贴在影像上的。这么做好是好，但是会被自生添加的模型或者其他数据给遮盖。其次是网上的方法大多数是截取成一个矩形。不能自定义的截取自己所需要的。经过尝试，决定修改下cesium heatmap，让他达到我们需要的要求。首先先下载 cesium heatmap包。其中我们可以看到也是通过叠加entity达到添加canvas的方法绘制到地图上。我们先把这一段代码注释} else {} };
python读写json文件方法详解
文章浏览阅读1.2w次，点赞3次，收藏19次。在 Python中读取 json文件也可以使用 sort （）函数，在这里我介绍一个简单的示例程序： （4）如果我们想将字符串转换为列表形式，只需要添加一个变量来存储需要转换的字符串即可。在上面的代码中，我们创建了一个名为` read`的对象，然后在文件的开头使用`./`关键字来命名该对象，并在文件中定义了一个名为` json`的变量，并在其中定义了一个名为` json`的字段。比如，我们可以使用 read方法读取 json文件中的内容，然后使用 send方法将其发送到 json文件中。_python怎么读取json文件
Python API：它是什么以及如何使用它
文章浏览阅读1.4k次。首字母缩略词 API 代表应用程序编程接口，它是一种设备，例如用于使用编程代码发送和检索数据的服务器。最常见的是，该技术用于从源检索数据并将其显示给软件应用程序及其用户。当您访问网页时，API 的工作方式与浏览器相同，信息请求会发送到服务器，如何在 Windows PC 中手动创建系统还原点服务器会做出响应。唯一的区别是服务器响应的数据类型，对于 API，数据是 JSON 类型。JSON 代表 JavaScript Object Notation，它是大多数软件语言中 API 的标准数据表示法。_api是什么 python
解决一个JSON反序列化问题-空字符串变为空集合
文章浏览阅读802次，点赞10次，收藏10次。解决一个JSON反序列化问题-空字符串变为空集合_cannot coerce empty string ("") to element of `java.util.arraylist
Untiy Json和Xml的序列化和反序列化
文章浏览阅读882次。Unity Json和Xml的序列化和反序列化_unity json反序列化存储换行
使用ant design vue的a-upload上传组件，自定义上传事件，点了导入图标按钮就自动打开了电脑上的文件夹，将选中的.json文件里的数据解析出来页面使用（纯前端操作）
文章浏览阅读796次。reader.readAsText(data.file)中data.file的数据格式为。使用FileReader对象读取文件内容，最后将文件内容进行处理使用。_a-upload 同时支持文件和文件夹
json解析之fastjson和jackson使用对比
文章浏览阅读775次，点赞19次，收藏10次。fastjson是由国内的阿里推出的一种json处理器，由java语言编写，无依赖，不需要引用额外的jar包，能直接运行在jdk环境中，它的解析速度是非常之快的，目前超过了所有json库。提示：以下是引用fastjson的方法，数据未涉及到私密信息。_解析器用fastjson还是jackson
【Qt之JSON文件】QJsonDocument、QJsonObject、QJsonArray等类介绍及使用
文章浏览阅读940次。【Qt之JSON文件】QJsonDocument、QJsonObject、QJsonArray等类介绍及使用_使用什么方法检查qjsondocument是否为空
ajax与 JSON
文章浏览阅读957次，点赞34次，收藏22次。主要内容原生 ajax重点重点JSON熟悉章节目标掌握原生 ajax掌握jQuery ajax掌握JSON第一节 ajax1. 什么是ajaxAJAX 全称为，表示异步的Java脚本和Xml文件，是一种异步刷新技术。2. 为什么要使用ajaxServlet进行网页的变更往往是通过请求转发或者是重定向来完成，这样的操作更新的是整个网页，如果我们只需要更新网页的局部内容，就需要使用到AJAX来处理了。因为只是更新局部内容，因此，Servlet。
@JsonFormat与@DateTimeFormat
文章浏览阅读1.4k次，点赞45次，收藏13次。主要介绍了JsonFormat与@DateTimeFormat注解实例解析,文中通过示例代码介绍的非常详细，对大家的学习 或者工作具有一定的参考学习价值,需要的朋友可以参考下 这篇文章主要介绍了从数据库获取时间传到前端进行展示的时候，我们有时候可能无法得到一个满意的时间格式的时间日期，在数据库中显 示的是正确的时间格式，获取出来却变成了时间戳，@JsonFormat注解很好的解决了这个问题，我们通过使用 @JsonFormat可以很好的解决：后台到前台时间格式保持一致的问题，
@JsonDeserialize和@JsonSerialize注解的使用
文章浏览阅读1k次。JsonDeserialize：json反序列化注解，作用于setter()方法，将json数据反序列化为java对象。可以理解为用在处理接收的数据上。_jsondeserialize
labelme标注的json文件转yolo格式
文章浏览阅读2.7k次。labelme标注的json文件是在数据标注时产生，不能直接应用于模型训练。各大目标检测训练平台或项目框架均有自己的数据格式要求，通常为voc、coco或yolo格式。由于yolov8项目比较火热，故此本博文详细介绍将json格式标注转化为yolo格式的过程及其代码。_labelme json 转 yolo
mysql聚合函数andjson_object 例子
文章浏览阅读790次，点赞26次，收藏6次。GROUP_CONCAT_UNORDERED(): 与GROUP_CONCAT类似，但不保证结果的顺序。COUNT_DISTINCT_AND_ORDERED(): 计算指定列的不同值的数量，并保持结果的顺序。COUNT_ALL_DISTINCT(): 计算指定列的所有不同值的数量（包括NULL）。AVG_RANGE(): 计算指定列的最大值和最小值之间的差异的平均值。JSON_OBJECT(): 将结果集中的行转换为JSON对象。COUNT_DISTINCT(): 计算指定列的不同值的数量。_mysql json 聚合
ajax同步与异步,json-serve的安装与使用,node.js的下载
文章浏览阅读1.2k次。ajax同步与异步,json-serve的安装与使用,node.js的下载_json-serve 与node版本
C# 操作json
文章浏览阅读1.7k次。`.net core`提供了Json处理模块，在命名空间`System.Text.Json`中，下面通过顶级语句，对C#的Json功能进行讲解。_c# json
python之json文件读写操作
文章浏览阅读2.8k次。主要介绍了python对于json文件的读写操作内容_python读取json文件
Json中文乱码问题的解决方法——C#实现
文章浏览阅读770次。然而，有时候在处理包含中文字符的Json数据时会出现乱码的情况。本文将介绍一种解决Json中文乱码问题的常见方法，并提供相应的源代码和描述。而某些情况下，中文字符可能会被错误地编码或解码，导致乱码的出现。通过适当地控制编码和解码过程，我们可以有效地处理包含中文字符的Json数据，避免乱码的发生。通过控制编码和解码过程，我们可以确保Json数据中的中文字符能够正确地传输和解析。为了解决这个问题，我们可以使用C#的System.Text.Encoding类提供的方法进行编码和解码的控制。_c# json 中文编码
【工具】XML和JSON互相转换
文章浏览阅读997次。【代码】【工具】XML和JSON互相转换。_xml 转json
jsonpath提取数据
文章浏览阅读1.1k次。json path 提取数据_jsonpath数组取值
pandas read_json时ValueError: Expected object or value的解决方案
文章浏览阅读3w次，点赞35次，收藏36次。本文主要介绍了pandas read_json时ValueError: Expected object or value的解决方案，希望能对学习python的同学们有所帮助。文章目录1. 问题描述2. 解决方案_valueerror: expected object or value
pythonJavaScriptjavaHTMLPHPreactjsC#AndroidCSSNode.jssqlrpython-3.xMysqLjQueryc++pandasFlutterangularIOSdjangolinuxswifttypescript路由器JSON路由器设置无线路由器h3c华三华三路由器设置华三路由器电脑软件教程arraysdocker软件图文教程Cvue.jslaravelspring-boot