cJSON应用说明摘录

最新推荐文章于 2024-07-05 10:19:30 发布
最新推荐文章于 2024-07-05 10:19:30 发布
阅读量481 收藏 1
点赞数
分类专栏： cJSON 文章标签： json
原文链接：https://cloud.tencent.com/developer/article/1619838
版权

CJSON介绍

CJSON是一个超轻巧,携带方便,单文件,简单的可以作为ANSI-C标准的JSON解析器。CISON,目前来说,就只有两个文件,一个cJSON.c一个cSON.h文件。使用的时候,自己创建好一个main.c文件后,将头文件include进去。

主要的结构体介绍

这里有个很重要的结构体是需要用到的就是CJSON结构体如下:

typedef struct cJSON {
　　struct cJSON *next,*prev;      /* 遍历数组或对象链的前向或后向链表指针*/
　　struct cJSON *child;           /*数组或对象的孩子节点*/
　　int type;                      /* key的类型*/
　　char *valuestring;             /*字符串值*/
　　int valueint;                  /* 整数值*/
　　double valuedouble;            /* 浮点数值*/
　　char *string;                  /* key的名字*/
} cJSON;

 

cJSON主要API

 

cJSON   API说明
cJSON_Version()获得cJSON的版本
cJSON_InitHooks();初始化cJSON_Hooks结构体
cJSON_Parse();将字符串解析成cJSON结构体
cJSON_ParseWithOpts()使用一些配置解析字符串
cJSON_Print()将cJSON结构体转换成格式化的字符串
cJSON_PrintUnformatted()将cJSON结构体转换成未格式化的字符串
cJSON_PrintBuffered()将cJSON结构体使用buffer的字符串，格式化可选
cJSON_PrintPreallocated()将cJSON结构体使用预分配的内存的字符串，格式化可选
cJSON_Delete()删除cJSON结构体
cJSON_GetArraySize()返回Array类型的大小,对Object类型也是有效的
cJSON_GetArrayItem()返回Array类型的index的值，对Object类型也有效
cJSON_GetObjectItem()使用key获得对应的value
cJSON_GetObjectItemCaseSensitive()使用对大小写敏感的key获得对应的value
cJSON_HasObjectItem()判断是否ObjectItem存在
cJSON_GetErrorPtr()获得错误信息
cJSON_IsInvalid()类型判断
cJSON_IsFalse()类型判断
cJSON_IsTrue()类型判断
cJSON_IsBool()类型判断
cJSON_IsNull()类型判断
cJSON_IsNumber()类型判断
cJSON_IsString()类型判断
cJSON_IsArray()类型判断
cJSON_IsObject()类型判断
cJSON_IsRaw()类型判断
cJSON_CreateNull()创造对应类型的cJSON
cJSON_CreateTrue()创造对应类型的cJSON
cJSON_CreateFalse()创造对应类型的cJSON
cJSON_CreateBool()创造对应类型的cJSON
cJSON_CreateNumber()创造对应类型的cJSON
cJSON_CreateString()创造对应类型的cJSON
cJSON_CreateRaw()创造对应类型的cJSON
cJSON_CreateArray()创造对应类型的cJSON
cJSON_CreateObject()创造对应类型的cJSON
cJSON_CreateIntArray()批量创造对应类型的cJSON
cJSON_CreateFloatArray()批量创造对应类型的cJSON
cJSON_CreateDoubleArray()批量创造对应类型的cJSON
cJSON_CreateStringArray()批量创造对应类型的cJSON
cJSON_AddItemToArray()在指定Array后面增加Item
cJSON_AddItemToObject()在指定Object后面增加Item
cJSON_AddItemToObjectCS()在指定Object后面增加const Item
cJSON_AddItemReferenceToArray()在指定Array后面增加Item引用
cJSON_DetachItemViaPointer()通过指针从Array删除Item的引用
cJSON_DetachItemFromArray()从Array删除Item的引用
cJSON_DeleteItemFromArray()从Array删除Item
cJSON_DetachItemFromObject()从Object删除Item的引用
cJSON_DetachItemFromObjectCaseSensitive()大小写敏感的从Object删除Item的引用
cJSON_DeleteItemFromObject()从Object删除Item
cJSON_DeleteItemFromObjectCaseSensitive()大小写敏感的从Object删除Item
cJSON_InsertItemInArray()在Array指定位置插入Item
cJSON_ReplaceItemViaPointer()使用指针替代Item
cJSON_ReplaceItemInArray()替换Array的Item
cJSON_ReplaceItemInObject()替换Object的Item
cJSON_ReplaceItemInObjectCaseSensitive()大小写敏感的替换Object的Item
cJSON_Duplicate()复制cJSON结构体
cJSON_Compare()比较两个cJSON结构体
cJSON_Minify()将格式化的字符串压缩
cJSON_AddNullToObject()调用cJSON_AddItemToObject和cJSON_CreateNull
cJSON_AddTrueToObject()调用cJSON_AddItemToObject和cJSON_CreateTrue
cJSON_AddFalseToObject()调用cJSON_AddItemToObject和cJSON_CreateFalse
cJSON_AddBoolToObject()调用cJSON_AddItemToObject和cJSON_CreateBool
cJSON_AddNumberToObject()调用cJSON_AddItemToObject和cJSON_CreateNumber
cJSON_AddStringToObject()调用cJSON_AddItemToObject和cJSON_CreateString
cJSON_AddRawToObject()调用cJSON_AddItemToObject和cJSON_CreateRaw
cJSON_SetIntValue()设置int的值，同时也设置double的值
cJSON_SetNumberValue()后台会调用cJSON_SetNumberHelper
cJSON_SetNumberHelper()设置cJSON的number类型的值
cJSON_malloc()cJSON的malloc函数，调用malloc函数
cJSON_free()cJSON的free函数，调用free函数

