如何在c中解析json

C语言中解析JSON的完整指南：从入门到实践

在当今的软件开发中，JSON（JavaScript Object Notation）已成为数据交换的事实标准，无论是从API获取数据，还是配置文件，JSON都以其轻量、易读和易于解析的特性无处不在，C语言作为一种底层、高效的系统编程语言，本身并没有内置对JSON的原生支持，要在C中优雅地处理JSON数据,我们必须借助第三方库。

本文将为你提供一份在C语言中解析JSON的完整指南，涵盖主流库的选择、基本使用方法、处理复杂数据结构以及错误处理等关键环节。

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

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

无动态类型系统：JSON是动态类型的（字符串、数字、布尔值、数组、对象），而C是静态类型的,我们需要手动管理这些类型之间的转换。
手动内存管理：JSON字符串通常需要动态分配内存来构建C中的数据结构（如结构体、链表），我们必须记得在最后释放这些内存,否则会导致内存泄漏。
语法解析复杂性：手写一个完整的JSON解析器是一项艰巨的任务，需要处理各种边界情况、转义字符和嵌套结构。

幸运的是,有许多优秀的开源库为我们解决了这些问题。

主流JSON解析库选择

在C语言生态中，有几个备受推崇的JSON库,各有侧重：

cJSON：最流行、最轻量级的选择。
- 优点：单文件实现（一个.c文件和一个.h文件），极易集成到任何项目中，API简单直观，文档清晰,性能良好。
- 缺点：功能相对基础，高级特性（如流式解析、自定义内存分配器）支持较少。
- 适合场景：绝大多数需要解析JSON的C/C++项目,特别是嵌入式系统或对依赖有严格要求的项目。
Jansson：功能丰富、稳健的选择。
- 优点：API设计更现代化，支持迭代器、流式解析、自定义错误报告和内存分配器，类型检查更严格,代码更健壮。
- 缺点：相比cJSON，文件更多,集成稍复杂一点。
- 适合场景：需要处理大型JSON文件、追求代码健壮性或需要高级特性的复杂应用。
YAJL (Yet Another JSON Library)：流式解析的王者。
- 优点：专注于流式解析（SAX风格），它不会一次性将整个JSON文档加载到内存，而是逐个令牌进行解析,这对于处理GB级别的JSON文件或来自网络的数据流至关重要。
- 缺点：API相对复杂，需要用户自己维护状态,不适合需要随机访问JSON文档的场景。
- 适合场景：解析超大JSON文件、网络数据流、内存受限的环境。

本文将以最广泛使用的 cJSON 为例，进行详细讲解。

使用cJSON解析JSON：一个完整示例

假设我们有以下JSON数据,它表示一个用户信息：

{
    "name": "John Doe",
    "age": 30,
    "isStudent": false,
    "scores": [88, 95, 76],
    "address": {
        "city": "New York",
        "zip": "10001"
    }
}

我们的目标是将其解析为C语言中的可用数据。

步骤1：获取和集成cJSON

从 cJSON的GitHub仓库下载最新版本，它通常包含 cJSON.h 和 cJSON.c 文件,在你的项目中包含它们即可。

步骤2：解析JSON字符串

