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

---

前言

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

---

一、下载CJson

打开这个链接：CJson下载

可以使用上面这两种下载方式。
点击去下载好的文件后，我们只需要其中的cJSON.c和cJSON.h文件即可。

只需要在我们main内里包罗cJSON.h即可
二、创建一个json

2.1 创建json对象

在我们的json中，他的布局如下：

1. {
2.         ...
3. }

复制代码

外面的大括号就是我们的root，我们就先创建他才能举行后续的操作
函数原型：

1. CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);

复制代码

无参数，返回值为cJSON 的指针
cJSON范例详解

cJson布局体如下定义：

1. /* The cJSON structure: */
2. typedef struct cJSON
3. {
4.     /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */
5.     struct cJSON *next;
6.     struct cJSON *prev;
7.     /* An array or object item will have a child pointer pointing to a chain of the items in the array/object. */
8.     struct cJSON *child;
10.     /* The type of the item, as above. */
11.     int type;
13.     /* The item's string, if type==cJSON_String  and type == cJSON_Raw */
14.     char *valuestring;
15.     /* writing to valueint is DEPRECATED, use cJSON_SetNumberValue instead */
16.     int valueint;
17.     /* The item's number, if type==cJSON_Number */
18.     double valuedouble;
20.     /* The item's name string, if this item is the child of, or is in the list of subitems of an object. */
21.     char *string;
22. } 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 创建键值对

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

1. 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对象

1. 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 添加数组

创建数组

1. CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);

复制代码

无参数，返回值为cJSON，这个数组的指针
添加元素到数组

1. 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

1. 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转换成字符串了

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

复制代码

返回值：
char *：这是一个指向字符数组的指针，表示包罗 JSON 元素内容的字符串。需要注意的是，这个返回的字符串是在堆上动态分配的，所以在使用完毕后，需要负责释放内存以防止内存泄漏。
参数：
const cJSON *item：
这是一个指向 cJSON 元素的指针，表示你要将哪个 JSON 元素转换成字符串。
所以，这个函数的作用就是把一个 cJSON 元素转换成字符串，并返回这个字符串的指针。你可以通过这个返回的字符串来获取 JSON 元素的文本表示。
如果填root则是把整个json变成字符串
2.6 释放内存

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

1. CJSON_PUBLIC(void) cJSON_Delete(cJSON *item)

复制代码

参数一般填我们的root
2.7 示例代码

1. #include <stdio.h>
2. #include <stdlib.h>
3. #include "cJSON.h"
5. char Json[1024] = { '\0' };
7. void ReadJson()
8. {
9.     FILE* f = NULL;
10.     fopen_s(&f, "learn.json", "r");
11.     fread(Json, 1, 1023, f);
13.     printf("%s\n", Json);
15.     fclose(f);
16. }
18. int main() {
19.    
20.     // 创建 JSON 对象
21.     cJSON* root = cJSON_CreateObject();
23.     // 添加基本键值对
24.     cJSON_AddStringToObject(root, "name", "John");
25.     cJSON_AddNumberToObject(root, "age", 30);
27.     // 添加嵌套的 JSON 对象（地址）
28.     cJSON* address = cJSON_CreateObject();
29.     cJSON_AddStringToObject(address, "street", "123 Main St");
30.     cJSON_AddStringToObject(address, "city", "Anytown");
31.     cJSON_AddStringToObject(address, "postalCode", "12345");
32.     cJSON_AddItemToObject(root, "address", address);
34.     // 添加数组
35.     cJSON* interests = cJSON_CreateArray();
36.     cJSON_AddItemToArray(interests, cJSON_CreateString("Reading"));
37.     cJSON_AddItemToArray(interests, cJSON_CreateString("Gardening"));
38.     cJSON_AddItemToArray(interests, cJSON_CreateString("Cooking"));
39.     cJSON_AddItemToObject(root, "interests", interests);
41.     // 将 JSON 对象转为字符串
42.     char* jsonString = cJSON_Print(root);
43.     printf("JSON Object:\n%s\n", jsonString);
45.     // 释放内存
46.     cJSON_Delete(root);
47.     free(jsonString);
49.     return 0;
50. }

复制代码

三、解析json

3.1 解析json root

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

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

复制代码

检测是否解析乐成：

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

复制代码

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

1. 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指针范例，用他们可以判断内里是什么范例的，以便后续的操作

1. /* These functions check the type of an item */
2. CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
3. CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
4. CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
5. CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
6. CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
7. CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
8. CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
9. CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
10. CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
11. CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);

复制代码

3.4 获取键值对的值

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

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

复制代码

除了使用函数，我们也可以使用cJSON内里的成员举行大概值。
比方：

1. int age_value = age->valueint;

复制代码

3.5 获取和遍历数组

获取数组内里指定index的值

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

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

复制代码

获取数组的大小

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

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

复制代码

遍历数组

1. cJSON* scores = cJSON_GetObjectItemCaseSensitive(root, "scores");
2. if (cJSON_IsArray(scores)) {
3.     int array_size = cJSON_GetArraySize(scores);
4.     printf("Scores: ");
5.     for (int i = 0; i < array_size; i++) {
6.         cJSON* score_element = cJSON_GetArrayItem(scores, i);
7.         if (cJSON_IsNumber(score_element)) {
8.             printf("%d ", score_element->valueint);
9.         }
10.     }
11.     printf("\n");
12. }

复制代码

---

总结

CJSON 提供了一个简单而功能丰富的方式来处置惩罚 JSON 数据。通过创建 JSON 对象、数组，以及使用相应的函数来添补和访问数据，你可以在 C 语言中轻松地举行 JSON 操作。在使用 cJSON 时，记得实时释放分配的内存以避免内存泄漏。
这篇文章提供了一个根本的入门指南，希望能够资助你开始使用 CJSON 在 C 语言中处置惩罚 JSON 数据。如果你有更复杂的需求，建议查看 cJSON 的文档和示例代码，以更深入地了解其功能和用法。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。