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

2023-12-03 18:36
文章标签 语言 一篇 就够 cjson

本文主要是介绍【C语言之 CJson】学CJson看这一篇就够了,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 前言
  • 一、下载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 的文档和示例代码,以更深入地了解其功能和用法。

这篇关于【C语言之 CJson】学CJson看这一篇就够了的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/450442

相关文章

Andrej Karpathy最新采访:认知核心模型10亿参数就够了,AI会打破教育不公的僵局

夕小瑶科技说 原创  作者 | 海野 AI圈子的红人,AI大神Andrej Karpathy,曾是OpenAI联合创始人之一,特斯拉AI总监。上一次的动态是官宣创办一家名为 Eureka Labs 的人工智能+教育公司 ,宣布将长期致力于AI原生教育。 近日,Andrej Karpathy接受了No Priors(投资博客)的采访,与硅谷知名投资人 Sara Guo 和 Elad G

科研绘图系列:R语言扩展物种堆积图(Extended Stacked Barplot)

介绍 R语言的扩展物种堆积图是一种数据可视化工具,它不仅展示了物种的堆积结果,还整合了不同样本分组之间的差异性分析结果。这种图形表示方法能够直观地比较不同物种在各个分组中的显著性差异,为研究者提供了一种有效的数据解读方式。 加载R包 knitr::opts_chunk$set(warning = F, message = F)library(tidyverse)library(phyl

透彻!驯服大型语言模型(LLMs)的五种方法,及具体方法选择思路

引言 随着时间的发展,大型语言模型不再停留在演示阶段而是逐步面向生产系统的应用,随着人们期望的不断增加,目标也发生了巨大的变化。在短短的几个月的时间里,人们对大模型的认识已经从对其zero-shot能力感到惊讶,转变为考虑改进模型质量、提高模型可用性。 「大语言模型(LLMs)其实就是利用高容量的模型架构(例如Transformer)对海量的、多种多样的数据分布进行建模得到,它包含了大量的先验

C语言 | Leetcode C语言题解之第393题UTF-8编码验证

题目: 题解: static const int MASK1 = 1 << 7;static const int MASK2 = (1 << 7) + (1 << 6);bool isValid(int num) {return (num & MASK2) == MASK1;}int getBytes(int num) {if ((num & MASK1) == 0) {return

MiniGPT-3D, 首个高效的3D点云大语言模型,仅需一张RTX3090显卡,训练一天时间,已开源

项目主页:https://tangyuan96.github.io/minigpt_3d_project_page/ 代码:https://github.com/TangYuan96/MiniGPT-3D 论文:https://arxiv.org/pdf/2405.01413 MiniGPT-3D在多个任务上取得了SoTA,被ACM MM2024接收,只拥有47.8M的可训练参数,在一张RTX

如何确定 Go 语言中 HTTP 连接池的最佳参数?

确定 Go 语言中 HTTP 连接池的最佳参数可以通过以下几种方式: 一、分析应用场景和需求 并发请求量: 确定应用程序在特定时间段内可能同时发起的 HTTP 请求数量。如果并发请求量很高,需要设置较大的连接池参数以满足需求。例如,对于一个高并发的 Web 服务,可能同时有数百个请求在处理,此时需要较大的连接池大小。可以通过压力测试工具模拟高并发场景,观察系统在不同并发请求下的性能表现,从而

C语言:柔性数组

数组定义 柔性数组 err int arr[0] = {0}; // ERROR 柔性数组 // 常见struct Test{int len;char arr[1024];} // 柔性数组struct Test{int len;char arr[0];}struct Test *t;t = malloc(sizeof(Test) + 11);strcpy(t->arr,

C语言指针入门 《C语言非常道》

C语言指针入门 《C语言非常道》 作为一个程序员,我接触 C 语言有十年了。有的朋友让我推荐 C 语言的参考书,我不敢乱推荐,尤其是国内作者写的书,往往七拼八凑,漏洞百出。 但是,李忠老师的《C语言非常道》值得一读。对了,李老师有个官网,网址是: 李忠老师官网 最棒的是,有配套的教学视频,可以试看。 试看点这里 接下来言归正传,讲解指针。以下内容很多都参考了李忠老师的《C语言非

C 语言基础之数组

文章目录 什么是数组数组变量的声明多维数组 什么是数组 数组,顾名思义,就是一组数。 假如班上有 30 个同学,让你编程统计每个人的分数,求最高分、最低分、平均分等。如果不知道数组,你只能这样写代码: int ZhangSan_score = 95;int LiSi_score = 90;......int LiuDong_score = 100;int Zhou

C 语言的基本数据类型

C 语言的基本数据类型 注:本文面向 C 语言初学者,如果你是熟手,那就不用看了。 有人问我,char、short、int、long、float、double 等这些关键字到底是什么意思,如果说他们是数据类型的话,那么为啥有这么多数据类型呢? 如果写了一句: int a; 那么执行的时候在内存中会有什么变化呢? 橡皮泥大家都玩过吧,一般你买橡皮泥的时候,店家会赠送一些模板。 上