#include <stdio.h>
#include <stdlib.h>
#include "cJSON.h"
int main() {
    // 1. 准备JSON字符串
    const char *json_string = "{\
        \"name\": \"John Doe\",\
        \"age\": 30,\
        \"isStudent\": false,\
        \"scores\": [88, 95, 76],\
        \"address\": {\
            \"city\": \"New York\",\
            \"zip\": \"10001\"\
        }\
    }";
    // 2. 解析JSON字符串，创建cJSON对象
    cJSON *root = cJSON_Parse(json_string);
    if (root == NULL) {
        const char *error_ptr = cJSON_GetErrorPtr();
        if (error_ptr != NULL) {
            fprintf(stderr, "Error before: %s\n", error_ptr);
        }
        return 1;
    }
    // 3. 从JSON对象中提取数据
    // 提取字符串
    cJSON *name = cJSON_GetObjectItemCaseSensitive(root, "name");
    if (cJSON_IsString(name) && (name->valuestring != NULL)) {
        printf("Name: %s\n", name->valuestring);
    }
    // 提取数字
    cJSON *age = cJSON_GetObjectItemCaseSensitive(root, "age");
    if (cJSON_IsNumber(age)) {
        printf("Age: %d\n", age->valueint);
    }
    // 提取布尔值
    cJSON *is_student = cJSON_GetObjectItemCaseSensitive(root, "isStudent");
    if (cJSON_IsBool(is_student)) {
        printf("Is Student: %s\n", cJSON_IsTrue(is_student) ? "true" : "false");
    }
    // 提取数组
    cJSON *scores = cJSON_GetObjectItemCaseSensitive(root, "scores");
    if (cJSON_IsArray(scores)) {
        printf("Scores: ");
        cJSON *score = NULL;
        cJSON_ArrayForEach(score, scores) {
            if (cJSON_IsNumber(score)) {
                printf("%d ", score->valueint);
            }
        }
        printf("\n");
    }
    // 提取嵌套对象
    cJSON *address = cJSON_GetObjectItemCaseSensitive(root, "address");
    if (cJSON_IsObject(address)) {
        cJSON *city = cJSON_GetObjectItemCaseSensitive(address, "city");
        cJSON *zip = cJSON_GetObjectItemCaseSensitive(address, "zip");
        if (cJSON_IsString(city) && city->valuestring && cJSON_IsString(zip) && zip->valuestring) {
            printf("Address: %s, %s\n", city->valuestring, zip->valuestring);
        }
    }
    // 4. 释放内存
    // 这是至关重要的一步！
    cJSON_Delete(root);
    return 0;
}

代码解析：

cJSON_Parse()：将JSON格式的C字符串解析成一个cJSON对象树，如果解析失败，它会返回NULL。
cJSON_GetObjectItemCaseSensitive()：根据键名从JSON对象中获取对应的cJSON项。CaseSensitive表示区分大小写。
类型检查宏：在访问值之前，必须使用类型检查宏来确保项的类型是正确的。
- cJSON_IsString()
- cJSON_IsNumber()
- cJSON_IsBool()
- cJSON_IsArray()
- cJSON_IsObject()
访问值：
- 字符串：item->valuestring
- 整数：item->valueint
- 布尔值：通过 cJSON_IsTrue() 判断
遍历数组：cJSON_ArrayForEach(score, scores) 是一个方便的宏,用于遍历数组中的每一个元素。
cJSON_Delete()：非常重要！ 这个函数会递归地释放整个JSON对象树所占用的所有内存,忘记调用它会导致严重的内存泄漏。

构建JSON（序列化）

cJSON不仅能解析，还能反向操作——将C数据结构转换为JSON字符串。

int main() {
    // 1. 创建一个JSON对象（根节点）
    cJSON *root = cJSON_CreateObject();
    // 2. 向对象中添加键值对
    cJSON_AddStringToObject(root, "name", "Jane Doe");
    cJSON_AddNumberToObject(root, "age", 28);
    cJSON_AddBoolToObject(root, "isStudent", cJSON_True);
    // 3. 创建一个数组并添加到对象中
    cJSON *scores = cJSON_CreateArray();
    cJSON_AddItemToArray(scores, cJSON_CreateNumber(92));
    cJSON_AddItemToArray(scores, cJSON_CreateNumber(89));
    cJSON_AddItemToObject(root, "scores", scores);
    // 4. 将JSON对象转换为格式化的字符串
    char *json_formatted_string = cJSON_Print(root);
    printf("Formatted JSON:\n%s\n", json_formatted_string);
    // 5. 将JSON对象转换为未格式化的紧凑字符串
    char *json_compact_string = cJSON_PrintUnformatted(root);
    printf("Compact JSON:\n%s\n",

企鹅直播企鹅直播足球直播爱奇艺直播爱奇艺足球直播足球直播足球直播