使用例子

待解析的文件：

{"syslog_db"：[{"db_user":"xxx","db_password":"yyy","db_type":"ORACLE","db_ip":"172.16.1.248","db_port":"1521","db_name":"orcl","sql":"select * from syslog"}]，
"syslog_source":[{"send_ip":"172.0.0.8","send_port":"8","send_protocal":"TCP"}],
"syslog_enable":"1"
}

 代码：

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

int main() {
    FILE            *fp = NULL;
    cJSON           *json;
    char            *out;
    char            line[1024] = {0};

    if(NULL != (fp = fopen("./test.ply", "r"))) {
        while (NULL != fgets(line, sizeof(line), fp)) {
            json=cJSON_Parse(line); //获取整个大的句柄
            out=cJSON_Print(json);  //这个是可以输出的。为获取的整个json的值
            cJSON *arrayItem = cJSON_GetObjectItem(json,"syslog_db"); //获取这个对象成员
            cJSON *object = cJSON_GetArrayItem(arrayItem,0);   //因为这个对象是个数组获取，且只有一个元素所以写下标为0获取
            
　　　　　　　 /*下面就是可以重复使用cJSON_GetObjectItem来获取每个成员的值了*/
            cJSON *item = cJSON_GetObjectItem(object,"db_user");  //
            printf("db_user:%s\n",item->valuestring);

            item = cJSON_GetObjectItem(object,"db_password");
            printf("db_password:%s\n",item->valuestring);

            item = cJSON_GetObjectItem(object,"db_type");
            printf("db_type:%s\n",item->valuestring);

            item = cJSON_GetObjectItem(object,"db_ip");
            printf("db_ip:%s\n",item->valuestring);

            item = cJSON_GetObjectItem(object,"db_port");
            printf("db_port:%s\n",item->valuestring);

            item = cJSON_GetObjectItem(object,"db_name");
            printf("db_name:%s\n",item->valuestring);

            item = cJSON_GetObjectItem(object,"sql");
            printf("db_sql:%s\n",item->valuestring);
        

　　　　　　　/*这里这个是直接可以获取值的*/
            arrayItem = cJSON_GetObjectItem(json,"syslog_enable");
            printf("%s\n",arrayItem->valuestring);
        }
    }
        cJSON_Delete(json)；
    close(fp);
}

