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

前端之家收集整理的这篇文章主要介绍了【C-Coding】cJSON使用以及在stm32中的应用前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

1. cJSON使用

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

对于JSON以及Cjson的介绍,可以参考上一篇博文<JSON以及cJSON介绍>,下面以一个例程来简单介绍一下如何使用cJSON进行JSON数据格式的解析以及封装,如下为主函数
  1. #include <stdio.h>
  2. #include <stdlib.h>
  3. #include "cJSON.h" // 将cJSON.c、cJSON.h放到工程目录下,并包含头文件
  4. int main(void)
  5. {
  6. char *packtext; // 字符指针,用于接收JSON封装之后所转换的字符串
  7. char parsetext[] = // 初始化定义一个字符串,用于JSON的解析
  8. "{\n"
  9. "\"state\":{\n"
  10. "\"desired\":{\n"
  11. "\"message\":\"Hello,cJSON!\"\n"
  12. "},\n"
  13. "\"reported\":{\n"
  14. "\"int_data\":1999,\n"
  15. "\"double_data\":6.666\n"
  16. "}\n"
  17. "},\n"
  18. "\"version\":1234\n"
  19. "}\n";
  20. printf("\n");
  21. parseJSON(parsetext); // JSON解析函数
  22. printf("\n---------------------- Repack the JSON ------------------\n\n");
  23. packtext = packJSON(); // JSON解析函数
  24. parseJSON(packtext);
  25. printf("\n");
  26. return 0;
  27. }
运行结果


1.1 JSON解析

这里先介绍cJSON中对于JSON格式的解析;可以看到,在主函数main中定义了一个字符数组 parsetext,其本质上就是一个JSON的字符串(在实际的stm32系统中,是通过串口与通信模块传输的),所以在对该JSON进行解析的时候,首先需要将其转换为JSON对象的格式,然后才能使用JSON的key来进行数据的读取操作,以下是对于形式如parsetext的JSON格式的数据解析函数

  1. /* Parse text to JSON,then render back to text,and print! */
  2. void parseJSON(char *text)
  3. {
  4. // 变量的定义
  5. int jversion = 0;
  6. int jint_data = 0;
  7. char *out = NULL;
  8. char *jmessage = NULL;
  9. double jdouble_data = 0;
  10. // cJSON指针的定义
  11. cJSON *json = NULL; // root
  12. cJSON *jver = NULL,*jsta = NULL; // first
  13. cJSON *jdes = NULL,*jrep = NULL; // second
  14. cJSON *jmes = NULL,*jint = NULL,*jdou = NULL; // third
  15.  
  16. json = cJSON_Parse(text); // 将字符串处理成JSON对象
  17. if (!json) // 如果转化错误,则报错退出
  18. {
  19. printf("Error before: [%s]\n",cJSON_GetErrorPtr());
  20. }
  21. else
  22. {
  23. /* print the json */
  24. out = cJSON_Print(json); // first string print 将JSON对象“按照格式”打印输出
  25. printf("%s\n",out);
  26.  
  27. out = cJSON_PrintUnformatted(json); // second string print将JSON对象“无格式”打印输出
  28. printf("%s\n",out);
  29. /* get the version of the json */
  30. jver = cJSON_GetObjectItem(json,"version"); //获取JSON格式中,键值为”version”的对象
  31. jversion = jver->valueint; // 读取 version的值,version值为整型数
  32. printf("(1) version: %d\n",jversion);
  33. /* get the state->desired->message of the json */
  34. jsta = cJSON_GetObjectItem(json,"state"); //获取JSON格式中,键值为”state”的对象
  35. jdes = cJSON_GetObjectItem(jsta,"desired"); //获取JSON格式中,键值为”desired”的对象
  36. jmes = cJSON_GetObjectItem(jdes,"message");//获取JSON格式中,键值为”message”的对象
  37. jmessage = jmes->valuestring; // 读取 message的值,message为字符串
  38. printf("(2) The message of desired in state is: %s\n",jmessage);
  39. /* get the state->reported value of the json */
  40. jrep = cJSON_GetObjectItem(jsta,"reported"); //获取JSON格式中,键值为”reported”的对象
  41. jint = cJSON_GetObjectItem(jrep,"int_data"); //获取JSON格式中,键值为”int_data”的对象
  42. jdou = cJSON_GetObjectItem(jrep,"double_data");//获取JSON格式中,键值为”double_data”的对象
  43. jint_data = jint->valueint; // 读取int_data的值
  44. jdouble_data = jdou->valuedouble; // 读取double_data的值
  45. printf("(3) int_data = %d,double_data = %f \n"\,jint_data,jdouble_data);
  46.  
  47. cJSON_Delete(json); // 释放内存
  48. free(out);
  49. }
  50. }

