c怎么解析json案例

从零开始：C语言解析JSON的实用指南与案例

在现代软件开发中，JSON（JavaScript Object Notation）已成为数据交换的事实标准，无论是从Web API获取数据，还是读取配置文件，我们都不可避免地要与JSON打交道，C语言作为一种底层、高效的语言，其标准库中并没有内置对JSON的解析支持，如何在C语言中优雅地解析JSON数据呢？本文将为你提供一份详尽的实用指南，并通过一个完整的案例,带你一步步在C中解析JSON的核心方法。

为什么在C中解析JSON有挑战？

C语言的核心优势在于其简洁性和对内存的精细控制，但这种“自由”也带来了挑战：

无内置支持：C标准库没有提供类似JavaScript的JSON.parse()或Python的json.loads()这样的函数。
手动内存管理：JSON解析通常需要动态分配内存来存储字符串、数字、数组和对象，在C中，我们必须手动使用malloc和free来管理这些内存,否则极易导致内存泄漏。
缺乏高级数据结构：JSON中的数组和对象需要对应到C中的数据结构，由于C没有动态数组或字典（哈希表）等内置结构,我们需要自己实现或借助第三方库来模拟它们。

为了解决这些问题，使用第三方库是最高效、最可靠的方法,这些库已经为我们处理了底层的内存管理和复杂的解析逻辑。

选择合适的JSON库

在C语言生态中，有几个非常流行的JSON库,各有千秋：

cJSON：轻量级、单文件、易于集成，API简单直观,非常适合嵌入式系统或追求简洁的项目。
Jansson：功能强大、性能优秀、API设计现代，支持完整的JSON类型,并且有良好的错误处理机制。
YAJL (Yet Another JSON Library)：流式解析器，适合处理非常大的JSON文件,因为它不需要一次性将整个文件读入内存。

对于初学者和大多数应用场景，cJSON是绝佳的选择，它只有一个cJSON.h和一个cJSON.c文件,只需将它们加入你的项目即可开始使用。

核心概念：cJSON的数据结构

cJSON的核心是一个名为cJSON的联合体结构,它可以表示JSON中的任何一种数据类型：

typedef struct cJSON
{
    struct cJSON* next;     // 同级下一个元素
    struct cJSON* prev;     // 同级上一个元素
    struct cJSON* child;    // 如果是对象或数组，指向其子元素
    char* string;           // 如果是键（对象成员）或字符串值，指向字符串
    char* valuestring;      // 字符串类型的值
    int valueint;           // 整数类型的值
    double valuedouble;     // 浮点数类型的值
    unsigned char type;     // 数据类型
} cJSON;

type字段是关键,它定义了值的类型，

cJSON_Number
cJSON_String
cJSON_Array
cJSON_Object
cJSON_True / cJSON_False / cJSON_NULL

完整案例：解析一个用户信息JSON

假设我们有以下JSON字符串,它表示一个用户的信息：

{
    "name": "张三",
    "age": 30,
    "isStudent": false,
    "scores": [85, 92, 78],
    "address": {
        "city": "北京",
        "district": "海淀区"
    }
}

我们的目标是解析这个JSON，并将数据提取出来,打印到控制台。

步骤1：准备环境

下载cJSON源码：从 cJSON的GitHub仓库下载。
将cJSON.h和cJSON.c文件复制到你的C项目目录中。
在编译时，将cJSON.c一同编译，使用GCC：
```
gcc main.c cJSON.c -o my_app -lm
```
（注意：-lm 是链接数学库,某些版本可能需要）

步骤2：编写C代码

下面是完整的解析代码,并附有详细注释。

#include <stdio.h>
#include <stdlib.h>
#include "cJSON.h"
int main() {
    // 1. 定义我们的JSON字符串
    const char* json_string = "{"
                              "    \"name\": \"张三\","
                              "    \"age\": 30,"
                              "    \"isStudent\": false,"
                              "    \"scores\": [85, 92, 78],"
                              "    \"address\": {"
                              "        \"city\": \"北京\","
                              "        \"district\": \"海淀区\""
                              "    }"
                              "}";
    // 2. 解析JSON字符串，得到一个cJSON对象（根对象）
    cJSON* root = cJSON_Parse(json_string);
    if (root == NULL) {
        const char* error_ptr = cJSON_GetErrorPtr();
        if (error_ptr) {
            fprintf(stderr, "Error before: %s\n", error_ptr);
        } else {
            fprintf(stderr, "Unknown error\n");
        }
        return 1;
    }
    // 3. 从根对象中提取数据
    // 提取字符串 "name"
    cJSON* name_item = cJSON_GetObjectItemCaseSensitive(root, "name");
    if (cJSON_IsString(name_item) && (name_item->valuestring != NULL)) {
        printf("姓名: %s\n", name_item->valuestring);
    }
    // 提取整数 "age"
    cJSON* age_item = cJSON_GetObjectItemCaseSensitive(root, "age");
    if (cJSON_IsNumber(age_item)) {
        printf("年龄: %d\n", age_item->valueint);
    }
    // 提取布尔值 "isStudent"
    cJSON* is_student_item = cJSON_GetObjectItemCaseSensitive(root, "isStudent");
    if (cJSON_IsBool(is_student_item)) {
        printf("是否为学生: %s\n", cJSON_IsTrue(is_student_item) ? "是" : "否");
    }
    // 提取数组 "scores"
    cJSON* scores_item = cJSON_GetObjectItemCaseSensitive(root, "scores");
    if (cJSON_IsArray(scores_item)) {
        printf("成绩: [");
        cJSON* score = NULL;
        cJSON_ArrayForEach(score, scores_item) {
            if (cJSON_IsNumber(score)) {
                printf("%d", score->valueint);
                // 判断是否是数组最后一个元素
                if (score->next) {
                    printf(", ");
                }
            }
        }
        printf("]\n");
    }
    // 提取嵌套对象 "address"
    cJSON* address_item = cJSON_GetObjectItemCaseSensitive(root, "address");
    if (cJSON_IsObject(address_item)) {
        cJSON* city_item = cJSON_GetObjectItemCaseSensitive(address_item, "city");
        cJSON* district_item = cJSON_GetObjectItemCaseSensitive(address_item, "district");
        if (cJSON_IsString(city_item) && city_item->valuestring) {
            printf("城市: %s\n", city_item->valuestring);
        }
        if (cJSON_IsString(district_item) && district_item->valuestring) {
            printf("区域: %s\n", district_item->valuestring);
        }
    }
    // 4. 释放内存！这是至关重要的一步
    cJSON_Delete(root);
    return 0;
}

步骤3：编译与运行

将上述代码保存为main.c，与cJSON.h和cJSON.c放在同一目录下,然后执行编译命令：

gcc main.c cJSON.c -o my_app -lm

运行生成的可执行文件：

./my_app

预期输出：

姓名: 张三
年龄: 30
是否为学生: 否
成绩: [85, 92, 78]
城市: 北京
区域: 海淀区

关键步骤总结

cJSON_Parse()：将JSON字符串解析成一个cJSON根对象。
错误处理：检查cJSON_Parse的返回值是否为NULL，并使用cJSON_GetErrorPtr()获取解析错误信息。
数据提取：使用cJSON_GetObjectItemCaseSensitive()（或大小写不敏感的版本）根据键名获取JSON项。
类型检查：在访问值之前，务必使用cJSON_IsString(), cJSON_IsNumber(), cJSON_IsArray()等宏进行类型检查,避免因类型不匹配导致的程序崩溃。
遍历数组：对于数组，使用cJSON_ArrayForEach宏进行遍历，这比手动使用child指针更安全、更方便。
释放内存：