主要函数接口介绍：

　　这里有个很重要的结构体是需要用到的就是cJSON  结构体如下：

typedef struct cJSON {

　　struct cJSON *next,*prev;      /* 遍历数组或对象链的前向或后向链表指针*/

　　struct cJSON *child;                   /*数组或对象的孩子节点*/

　　 int type;                                     /* key的类型*/

　　char *valuestring;                       /*字符串值*/

　　int valueint;                                /* 整数值*/

　　double valuedouble;                    /* 浮点数值*/

　　 char *string;                               /* key的名字*/

} cJSON;

 

说明：

1、cJSON是使用链表来存储数据的，其访问方式很像一颗树。每一个节点可以有兄弟节点，通过next/prev指针来查找，它类似双向链表；每个节点也可以有孩子节点，通过child指针来访问，进入下一层。只有节点是对象或数组时才可以有孩子节点。

2、type是键（key）的类型，一共有7种取值，分别是：False，Ture，NULL，Number，String，Array，Object。

若是Number类型，则valueint或valuedouble中存储着值。若期望的是int，则访问valueint，若期望的是double，则访问valuedouble，可以得到值。

若是String类型的，则valuestring中存储着值，可以访问valuestring得到值。

3、string中存放的是这个节点的名字，可理解为key的名称。

 

重要的接口函数：

1.cJSON *cJSON_Parse(const char *value);

解析JSON数据包，并按照cJSON结构体的结构序列化整个数据包。可以看做是获取一个句柄。

2.cJSON *cJSON_GetObjectItem(cJSON *object,const char *string);

功能：获取json指定的对象成员

参数：*objec：第一个函数中获取的句柄。

          string：需要获取的对象

返回值：这个对象成员的句柄  如果json格式的对象成员直接就是字符串那么就可以直接通过结构体中的valuestring元素来获取这个成员的值

 

3.cJSON *cJSON_GetArrayItem(cJSON *array,int item);

功能：有可能第二个函数中获取到的是成员对象值是一个数组，那么就需要用到这个函数。用来获取这个数组指定的下标对象

参数：*array：传入第二步中返回的值

　　　 item：想要获取这个数组的下标元素

返回值：这个数组中指定下标的对象。然后在对这个返回值重复使用第二步函数就可以获取到各个成员的值了。

也就是说对象是数组的比是字符串的要多用一个cJSON_GetArrayItem函数，其他的没区别。

4.cJSON_Delete()

用来释放你第一步获取的句柄，来释放整个内存。用在解析完后调用

 

介绍完了下面就看实例

用于解析的json结构，这里我使用配置文件保存的json结构，然后解析这个配置文件。用于测试json结构如下：

{"syslog_db"：[{"db_user":"xxx","db_password":"yyy","db_type":"ORACLE","db_ip":"172.16.1.248","db_port":"1521","db_name":"orcl","sql":"select * from syslog"}]，
"syslog_source":[{"send_ip":"172.0.0.8","send_port":"8","send_protocal":"TCP"}],
"syslog_enable":"1"
}

三个大的对象分别有两个是数组一个是直接可以获取的。代码如下：

复制代码

