【C语言之 CJson】学CJson看这一篇就够了

news2025/1/20 12:05:16

文章目录

  • 前言
  • 一、下载CJson
  • 二、创建一个json
    • 2.1 创建json对象
      • cJSON类型详解
    • 2.2 创建键值对
    • 2.3 添加嵌套的 JSON 对象
    • 2.4 添加数组
      • 创建数组
      • 添加元素到数组
      • 添加数组到obj
    • 2.5 将 JSON 对象转为字符串
    • 2.6 释放内存
    • 2.7 示例代码
  • 三、解析json
    • 3.1 解析json root
    • 3.2 把一个key解析出来变成cJSON对象
    • 3.3 判断cJSON的存储的类型
    • 3.4 获取键值对的值
    • 3.5 获取和遍历数组
      • 获取数组里面指定index的值
      • 获取数组的大小
      • 遍历数组
  • 总结


前言

CJSON 是一个轻量级的、用于处理 JSON 数据的 C 语言库。它提供了简单而直观的 API,使得在 C 程序中处理 JSON 数据变得相对容易。在本文中,我们将介绍 CJSON 的基本使用,包括如何创建 JSON 对象、解析 JSON 字符串、访问 JSON 数据以及释放相关资源。


一、下载CJson

打开这个链接:CJson下载
在这里插入图片描述
可以使用上面这两种下载方式。

点击去下载好的文件后,我们只需要其中的cJSON.c和cJSON.h文件即可。

在这里插入图片描述
只需要在我们main里面包含cJSON.h即可

二、创建一个json

2.1 创建json对象

在我们的json中,他的结构如下:

{
	...
}

外面的大括号就是我们的root,我们就先创建他才能进行后续的操作

函数原型:

CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);

无参数,返回值为cJSON 的指针

cJSON类型详解

cJson结构体如下定义:

/* The cJSON structure: */
typedef struct cJSON
{
    /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
    struct cJSON *next;
    struct cJSON *prev;
    /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
    struct cJSON *child;

    /* The type of the item, as above. */
    int type;

    /* The item's string, if type==cJSON_String  and type == cJSON_Raw */
    char *valuestring;
    /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */
    int valueint;
    /* The item's number, if type==cJSON_Number */
    double valuedouble;

    /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
    char *string;
} cJSON;

这是 cJSON 库中定义的结构体 cJSON,它用于表示 JSON 数据的各个部分。以下是各个成员的解释:

next/prev:

struct cJSON *next;
struct cJSON *prev;
这两个成员用于在数组或对象中遍历链表。你可以通过这两个指针在链表中移动,或者使用 cJSON 库提供的函数 GetArraySize、GetArrayItem、GetObjectItem 来进行相应的操作。

child:

struct cJSON *child;
如果当前项是一个数组或对象,child 指向一个链表,表示数组或对象中的各个元素。通过这个链表,你可以访问数组的各个元素或对象的各个成员。

type:

int type;
表示当前项的类型,可以是以下几种之一:
cJSON_False
cJSON_True
cJSON_NULL
cJSON_Number
cJSON_String
cJSON_Array
cJSON_Object
cJSON_Raw

valuestring:

char *valuestring;
如果当前项的类型是 cJSON_String 或 cJSON_Raw,valuestring 指向存储字符串值的字符数组。

valueint:

int valueint;
DEPRECATED:以前用于存储整数值,现在推荐使用 cJSON_SetNumberValue 函数设置数字值。

valuedouble:

double valuedouble;
如果当前项的类型是 cJSON_Number,valuedouble 存储该项的数字值。

string:

char *string;
如果当前项是一个对象的成员,string 存储该成员的名称(键)。如果当前项是一个数组的元素,string 可能为 NULL。
这些成员组合在一起,使得 cJSON 结构体能够表示 JSON 数据的结构和内容。通过递归访问 next、prev、child 指针,可以遍历整个 JSON 数据。

2.2 创建键值对

使用下面这个函数即可创建一个键值对

CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string)

这个函数是 cJSON 库中的一个函数,用于向一个 JSON 对象(或者说 JSON 字典)中添加一个字符串类型的键值对。

返回值:
cJSON*:这个函数返回一个指向新添加的 JSON 元素的指针。这个元素包含了添加的字符串值。如果添加失败,返回 NULL。

