cJSON常用接口详细总结(附测试代码)

1、前言

        项目中常用Json格式的数据进行数据mqtt传输或者配置文件读取等操作,本文将常用接口做简单测试给大家参考。

2、Json格式

2.1 Json结构体格式

typedef struct cJSON
{
    /* 通过next/prev 可以找到同级节点或者使用 GetArraySize/GetArrayItem/GetObjectItem等接口来查找同级节点*/
    struct cJSON *next;
    struct cJSON *prev;
    /* 子节点指针 */
    struct cJSON *child;

    /* key的类型 */
    int type;

    /* value类型为字符串时存放字符串首地址                */
    char *valuestring;

    // 测试了一下valueint和valuedouble
    // 当置入整数值的时候,比如12 valueint为12,valuedouble为12.0
    // 当置入小数值的时候,比如12.333 valueint为12,valuedouble为12.333
    /* value类型为数值时存放该数值 */
    int valueint;
    
    /* value类型为数值时存放该数值            */
    double valuedouble;

    /* key的名称 */
    char *string;
} cJSON;

2.2 常用接口

部分常用的接口整理如下:

/**********************创建节点常用接口**********************/
// 创建节点对象
CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);
// 创建数组节点对象
CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);
// 创建count个key的相应数据类型的节点对象
CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers,int count);
CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers,int count);
CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers,int count);
CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char **strings,int count);

/**********************填充节点常用接口**********************/
// 向object节点对象中添加键值对 其中key为name value为number
CJSON_PUBLIC(cJSON*) cJSON_AddNumberToObject(cJSON * const object,const char * const name,const double number);
// 向object节点对象中添加键值对 其中key为name value为string
CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object,const char * const string);
// 向object节点对象中添加名称为name的对象节点
CJSON_PUBLIC(cJSON*) cJSON_AddObjectToObject(cJSON * const object,const char * const name);
// 向object节点对象中添加名称为name的数组对象节点
CJSON_PUBLIC(cJSON*) cJSON_AddArrayToObject(cJSON * const object,const char * const name);
// 向array数组中添加item节点对象
CJSON_PUBLIC(void) cJSON_AddItemToArray(cJSON *array,cJSON *item);

/**********************解析节点常用接口**********************/
// 从object节点对象中查找key为string的节点作为返回值返回
CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object,const char * const string);
// 获取数组中元素个数
CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array);
// 根据index索引返回数组中节点对象
CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array,int index);

/***********************转换常用接口*************************/
// 将item整个序列打印出来 格式清晰有换行
CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);
// 将item整个序列打印出来 只有一整行 无回车等
CJSON_PUBLIC(char *) cJSON_PrintUnformatted(const cJSON *item);
// 将json格式的字符串转为节点对象
CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value);

/***********************内存释放接口*************************/
// 释放object节点内存 包含其子节点
CJSON_PUBLIC(void) cJSON_free(void *object);

3、测试用例

3.1 简单数据组织

创建两个节点对象,分别向两个节点对象中添加数字和字符串键值对,然后进行格式化输出,代码如下:

#include <stdio.h>
#include <stdlib.h>
#include "cJSON.h"

int main()
{
    cJSON *root    = NULL;
    cJSON *bodymsg    = NULL;
    char  *pString = NULL;

    // 创建根节点
    root = cJSON_CreateObject();
    // 创建body节点
    bodymsg = cJSON_CreateObject();

    // 向bodymsg中添加键值对
    cJSON_AddNumberToObject(bodymsg,"BdTestNum",(double)12);
    cJSON_AddItemToObject(bodymsg,"BdTestStr",cJSON_CreateString("bodystring"));

    // 向root中添加键值对
    cJSON_AddNumberToObject(root,"NumTest",(double)1.23);
    cJSON_AddItemToObject(root,"StringTest",cJSON_CreateString("hello"));
    cJSON_AddItemToObject(root,"body",bodymsg);

    // 将root节点进行格式化输出并打印出来
    pString  = cJSON_Print(root); 
    printf("%s\n",pString);

    // 内存释放
    cJSON_Delete(root);
    free(pString);

    return 0;
}

测试输出结果:

 3.2 数组数据组织

数组的组织相对复杂一点,测试代码如下:

#include <stdio.h>
#include <stdlib.h>
#include "cJSON.h"

