cJSON C语言库解析和生成JSON数据

概述

cJSON是一个轻量级的C语言库，用于解析和生成JSON数据。它提供了简洁而高效的API，使得在C语言中处理JSON数据变得简单和方便。

以下是一些cJSON库的主要特点和用法：

解析JSON数据：使用cJSON_Parse函数可以将JSON字符串解析为cJSON对象。该函数会返回一个指向根节点的指针。如果解析失败，返回NULL。

生成JSON数据：使用cJSON_CreateObject和cJSON_CreateArray等函数可以创建cJSON对象。然后使用cJSON_AddItemToObject和cJSON_AddItemToArray等函数将子项添加到对象或数组中。最后，使用cJSON_PrintUnformatted或cJSON_Print等函数将cJSON对象转换为JSON字符串。

获取字段值：使用cJSON_GetObjectItem和cJSON_GetArrayItem等函数可以获取cJSON对象或数组中的特定字段值。根据字段的类型，可以使用相应的函数来获取字段值，如cJSON_GetString、cJSON_GetNumber、cJSON_GetBool等。

遍历JSON数据：cJSON库提供了用于遍历JSON对象和数组的宏，如cJSON_ArrayForEach和cJSON_ObjectForEach。这些宏可以方便地遍历JSON数据的子项。

释放内存：使用cJSON_Delete可以释放通过cJSON_Parse创建的cJSON对象，以避免内存泄漏。

cJSON库是一个非常轻量级和灵活的库，适用于在C语言中处理JSON数据。它具有简单的API和高性能，可以在各种嵌入式系统和低资源环境中使用。无论是解析还是生成JSON数据，cJSON库都为C语言开发者提供了一种简单而可靠的方式。

常用的API函数介绍

以下是一些常用的cJSON库的API函数介绍：

cJSON_Parse：将JSON字符串解析为cJSON对象。返回一个指向根节点的指针。如果解析失败，返回NULL。

cJSON* cJSON_Parse(const char* value);
cJSON_Print：将cJSON对象转换为格式化的JSON字符串，并返回一个指向字符串的指针。需要在使用完之后手动释放内存。

char* cJSON_Print(const cJSON* item);
cJSON_GetObjectItem：从cJSON对象中获取指定名称的字段值。返回一个指向字段值的指针。如果字段不存在或类型不匹配，返回NULL。

cJSON* cJSON_GetObjectItem(const cJSON* const object, const char* const string);
cJSON_GetArrayItem：从cJSON数组中获取指定索引位置的元素。返回一个指向元素的指针。如果索引超出范围，返回NULL。

cJSON* cJSON_GetArrayItem(const cJSON* const array, int index);
cJSON_IsObject：检查给定的cJSON对象是否为JSON对象类型。

cJSON_bool cJSON_IsObject(const cJSON* const object);
cJSON_IsArray：检查给定的cJSON对象是否为JSON数组类型。

cJSON_bool cJSON_IsArray(const cJSON* const array);
cJSON_AddItemToObject：将一个子项添加到cJSON对象中。子项可以是其他cJSON对象、数组、字符串等。

void cJSON_AddItemToObject(cJSON* object, const char* string, cJSON* item);
cJSON_AddItemToArray：将一个子项添加到cJSON数组中。子项可以是其他cJSON对象、数组、字符串等。

void cJSON_AddItemToArray(cJSON* array, cJSON* item);
cJSON_CreateObject：创建一个空的cJSON对象，并返回指向该对象的指针。

cJSON* cJSON_CreateObject(void);
cJSON_CreateArray：创建一个空的cJSON数组，并返回指向该数组的指针。


cJSON* cJSON_CreateArray(void);
cJSON_CreateString：创建一个cJSON字符串，并返回指向该字符串的指针。


cJSON* cJSON_CreateString(const char* string);
cJSON_CreateNumber：创建一个cJSON数字，并返回指向该数字的指针。


cJSON* cJSON_CreateNumber(double number);
cJSON_CreateBool：创建一个cJSON布尔值，并返回指向该布尔值的指针。

cJSON* cJSON_CreateBool(cJSON_bool boolean);
cJSON_Delete：释放通过cJSON_Parse创建的cJSON对象，并递归删除其所有子项。

void cJSON_Delete(cJSON* item);

这些是cJSON库中一些常用的API函数。通过使用这些函数，您可以在C语言中方便地解析和生成JSON数据。请注意，在使用完cJSON对象后，需要使用cJSON_Delete函数来释放内存，以避免内存泄漏。

范例代码

以下是完整的示例代码，包括包含所需头文件、函数注释以及主函数的实现

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

/**
 * @brief 主函数，用于解析JSON数组并输出解析结果
 * 
 * @return 返回程序执行结果
 */
int main() {
   
    // 读取JSON字符串
    const char* json_data = "[{\"name\":\"John\",\"age\":25,\"address\":\"123 Main St\"},{\"name\":\"Jane\",\"age\":30,\"address\":\"456 Elm St\"}]";

    // 解析JSON数组
    cJSON* root = cJSON_Parse(json_data);   // 解析JSON字符串，并返回根节点的指针
    if (root == NULL)