参数:
cJSON * const object:

这是一个指向 JSON 对象的指针,表示你要往哪个对象中添加键值对。

const char * const name:
这是一个字符串,表示你要添加的键的名称(key)。

const char * const string:
这是一个字符串,表示你要添加的值。这个值是一个字符串类型的 JSON 元素。
所以,这个函数的作用就是往一个 JSON 对象中添加一个键值对,键是 name,值是 string,然后返回一个指向新添加元素的指针。如果添加失败,返回 NULL。

2.3 添加嵌套的 JSON 对象

使用下面这个函数为添加嵌套的json对象

CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item)

返回值:

cJSON_bool:这是一个表示成功或失败的布尔值。如果成功添加元素,返回 true,否则返回 false。
参数:

cJSON *object:
这是一个指向 JSON 对象的指针,表示你要往哪个对象中添加元素。

const char *string:
这是一个字符串,表示你要添加的键的名称(key)。

cJSON *item:
这是一个指向要添加的 JSON 元素的指针。可以是任何 JSON 数据类型,比如字符串、数字、数组等。
所以,这个函数的作用就是往一个 JSON 对象中添加一个键值对,键是 string,值是 item,然后返回一个布尔值,表示添加是否成功。如果成功,返回 true,否则返回 false。

2.4 添加数组

创建数组

CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);

无参数,返回值为cJSON,这个数组的指针

添加元素到数组

CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToArray(cJSON *array, cJSON *item);

返回值:
cJSON_bool:这是一个表示成功或失败的布尔值。如果成功添加元素,返回 true,否则返回 false。

参数:

CJSON *array:
这是一个指向 JSON 数组的指针,表示你要往哪个数组中添加元素。

CJSON *item:
这是一个指向要添加的 JSON 元素的指针。可以是任何 JSON 数据类型,比如字符串、数字、对象等。
所以,这个函数的作用就是往一个 JSON 数组中添加一个元素,元素的内容由 item 指定,然后返回一个布尔值,表示添加是否成功。如果成功,返回 true,否则返回 false。

添加数组到obj

CJSON_PUBLIC(cJSON_bool) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item)

这个函数是 cJSON 库中的一个函数,用于向一个 JSON 对象(或者说 JSON 字典)中添加一个 JSON 元素。

返回值:
cJSON_bool:这是一个表示成功或失败的布尔值。如果成功添加元素,返回 true,否则返回 false。
参数:

cJSON *object:
这是一个指向 JSON 对象的指针,表示你要往哪个对象中添加元素。

const char *string:
这是一个字符串,表示你要添加的键的名称(key)。

cJSON *item:
这是一个指向要添加的 JSON 元素的指针。可以是任何 JSON 数据类型,比如字符串、数字、数组、对象等。
所以,这个函数的作用就是往一个 JSON 对象中添加一个键值对,键是 string,值是 item,然后返回一个布尔值,表示添加是否成功。如果成功,返回 true,否则返回 false。

2.5 将 JSON 对象转为字符串

使用下面这个函数就可以把你的json转换成字符串了

CJSON_PUBLIC(char *) cJSON_Print(const cJSON *item);

返回值:
char *:这是一个指向字符数组的指针,表示包含 JSON 元素内容的字符串。需要注意的是,这个返回的字符串是在堆上动态分配的,所以在使用完毕后,需要负责释放内存以防止内存泄漏。

参数:
const cJSON *item:
这是一个指向 cJSON 元素的指针,表示你要将哪个 JSON 元素转换成字符串。
所以,这个函数的作用就是把一个 cJSON 元素转换成字符串,并返回这个字符串的指针。你可以通过这个返回的字符串来获取 JSON 元素的文本表示。
如果填root则是把整个json变成字符串

2.6 释放内存

使用下面这个函数即可释放我们的内存

CJSON_PUBLIC(void) cJSON_Delete(cJSON *item)

参数一般填我们的root

2.7 示例代码

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

char Json[1024] = { '\0' };

void ReadJson()
{
    FILE* f = NULL;
    fopen_s(&f, "learn.json", "r");
    fread(Json, 1, 1023, f);

    printf("%s\n", Json);

    fclose(f);
}