int main()
{
    cJSON *root     = NULL;
    cJSON *arrymsg  = NULL;
    cJSON *arry1    = NULL;
    cJSON *arry2    = NULL;
    char  *pString  = NULL;
    cJSON *arrystr  = NULL;
    char  *pstr[4]  = {"rng","we","edg","ig"};
    
    // 创建根节点
    root = cJSON_CreateObject();

    // 创建arrymsg数组节点
    arrymsg = cJSON_CreateArray();

    // 创建数组内容节点
    arry1 = cJSON_CreateObject();
    arry2 = cJSON_CreateObject();

    // 创建元素全为字符串的数组
    arrystr = cJSON_CreateStringArray(pstr,4);

    // 添加键值对
    cJSON_AddNumberToObject(arry1,"arr1",(double)12);
    cJSON_AddItemToObject(arry2,"arr2",cJSON_CreateString("bodystring"));

    // 向数组添加元素
    cJSON_AddItemToArray(arrymsg,arry1);
    cJSON_AddItemToArray(arrymsg,arry2);
    
    // 向root中添加键值对
    cJSON_AddNumberToObject(root,arrymsg);
    cJSON_AddItemToObject(root,"strbody",arrystr);

    // 将root节点进行格式化输出并打印出来
    pString  = cJSON_Print(root); 
    printf("%s\n",pString);

    // 内存释放
    cJSON_Delete(root);
    free(pString);

    return 0;
}

测试输出结果:

 3.3 获取数据解析

读取json格式数据,进行数据解析和获取,读取文件内容如下:

 测试代码:

#include <stdio.h>
#include <stdlib.h>
#include "cJSON.h"

int main()
{
    char configfile[1024] = {0};
    FILE *pFile = fopen("test.json","r");  
    int ret,iRet;
    if (pFile == NULL) 
    { 
        return -1;
    }
    else 
    {
        ret = fread(configfile,1,sizeof(configfile),pFile);
        fclose(pFile);
    
        if (ret > 0) 
        {
            cJSON * root = NULL;

            // 将字符串json格式化
            root = cJSON_Parse(configfile);
            
            if (root == NULL) 
            {
                return -1;
            }
            else 
            {
                // 解析数据
                char   string[10] = {0};
                int    num = 0;
                cJSON * temp;
                cJSON * tempIn;
                cJSON * tempInIn;
                cJSON * arrData;

                // 获取root下面的数值 先获取该对象节点
                temp = cJSON_GetObjectItem(root,"rootnum");
                printf("Get rootnum = %lf\n",temp->valuedouble);

                // 获取第一个body中字符串的值进行打印 获取嵌套body中数字的值进行打印
                temp = cJSON_GetObjectItem(root,"body");

                // 第一个body是一个数组 并且只有一个元素
                for(int i = 0; i < cJSON_GetArraySize(temp); ++i)
                {
                    // 根据索引获取节点对象
                    tempIn = cJSON_GetArrayItem(temp,i);

                    // 获取body中第一个元素的bodystring对象并打印
                    tempInIn = cJSON_GetObjectItem(tempIn,"bodystring");
                    printf("Get bodystring = %s\n",tempInIn->valuestring);

                    // 获取嵌套body 并打印其中元素的值
                    tempInIn = cJSON_GetObjectItem(tempIn,"body");

                    // 嵌套的body也是一个数组 有三个元素
                    for(int j = 0; j < cJSON_GetArraySize(tempInIn); ++j)
                    {
                        arrData = cJSON_GetArrayItem(tempInIn,j);
                        printf("Get bodyIn No.[%d] = %d\n",j,arrData->valueint);
                    }           
                }
                
                cJSON_Delete(root);
            }
        }
        else
        {
            return -1;
        }
    }

    return 0;
}

测试结果:

原文地址:https://blog.csdn.net/cesheng3410/article/details/128947292

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

相关推荐


