【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。

相关文章

C语言中的数据类型强制转换

C语言中的数据类型强制转换

《C语言中的数据类型强制转换》：本文主要介绍C语言中的数据类型强制转换方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C语言数据类型强制转换自动转换强制转换类型总结C语言数据类型强制转换强制类型转换：是通过类型转换运算来实现的，主要的数据类型转换分为自动转换
阅读更多...
利用Go语言开发文件操作工具轻松处理所有文件

利用Go语言开发文件操作工具轻松处理所有文件

《利用Go语言开发文件操作工具轻松处理所有文件》在后端开发中,文件操作是一个非常常见但又容易出错的场景,本文小编要向大家介绍一个强大的Go语言文件操作工具库,它能帮你轻松处理各种文件操作场景... 目录为什么需要这个工具？核心功能详解1. 文件/目录存javascript在性检查2. 批量创建目录3. 文件
阅读更多...
C语言实现两个变量值交换的三种方式

C语言实现两个变量值交换的三种方式

《C语言实现两个变量值交换的三种方式》两个变量值的交换是编程中最常见的问题之一,以下将介绍三种变量的交换方式,其中第一种方式是最常用也是最实用的,后两种方式一般只在特殊限制下使用,需要的朋友可以参考下... 目录1.使用临时变量（推荐）2.相加和相减的方式（值较大时可能丢失数据）3.按位异或运算1.使用临时
阅读更多...
使用C语言实现交换整数的奇数位和偶数位

使用C语言实现交换整数的奇数位和偶数位

《使用C语言实现交换整数的奇数位和偶数位》在C语言中,要交换一个整数的二进制位中的奇数位和偶数位,重点需要理解位操作,当我们谈论二进制位的奇数位和偶数位时,我们是指从右到左数的位置,本文给大家介绍了使... 目录一、问题描述二、解决思路三、函数实现四、宏实现五、总结一、问题描述使用C语言代码实现：将一个整
阅读更多...
C语言字符函数和字符串函数示例详解

C语言字符函数和字符串函数示例详解

《C语言字符函数和字符串函数示例详解》本文详细介绍了C语言中字符分类函数、字符转换函数及字符串操作函数的使用方法,并通过示例代码展示了如何实现这些功能,通过这些内容,读者可以深入理解并掌握C语言中的字... 目录一、字符分类函数二、字符转换函数三、strlen的使用和模拟实现3.1strlen函数3.2st
阅读更多...
Go语言中最便捷的http请求包resty的使用详解

Go语言中最便捷的http请求包resty的使用详解

《Go语言中最便捷的http请求包resty的使用详解》go语言虽然自身就有net/http包,但是说实话用起来没那么好用,resty包是go语言中一个非常受欢迎的http请求处理包,下面我们一起来学... 目录安装一、一个简单的get二、带查询参数三、设置请求头、body四、设置表单数据五、处理响应六、超
阅读更多...
C语言中的浮点数存储详解

C语言中的浮点数存储详解

《C语言中的浮点数存储详解》：本文主要介绍C语言中的浮点数存储详解,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、首先明确一个概念2、接下来，讲解C语言中浮点型数存储的规则2.1、可以将上述公式分为两部分来看2.2、问：十进制小数0.5该如何存储？2.3 浮点
阅读更多...
基于Python实现多语言朗读与单词选择测验

基于Python实现多语言朗读与单词选择测验

《基于Python实现多语言朗读与单词选择测验》在数字化教育日益普及的今天,开发一款能够支持多语言朗读和单词选择测验的程序,对于语言学习者来说无疑是一个巨大的福音,下面我们就来用Python实现一个这... 目录一、项目概述二、环境准备三、实现朗读功能四、实现单词选择测验五、创建图形用户界面六、运行程序七、
阅读更多...
使用Go语言开发一个命令行文件管理工具

使用Go语言开发一个命令行文件管理工具

《使用Go语言开发一个命令行文件管理工具》这篇文章主要为大家详细介绍了如何使用Go语言开发一款命令行文件管理工具,支持批量重命名,删除,创建,移动文件,需要的小伙伴可以了解下... 目录一、工具功能一览二、核心代码解析1. 主程序结构2. 批量重命名3. 批量删除4. 创建文件/目录5. 批量移动三、如何安
阅读更多...
python使用fastapi实现多语言国际化的操作指南

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2