int main() {
    
    // 创建 JSON 对象
    cJSON* root = cJSON_CreateObject();

    // 添加基本键值对
    cJSON_AddStringToObject(root, "name", "John");
    cJSON_AddNumberToObject(root, "age", 30);

    // 添加嵌套的 JSON 对象(地址)
    cJSON* address = cJSON_CreateObject();
    cJSON_AddStringToObject(address, "street", "123 Main St");
    cJSON_AddStringToObject(address, "city", "Anytown");
    cJSON_AddStringToObject(address, "postalCode", "12345");
    cJSON_AddItemToObject(root, "address", address);

    // 添加数组
    cJSON* interests = cJSON_CreateArray();
    cJSON_AddItemToArray(interests, cJSON_CreateString("Reading"));
    cJSON_AddItemToArray(interests, cJSON_CreateString("Gardening"));
    cJSON_AddItemToArray(interests, cJSON_CreateString("Cooking"));
    cJSON_AddItemToObject(root, "interests", interests);

    // 将 JSON 对象转为字符串
    char* jsonString = cJSON_Print(root);
    printf("JSON Object:\n%s\n", jsonString);

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

    return 0;
}

在这里插入图片描述

三、解析json

3.1 解析json root

使用下面这个函数,就可以把一个const char *的字符串解析成cJSON对象了

CJSON_PUBLIC(cJSON *) cJSON_Parse(const char *value);

检测是否解析成功:

if (root == NULL) {
    const char* error_ptr = cJSON_GetErrorPtr();
    if (error_ptr != NULL) {
        fprintf(stderr, "Error before: %s\n", error_ptr);
    }
    return 1; // Exit with an error code
}

在这里插入图片描述

3.2 把一个key解析出来变成cJSON对象

CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string)

返回值:
cJSON *:这是一个指向 cJSON 元素的指针,表示获取到的值。如果指定键存在于 JSON 对象中,就返回对应的值;如果不存在,则返回 NULL。

参数:

const cJSON * const object:
这是一个指向 JSON 对象的指针,表示你要从哪个对象中获取值。

const char * const string:
这是一个字符串,表示你要获取的值对应的键的名称(key)。
所以,这个函数的作用就是在给定的 JSON 对象中查找指定键的值,如果找到了就返回对应的值的指针,如果找不到就返回 NULL。这个函数是区分大小写的,意味着键的名称要严格匹配,大小写一致。

3.3 判断cJSON的存储的类型

在CJSON中有这么一些函数,他的参数为cJson指针类型,用他们可以判断里面是什么类型的,以便后续的操作

/* These functions check the type of an item */
CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);

在这里插入图片描述

3.4 获取键值对的值

在CJSON中有这两个函数,他们的参数为cJSON指针对象,返回值为值

/* Check item type and return its value */
CJSON_PUBLIC(char *) cJSON_GetStringValue(const cJSON * const item);
CJSON_PUBLIC(double) cJSON_GetNumberValue(const cJSON * const item);

在这里插入图片描述

除了使用函数,我们也可以使用cJSON里面的成员进行或者值。
例如:

int age_value = age->valueint;

3.5 获取和遍历数组

获取数组里面指定index的值

使用下面这个函数即可获取指定index的cJson类型了

CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index);

在这里插入图片描述

获取数组的大小

使用下面这个函数就可以获取array里面有几个元素了

/* Returns the number of items in an array (or object). */
CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array);

在这里插入图片描述

遍历数组

cJSON* scores = cJSON_GetObjectItemCaseSensitive(root, "scores");
if (cJSON_IsArray(scores)) {
    int array_size = cJSON_GetArraySize(scores);
    printf("Scores: ");
    for (int i = 0; i < array_size; i++) {
        cJSON* score_element = cJSON_GetArrayItem(scores, i);
        if (cJSON_IsNumber(score_element)) {
            printf("%d ", score_element->valueint);
        }
    }
    printf("\n");
}

在这里插入图片描述


总结

CJSON 提供了一个简单而功能丰富的方式来处理 JSON 数据。通过创建 JSON 对象、数组,以及使用相应的函数来填充和访问数据,你可以在 C 语言中轻松地进行 JSON 操作。在使用 cJSON 时,记得及时释放分配的内存以避免内存泄漏。

