cJSON
cJSON 是一个用 C 语言编写的轻量级 JSON 解析库，旨在提供简单、高效的方式来处理 JSON 数据。它适用于需要解析或生成 JSON 数据的各种应用场景，尤其是资源受限的嵌入式系统或对性能有较高要求的项目。
https://github.com/DaveGamble/cJSON/releases
typedef struct cJSON {/* next/prev 允许您遍历数组/对象链。也可以使用 GetArraySize/GetArrayItem/GetObjectItem */struct cJSON *next;struct cJSON *prev;/* 数组或对象项将有一个 child 指针，指向数组/对象中项目的链 */struct cJSON *child;/* 项目的类型，如上所述 */int type;/* 如果 type == cJSON_String 或 type == cJSON_Raw，则为项目的字符串值 */char *valuestring;/* 写入 valueint 已被弃用，请使用 cJSON_SetNumberValue 代替 */int valueint;/* 如果 type == cJSON_Number，则为项目的数字值 */double valuedouble;/* 如果该项目是对象的孩子，或者在对象子项列表中，则为项目的名称字符串 */char *string; } cJSON;
cJSON 库的常用函数接口的表格形式，包含每个函数的简要说明和示例代码。这些函数涵盖了创建、解析、修改和输出 JSON 数据的主要操作。
| 函数接口 | 功能说明 | 示例代码 |
|---|---|---|
| 解析 JSON | ||
cJSON *cJSON_Parse(const char *value) | 解析一个 JSON 字符串并返回一个指向 cJSON 结构体的指针。 | c<br>cJSON *json = cJSON_Parse("{\"name\": \"Alice\"}");<br>if (json == NULL) {<br> // 处理错误<br>}<br> |
void cJSON_Delete(cJSON *c) | 释放由 cJSON_Parse 或其他创建函数分配的内存。 | c<br>cJSON_Delete(json);<br> |
| 创建 JSON | ||
cJSON *cJSON_CreateNull(void) | 创建一个表示 null 的 JSON 节点。 | c<br>cJSON *nullItem = cJSON_CreateNull();<br> |
cJSON *cJSON_CreateBool(cJSON_bool boolean) | 创建一个布尔值的 JSON 节点。 | c<br>cJSON *boolItem = cJSON_CreateBool(1); // true<br> |
cJSON *cJSON_CreateNumber(double num) | 创建一个数字值的 JSON 节点。 | c<br>cJSON *numberItem = cJSON_CreateNumber(123.45);<br> |
cJSON *cJSON_CreateString(const char *string) | 创建一个字符串值的 JSON 节点。 | c<br>cJSON *stringItem = cJSON_CreateString("Hello, World!");<br> |
cJSON *cJSON_CreateArray(void) | 创建一个空的 JSON 数组。 | c<br>cJSON *array = cJSON_CreateArray();<br> |
cJSON *cJSON_CreateObject(void) | 创建一个空的 JSON 对象。 | c<br>cJSON *object = cJSON_CreateObject();<br> |
| 修改 JSON | ||
void cJSON_AddItemToArray(cJSON *array, cJSON *item) | 向 JSON 数组中添加一个项目。 | c<br>cJSON_AddItemToArray(array, cJSON_CreateString("Item1"));<br> |
void cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item) | 向 JSON 对象中添加一个键值对。 | c<br>cJSON_AddItemToObject(object, "key", cJSON_CreateNumber(1));<br> |
void cJSON_ReplaceItemInObject(cJSON *object, const char *string, cJSON *newitem) | 替换 JSON 对象中指定键的值。 | c<br>cJSON_ReplaceItemInObject(object, "key", cJSON_CreateNumber(2));<br> |
| 查询 JSON | ||
cJSON *cJSON_GetObjectItemCaseSensitive(cJSON *object, const char *string) | 获取 JSON 对象中指定键的项，区分大小写。 | c<br>cJSON *item = cJSON_GetObjectItemCaseSensitive(object, "key");<br> |
cJSON_bool cJSON_HasObjectItem(cJSON *object, const char *string) | 检查 JSON 对象中是否存在指定键。 | c<br>if (cJSON_HasObjectItem(object, "key")) {<br> // 处理存在<br>}<br> |
| 输出 JSON | ||
char *cJSON_Print(cJSON *item) | 将 cJSON 结构体转换为格式化的 JSON 字符串。 | c<br>char *json_str = cJSON_Print(json);<br>printf("%s\n", json_str);<br> |
char *cJSON_PrintUnformatted(cJSON *item) | 将 cJSON 结构体转换为无格式的 JSON 字符串（不带空格和换行）。 | c<br>char *json_str = cJSON_PrintUnformatted(json);<br>printf("%s\n", json_str);<br> |
| 其他常用函数 | ||
cJSON_bool cJSON_IsNull(cJSON *item) | 检查一个 cJSON 项是否为 null。 | c<br>if (cJSON_IsNull(item)) {<br> // 处理 null<br>}<br> |
cJSON_bool cJSON_IsBool(cJSON *item) | 检查一个 cJSON 项是否为布尔值。 | c<br>if (cJSON_IsBool(item)) {<br> // 处理布尔值<br>}<br> |
cJSON_bool cJSON_IsNumber(cJSON *item) | 检查一个 cJSON 项是否为数字。 | c<br>if (cJSON_IsNumber(item)) {<br> // 处理数字<br>}<br> |
cJSON_bool cJSON_IsString(cJSON *item) | 检查一个 cJSON 项是否为字符串。 | c<br>if (cJSON_IsString(item)) {<br> // 处理字符串<br>}<br> |
示例代码
一个综合示例，展示了如何使用上述函数来创建、解析、修改和输出 JSON 数据：
#include <stdio.h>
#include <cjson/cJSON.h>int main()
{// 创建 JSON 对象cJSON *root = cJSON_CreateObject();cJSON_AddItemToObject(root, "name", cJSON_CreateString("Alice"));cJSON_AddItemToObject(root, "age", cJSON_CreateNumber(30));cJSON_AddItemToObject(root, "isStudent", cJSON_CreateBool(0));// 创建 JSON 数组并添加到对象中cJSON *courses = cJSON_CreateArray();cJSON_AddItemToArray(courses, cJSON_CreateString("Math"));cJSON_AddItemToArray(courses, cJSON_CreateString("Science"));cJSON_AddItemToArray(courses, cJSON_CreateString("History"));cJSON_AddItemToObject(root, "courses", courses);// 输出 JSON 字符串char *json_str = cJSON_Print(root);printf("Original JSON:\n%s\n", json_str);// 解析 JSON 字符串cJSON *parsed = cJSON_Parse(json_str);if (parsed == NULL){printf("Error parsing JSON\n");cJSON_Delete(root);free(json_str);return 1;}// 修改 JSON 数据cJSON_ReplaceItemInObject(parsed, "age", cJSON_CreateNumber(31));cJSON_ReplaceItemInObject(parsed, "isStudent", cJSON_CreateBool(1));// 添加新的键值对cJSON_AddItemToObject(parsed, "email", cJSON_CreateString("alice@example.com"));// 输出修改后的 JSON 字符串char *modified_json_str = cJSON_Print(parsed);printf("Modified JSON:\n%s\n", modified_json_str);// 释放内存cJSON_Delete(root);cJSON_Delete(parsed);free(json_str);free(modified_json_str);return 0;
}输出结果
Original JSON:
{"name": "Alice","age": 30,"isStudent": false,"courses": ["Math","Science","History"]
}
Modified JSON:
{"name": "Alice","age": 31,"isStudent": true,"courses": ["Math","Science","History"],"email": "alice@example.com"
}