1 #include <stdio.h>
 2 #include "cJSON.h"
 3 
 4 int main() {
 5     FILE            *fp = NULL;
 6     cJSON           *json;
 7     char            *out;
 8     char            line[1024] = {0};
 9 
10     if(NULL != (fp = fopen("./test.ply", "r"))) {
11         while (NULL != fgets(line, sizeof(line), fp)) {
12             json=cJSON_Parse(line); //获取整个大的句柄
13             out=cJSON_Print(json);  //这个是可以输出的。为获取的整个json的值
14             cJSON *arrayItem = cJSON_GetObjectItem(json,"syslog_db"); //获取这个对象成员
15             cJSON *object = cJSON_GetArrayItem(arrayItem,0);   //因为这个对象是个数组获取，且只有一个元素所以写下标为0获取
16             
17 　　　　　　　 /*下面就是可以重复使用cJSON_GetObjectItem来获取每个成员的值了*/
18             cJSON *item = cJSON_GetObjectItem(object,"db_user");  //
19             printf("db_user:%s\n",item->valuestring);
20 
21             item = cJSON_GetObjectItem(object,"db_password");
22             printf("db_password:%s\n",item->valuestring);
23 
24             item = cJSON_GetObjectItem(object,"db_type");
25             printf("db_type:%s\n",item->valuestring);
26 
27             item = cJSON_GetObjectItem(object,"db_ip");
28             printf("db_ip:%s\n",item->valuestring);
29 
30             item = cJSON_GetObjectItem(object,"db_port");
31             printf("db_port:%s\n",item->valuestring);
32 
33             item = cJSON_GetObjectItem(object,"db_name");
34             printf("db_name:%s\n",item->valuestring);
35 
36             item = cJSON_GetObjectItem(object,"sql");
37             printf("db_sql:%s\n",item->valuestring);
38         
39 
40 　　　　　　　/*这里这个是直接可以获取值的*/
41             arrayItem = cJSON_GetObjectItem(json,"syslog_enable");
42             printf("%s\n",arrayItem->valuestring);
43         }
44     }
45         cJSON_Delete(json)；
46     close(fp);
47 }

复制代码

 

执行的结果如下：

转载

C - CJSON
CJSON 使用介绍
C语言cJSON库的使用，解析json数据格式