这篇文章提供了一个基本的入门指南,希望能够帮助你开始使用 CJSON 在 C 语言中处理 JSON 数据。如果你有更复杂的需求,建议查看 cJSON 的文档和示例代码,以更深入地了解其功能和用法。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1280243.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

SSM框架(六):SpringBoot技术及整合SSM

文章目录 一、概述1.1 简介1.2 起步依赖1.3 入门案例1.4 快速启动 二、基础配置2.1 三种配置文件方式2.2 yaml文件格式2.3 yaml读取数据方式&#xff08;3种&#xff09; 三、多环境开发3.1 yml文件-多环境开发3.2 properties文件-多环境开发3.3 多环境命令行启动参数设置3.4 多…

yolov5 7.0版本部署手机端。通过pnnx导出ncnn。

yolov5 7.0版本部署手机端。通过pnnx导出ncnn。 流程配置ncnn android yolov5导出自己模型的ncnn修改yolo.py文件导出TorchScript文件pnnx转torchscript为ncnn 安卓运行权重路径输入输出anchors 大小类别名generate_proposals方法修改 结果 流程 网络yolov5 的部署已经有很多了…

STM32串口接收不定长数据(接收中断+超时判断)

玩转 STM32 单片机&#xff0c;肯定离不开串口。串口使用一个称为串行通信协议的协议来管理数据传输&#xff0c;该协议在数据传输期间控制数据流&#xff0c;包括数据位数、波特率、校验位和停止位等。由于串口简单易用&#xff0c;在各种产品交互中都有广泛应用。 但在使用串…

基础组件总结(以Element UI组件库为例)

一般对一个组件的使用方式&#xff1a; 每一个组件都有被绑定的数据&#xff0c; &#xff08;1&#xff09;首先会对组件的数据初始化&#xff08;a.data中赋初值 b. 在生命周期函数created或mounted中为变量赋予初值&#xff09; &#xff08;2&#xff09;由于不同组件的…

CSS新手入门笔记整理:CSS边框样式

边框宽度&#xff1a;boder-width 语法 boder-width:像素值&#xff1b; 边框样式&#xff1a;boder-style 语法 boder-style:取值&#xff1b; 属性值 说明 none 无样式 dashed 虚线 solid 实线 边框颜色&#xff1a;boder-color 语法 boder-color:色值&#xf…

MFC 绘制单一颜色圆形、渐变颜色边框圆形、渐变填充圆形以及绘制三角函数正弦函数曲线.

MFC 绘制三种不同圆形以及绘制正弦函数曲线 本文使用visual Studio MFC 平台实现绘制单一颜色圆形、渐变颜色边框圆形、渐变填充圆形以及绘制三角函数正弦函数曲线. 关于基础工程的创建请参考 01-Visual Studio 使用MFC 单文档工程绘制单一颜色直线和绘制渐变颜色的直线 02-vis…

Hisat-Trinity-PASA等组学分析流程

一边学习&#xff0c;一边总结&#xff0c;一边分享&#xff01; 详细教程请访问&#xff1a; 组学分析流程 本期分析流程 Hisat2-SamtoolsTrinity_GG_denovoPASA … 本期教程文章 题目&#xff1a;Genomic insights into local adaptation and future climate-induced vu…

全面的.NET微信网页开发之JS-SDK使用步骤、配置信息和接口请求签名生成详解

JSSDK使用步骤 步骤一:绑定安全域名&#xff1a; 先登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。 步骤二:引入JS文件&#xff1a; 在需要调用JS接口的页面引入如下JS文件&#xff0c;&#xff08;支持https&#xff09;&#xff1a;http://…

分治—快速选择算法

文章目录 &#x1f347;215.数组中的第K个最大元素&#x1f348;1. 题目&#x1f349;2. 算法原理&#x1f34a;3. 代码实现 &#x1f34b;LCR 159. 库存管理 III&#x1f34c;1. 题目&#x1f34d;2. 算法原理&#x1f96d;代码实现 &#x1f347;215.数组中的第K个最大元素 …

〖大前端 - 基础入门三大核心之JS篇㊺〗- 定时器和延时器