一.C语言中的static关键字 在C语言中,static可以用来修饰局部变量,全局变量以及函数。在不同的情况下static的作用不尽相同。 (1)修饰局部变量 一般情况下,对于局部变量是存放在栈区的,并且局部变量的生命周期在该语句块执行结束时便结束了。但是如果用static进行修饰的话,该变量便存
浅谈C/C++中的指针和数组(二) 前面已经讨论了指针和数组的一些区别,然而在某些情况下,指针和数组是等同的,下面讨论一下什么时候指针和数组是相同的。C语言标准对此作了说明:规则1:表达式中的数组名被编译器当做一个指向该数组第一个元素的指针; 注:下面几种情况例外 1)数组名作为sizeof的操作数
浅谈C/C++中的指针和数组(一)指针是C/C++的精华,而指针和数组又是一对欢喜冤家,很多时候我们并不能很好的区分指针和数组,对于刚毕业的计算机系的本科生很少有人能够熟练掌握指针以及数组的用法和区别。造成这种原因可能跟现在大学教学以及现在市面上流行的很多C或者C++教程有关,这些教程虽然通俗易懂,
从两个例子分析C语言的声明 在读《C专家编程》一书的第三章时,书中谈到C语言的声明问题,《C专家编程》这本书只有两百多页,却花了一章的内容去阐述这个问题,足以看出这个问题的重要性,要想透彻理解C语言的声明问题仅仅看书是远远不够的,需要平时多实践并大量阅读别人写的代码。下面借鉴《C专家编程》书中的两个
C语言文件操作解析(一)在讨论C语言文件操作之前,先了解一下与文件相关的东西。一.文本文件和二进制文件 文本文件的定义:由若干行字符构成的计算机文件,存在于计算机系统中。文本文件只能存储文件中的有效字符信息,不能存储图像、声音等信息。狭义上的二进制文件则指除开文本文件之外的文件,如图片、DOC文档。
C语言文件操作解析(三) 在前面已经讨论了文件打开操作,下面说一下文件的读写操作。文件的读写操作主要有4种,字符读写、字符串读写、块读写以及格式化读写。一.字符读写 字符读写主要使用两个函数fputc和fgetc,两个函数的原型是: int fputc(int ch,FILE *fp);若写入成功则
浅谈C语言中的位段 位段(bit-field)是以位为单位来定义结构体(或联合体)中的成员变量所占的空间。含有位段的结构体(联合体)称为位段结构。采用位段结构既能够节省空间,又方便于操作。 位段的定义格式为: type [var]:digits 其中type只能为int,unsigned int,s
C语言文件操作解析(五)之EOF解析 在C语言中,有个符号大家都应该很熟悉,那就是EOF(End of File),即文件结束符。但是很多时候对这个理解并不是很清楚,导致在写代码的时候经常出错,特别是在判断文件是否到达文件末尾时,常常出错。1.EOF是什么? 在VC中查看EOF的定义可知: #def
关于VC+ʶ.0中getline函数的一个bug 最近在调试程序时,发现getline函数在VC+ʶ.0和其他编译器上运行结果不一样,比如有如下这段程序:#include &lt;iostream&gt;#include &lt;string&gt;using namespace std;int
C/C++浮点数在内存中的存储方式 任何数据在内存中都是以二进制的形式存储的,例如一个short型数据1156,其二进制表示形式为00000100 10000100。则在Intel CPU架构的系统中,存放方式为 10000100(低地址单元) 00000100(高地址单元),因为Intel CPU
浅析C/C++中的switch/case陷阱 先看下面一段代码: 文件main.cpp#includeusing namespace std;int main(int argc, char *argv[]){ int a =0; switch(a) { case ...
浅谈C/C++中的typedef和#define 在C/C++中,我们平时写程序可能经常会用到typedef关键字和#define宏定义命令,在某些情况下使用它们会达到相同的效果,但是它们是有实质性的区别,一个是C/C++的关键字,一个是C/C++的宏定义命令,typedef用来为一个已有的数据类型
看下面一道面试题:#include&lt;stdio.h&gt;#include&lt;stdlib.h&gt;int main(void) { int a[5]={1,2,3,4,5}; int *ptr=(int *)(&amp;aʱ); printf(&quot;%d,%d&quot;,*(
联合体union 当多个数据需要共享内存或者多个数据每次只取其一时,可以利用联合体(union)。在C Programming Language 一书中对于联合体是这么描述的: 1)联合体是一个结构; 2)它的所有成员相对于基地址的偏移量都为0; 3)此结构空间要大到足够容纳最&quot;宽&quo
从一个程序的Bug解析C语言的类型转换 先看下面一段程序,这段程序摘自《C 专家编程》:#include&lt;stdio.h&gt;int array[]={23,34,12,17,204,99,16};#define TOTAL_ELEMENTS (sizeof(array)/sizeof(ar
大端和小端 嵌入式开发者应该对大端和小端很熟悉。在内存单元中数据是以字节为存储单位的,对于多字节数据,在小端模式中,低字节数据存放在低地址单元,而在大端模式中,低字节数据存放在高地址单元。比如一个定义一个short型的变量a,赋值为1,由于short型数据占2字节。在小端模式中,其存放方式为0X40
位运算和sizeof运算符 C语言中提供了一些运算符可以直接操作整数的位,称为位运算,因此位运算中的操作数都必须是整型的。位运算的效率是比较高的,而且位运算运用好的话会达到意想不到的效果。位运算主要有6种:与(&amp;),或(|),取反(~),异或(^),左移(&gt;)。1.位运算中的类型转换位
C语言文件操作解析(四)在文件操作中除了打开操作以及读写操作,还有几种比较常见的操作。下面介绍一下这些操作中涉及到的函数。一.移动位置指针的函数 rewind函数和fseek函数,这两个函数的原型是:void rewind(FILE *fp); 将位置指针移动到文件首 int fseek(FILE
结构体字节对齐 在用sizeof运算符求算某结构体所占空间时,并不是简单地将结构体中所有元素各自占的空间相加,这里涉及到内存字节对齐的问题。从理论上讲,对于任何变量的访问都可以从任何地址开始访问,但是事实上不是如此,实际上访问特定类型的变量只能在特定的地址访问,这就需要各个变量在空间上按一定的规则排
C语言文件操作解析(二)C语言中对文件进行操作必须首先打开文件,打开文件主要涉及到fopen函数。fopen函数的原型为 FILE* fopen(const char *path,const char *mode) 其中path为文件路径,mode为打开方式 1)对于文件路径,只需注意若未明确给出绝