wcht0502
关注
专栏目录
cJSON系列(1) - cJSON 入门与应用
彼岸
08-31 1万+
cJSON 入门与应用 1. cJSON简介 cJSON aims to be the dumbest possible parser that you can get your job done with. It's a single file of C, and a single header file. JSON is described best here: http
cJSON
rongxiaojun的专栏
08-29 5285
cJSON只有cJSON.h和cJSON.c两个文件、600行代码，
cJSON-使用简单且功能强大的JSON解析库
薄荷醇
01-09 2813
用C++处理JSON的库有很多,JSONCPP,json-parser,Jansson…太多了 不过我们搞程序开发，不一定需要一个库有多么强大的功能，但是这个库一定要能满足我们的要求，同时，开发起来要简单，最好不要增加我们的开发负担和学习负担。 我在开发menthol语言的JSON模块处理时，发现了一个简单、易用的JSON处理库-CJSON 看它的官方介绍 Welcome to cJSON. c...
使用CJSON 解析JSON 结构体数组【典型】
热门推荐
pl0020的博客
11-20 2万+
一、CJSON数据结构定义 #define cJSON_False 0 #define cJSON_True 1 #define cJSON_NULL 2 #define cJSON_Number 3 #define cJSON_String 4 #define cJSON_Array 5 //数组 #define cJSON_Object 6 //对象or键名 typedef struct cJSON { struct cJSON *next,*prev; /*遍历数组或对象链的前向
物联网数据解析实战：掌握CJSON库核心函数，精准处理JSON数据
最新发布
m0_47673526的博客
07-05 1052
我们详细讲解了CJSON库的核心函数，包括如何创建JSON对象、添加键值对、解析JSON字符串以及遍历JSON对象等，过实际操作解析OneNET平台返回的JSON数据，学会如何精准地处理物联网中的JSON数据，为物联网项目的开发提供有力支持。
CJSON配置文件读写
一个码农的足迹
07-07 1839
CJSON由于简洁明了的格式特征，非常适合用于配置文件格式，下面以一个简单的配置文件为例讲解cjson格式文件读写方法。 cjson格式文件示例： { "record_cfg": { "record_chan": [1, 1], "live_chan": [1, 1], "fps": 30, "bitrate": 12 }, "audio_cfg": { "chn"...
cjson中取得bool类型的值
yiwang103的博客
11-24 1067
在cjson中获取bool类型的值时突然发现不能直接使用item->value来获取bool值，最后解决了，留个纪念。
将Json :: Value转换为std :: string？
az44yao的专栏
02-21 1465
虽然这很好用,但当前版本的JsonCPP表示Json :: FastWriter已被弃用,转而使用Json :: StreamWriterBuilder.但是删除了写入字符串的功能,现在有必要写入std :: stringstream.你能详细说明吗？来做到这一点,因为我假设你想将它保存在某个地方所以你不想要人类可读的输出,你最好的选择是使用。来构建一个JSON对象.一旦构建了对象,有没有办法让对象成为一个。您还可以使用 toStyledString() 方法。(即您的根)的参数的方法,然后只返回。
cJSON使用说明及示例
12-10
cJSON在嵌入式开发中的应用** 由于其小巧的体积和高效的性能，cJSON特别适合于嵌入式系统，如物联网设备、微控制器等资源受限的环境。它可以方便地与C语言编写的其他系统组件集成，用于数据交换和存储。 总结，...
基于STM32的cJSON应用
10-14
**基于STM32的cJSON应用** 在嵌入式开发领域，STM32微控制器以其高性能、低功耗和丰富的外设接口而受到广泛应用。在处理网络数据或与上位机交互时，JSON（JavaScript Object Notation）作为一种轻量级的数据交换...
基于VS的cJSON应用工程
10-13
**基于VS的cJSON应用工程详解** 在C语言编程中，JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，常用于服务器与客户端之间的数据传输。为了在C语言环境中处理JSON数据，我们可以借助第三方库，如...
cjson接口详细介绍.docx
06-03
cjson 模块可以应用于各种需要数据交换的场景，例如： * 网络传输：cjson 可以将 Lua 变量编码为 JSON 字符串，然后将其传输到服务器端或客户端。 * 数据存储：cjson 可以将 Lua 变量编码为 JSON 字符串，然后将其...
cJSON库和使用说明文档
12-17
`cJSON接口说明.docx`文件提供了详细的cJSON库接口文档，包含了每个函数的参数说明、返回值以及使用示例，对于深入理解和使用cJSON库非常有帮助。 **六、cJSONFiles.zip** `cJSONFiles.zip`可能包含cJSON库的源码...
C·cJSON库函数--cJSON_GetObjectItem
m0_47102213的博客
03-17 8235
首先使用cJSON_Parse函数将JSON字符串解析为cJSON节点树。然后使用cJSON_GetObjectItem函数获取该节点树中的某些值。需要注意的是，在获取"hobby"成员时，还需要使用cJSON_IsArray和cJSON_GetArraySize函数进行类型判断和数组大小获取。1、cJSON是一个轻量级的JSON解析库，cJSON_GetObjectItem函数是用来获取JSON对象中的某个成员的值。如果找到指定的成员，则返回该成员对应的cJSON节点，否则返回NULL。
1.String转JSON
batman_88的博客
05-10 2035
1.String转JSON String jstr="{'json':'jsonvalue','bool':true,'int':1,'double':'20.5'}"; JSONObject json=JSONObject.fromObject(jstr); boolean bool=json.getBoolean("bool"); int i=json.getInt("int"); doub
使用cJSON的注意了 + 具体使用
qq_41851997的博客
12-10 4218
本文要点： 处理10k的json数据大概会额外用掉50k左右的ram，谨记，没那么大空间预留就别玩了
cJSON源码及解析流程详解
Tyler_Zx的博客
11-29 1万+
前言 cJSON简介 cJSON.h cJSON结构 cJSON结点的创建 cJSON解析 parse_objec( ) parse_array( ) parse_number( ) parse_string( ) cJSON打印 print_object( ) print_array( ) print_number( ) print_string( )&pri...
【C/C++专栏】cJSON的API介绍和使用
weixin_43729127的博客
11-04 2437
cJSON 的API使用介绍，有根据API写的例子做学习参考，保姆级教程总结，一学就会使用，容易上手，哈哈哈
cJSON_AddItemReferenceToArray使用说明
06-10
cJSON_AddItemReferenceToArray函数是cJSON库中的一个函数，用于将一个cJSON对象添加到一个cJSON数组中。该函数的声明如下： ```c void cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item); ``` 其中，参数...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值