说明&#xff1a;该文属于 大前端全栈架构白宝书专栏&#xff0c;目前阶段免费&#xff0c;如需要项目实战或者是体系化资源&#xff0c;文末名片加V&#xff01;作者&#xff1a;不渴望力量的哈士奇(哈哥)&#xff0c;十余年工作经验, 从事过全栈研发、产品经理等工作&#xf…

MathType公式编辑器安装教程

一、下载 MathType7是一款可以帮助用户快速完成数学公式编辑的应用软件&#xff0c;这款软件适合在进行教育教学、科研机构、论文写作的时候使用。我们可以直接通过这款软件来获取到大量数学上使用到的函数、数学符号等内容&#xff0c;然后使用这些内容来完成公式编辑。 …

ROS第一个程序——helloworld

目录 一、工作空间的创建 1.创建工作空间并初始化 2.进入 src 创建 ros 包并添加依赖 二、C实现helloworld C源码实现 编辑 ros 包下的 Cmakelist.txt文件 进入工作空间目录并编译 执行 三、python实现helloworld 进入 ros 包添加 scripts 目录并编辑 python 文件 …

【设计模式-4.1】行为型——观察者模式

说明&#xff1a;本文介绍设计模式中行为型设计模式中的&#xff0c;观察者模式&#xff1b; 商家与顾客 观察者模式属于行为型设计模式&#xff0c;关注对象的行为。以商家与顾客为例&#xff0c;商家有商品&#xff0c;顾客来购买商品&#xff0c;如果商家商品卖完了&#…

【Leetcode题单】(01 数组篇)刷题关键点总结02【统计数组中的元素】

【Leetcode题单】&#xff08;01 数组篇&#xff09;刷题关键点总结02【统计数组中的元素】&#xff08;6题&#xff09; 统计数组中的元素645. 错误的集合 Easy697. 数组的度 Easy448. 找到所有数组中消失的数字 Easy442. 数组中重复的数据 Medium41. 缺失的第一个正数 Hard27…

【问题解决】Linux内核编译安装后磁盘空间已满问题

Linux内核编译安装后磁盘空间已满问题解决过程 【注】本文为个人遇到Linux内核经过make&#xff0c;make modules……乃至最后install以后VMware磁盘空间爆炸的情况后&#xff0c;而又不想重装虚拟机&#xff0c;自己找资料实现解决的&#xff0c;文章中很多链接是来自别的博主…

python动态圣诞下雪图

运行图片 代码 import pygame import random# 初始化Pygame pygame.init()# 创建窗口 width, height 800, 600 screen pygame.display.set_mode((width, height)) pygame.display.set_caption(Christmas Tree)# 定义颜色 GREEN (34, 139, 34) RED (255, 0, 0) WHITE (255…

GAMES101:作业2记录

总览 在上次作业中&#xff0c;虽然我们在屏幕上画出一个线框三角形&#xff0c;但这看起来并不是那么的有趣。所以这一次我们继续推进一步——在屏幕上画出一个实心三角形&#xff0c;换言之&#xff0c;栅格化一个三角形。上一次作业中&#xff0c;在视口变化之后&#xff0…

Redis--13--缓存一致性问题

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录 缓存一致性问题1、先更新缓存&#xff0c;再更新DB方案二&#xff1a;先更新DB&#xff0c;再更新缓存方案三&#xff1a;先删缓存&#xff0c;再写数据库推荐1&…

Python ctypes:揭秘高级Python与底层交互秘籍

更多资料获取 &#x1f4da; 个人网站&#xff1a;ipengtao.com ctypes是Python标准库中的外部函数库&#xff0c;允许Python调用动态链接库中的函数。它提供了与C兼容的数据类型和允许Python调用共享库中的函数&#xff0c;对系统级编程和与硬件交互非常有用。 基本用法 加…

基于Django框架搭建的协同过滤算法电影推荐网站-爬取的豆瓣电影数据

欢迎大家点赞、收藏、关注、评论啦 &#xff0c;由于篇幅有限&#xff0c;只展示了部分核心代码。 文章目录 一项目简介概述技术栈实现流程 二、功能三、系统四. 总结 一项目简介 # 电影推荐网站介绍 概述 该电影推荐网站是基于Django框架搭建的&#xff0c;旨在为用户提供个…