在上面的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封装

  1. /* Pack the JSON as the parseJSON,return the char pointer of the JSON string */
  2. char *packJSON()
  3. {
  4. cJSON *root,*staj,*desj,*repj; // cJSON指针
  5. char *out;
  6.  
  7. root=cJSON_CreateObject(); // 创建root对象,返回值为cJSON指针
  8. staj=cJSON_CreateObject();
  9. desj=cJSON_CreateObject();
  10. repj=cJSON_CreateObject();
  11.  
  12. cJSON_AddItemToObject(staj,"desired",desj); // 向staj中添加一个对象 desj
  13. cJSON_AddStringToObject(desj,"message","cJSON Test!");// 向desj中添加一个字符串,键为“message”,键值为“cJSON Test!”
  14. cJSON_AddItemToObject(staj,"reported",repj);
  15. cJSON_AddNumberToObject(repj,"int_data",9999); // 向repj中添加一个整数,键为“int_data”,键值为“9999”
  16.  
  17. cJSON_AddNumberToObject(repj,"double_data",8.888); // 向repj中添加一个浮点数,键为“double_data”,键值为“8.888”
  18.  
  19. cJSON_AddItemToObject(root,"state",staj); //将staj对象添加到 root中,键为“state”
  20. cJSON_AddNumberToObject(root,"version",4321); // 向root中添加整数,键为“version”,键值为4321
  21.  
  22. out = cJSON_Print(root); // 将 root 转化为普通字符串,并返回指针
  23. cJSON_Delete(root); //释放内存
  24. return out;
  25. }

在上面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中需要修改的地方

  1. static void *(*cJSON_malloc)(size_t sz)= malloc;
  2. static void (*cJSON_free)(void *ptr) = free;
  3. ----------------------------------- modify -------------------------------------
  4. static void *(*cJSON_malloc)(size_t sz)= mymalloc; // modify
  5. static void (*cJSON_free)(void *ptr) = myfree; // modify
  1. void cJSON_InitHooks(cJSON_Hooks* hooks)
  2. {
  3. if (!hooks)
  4. { /* Reset hooks */
  5. cJSON_malloc = malloc;
  6. cJSON_free = free;
  7. return;
  8. }
  9. cJSON_malloc = (hooks->malloc_fn)?hooks->malloc_fn:malloc;
  10. cJSON_free = (hooks->free_fn)?hooks->free_fn:free;
  11. }
  12. ----------------------------------- modify -------------------------------------
  13. void cJSON_InitHooks(cJSON_Hooks* hooks)
  14. {
  15. if (!hooks)
  16. { /* Reset hooks */
  17. cJSON_malloc = mymalloc; // modify
  18. cJSON_free = myfree; // modify
  19. return;
  20. }
  21. cJSON_malloc = (hooks->malloc_fn)?hooks->malloc_fn:mymalloc; // modify
  22. cJSON_free = (hooks->free_fn)?hooks->free_fn:myfree; // modify
  23. }

(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内存管理函数

猜你在找的Json相关文章