c如何读取json格式文件

C语言读取JSON格式文件完全指南

在现代软件开发中,JSON（JavaScript Object Notation）因其轻量级、易读和易于解析的特性，已成为数据交换的事实标准，C语言作为一门古老而强大的系统编程语言，本身并没有内置对JSON格式的原生支持，当需要在C程序中处理JSON数据时，我们必须借助第三方库。

本文将为你提供一个详尽的指南,介绍在C语言中如何读取和解析JSON文件，内容涵盖从选择合适的库到编写完整代码的每一步。

第一步：选择合适的JSON库

C语言的JSON库众多,各有优劣，选择哪个库取决于你的具体需求，如性能、易用性、功能完整性和依赖关系，以下是几个广受欢迎的选择：

cJSON：这是一个非常流行的单头文件/单源文件库，它轻量级、速度快、API简单，非常适合嵌入式系统或对依赖有严格要求的项目，它的主要缺点是API设计上存在一些内存管理上的“陷阱”，需要使用者仔细遵循其规则。
Jansson：一个功能更全面、设计更现代的C库，它提供了类型安全的API，支持严格的JSON验证，并且内存管理模型比cJSON更清晰（基于引用计数），如果你的项目对健壮性和功能有更高要求，Jansson是绝佳选择。
YAJL (Yet Another JSON Library)：以其快速和流式解析能力而闻名，YAJL允许你逐个处理JSON令牌，而无需将整个文档加载到内存中，这对于处理巨大的JSON文件非常有用。

对于本指南,我们将选择 cJSON 作为示例，因为它简单易学，能快速上手，是理解JSON解析原理的绝佳起点。

第二步：获取并集成cJSON库

cJSON最大的优点是它的“便携性”，你只需要下载两个文件：cJSON.h 和 cJSON.c，然后将它们包含在你的项目中即可。

下载：从 cJSON的GitHub仓库下载最新版本。
集成：将 cJSON.h 文件放到你的项目头文件目录，cJSON.c 文件放到源文件目录。
编译：在编译你的C程序时，确保将 cJSON.c 也作为源文件进行编译，使用GCC编译器：
```
gcc your_program.c cJSON.c -o your_program -lm
```
（注意：-lm 是链接数学库，cJSON在某些操作中可能会用到它）。

第三步：编写代码读取和解析JSON

假设我们有一个名为 config.json 的配置文件，内容如下：

{
    "server": "api.example.com",
    "port": 8080,
    "is_enabled": true,
    "timeout": 30.5,
    "tags": ["production", "web", "api"],
    "owner": {
        "name": "John Doe",
        "email": "john.doe@example.com"
    }
}

我们的目标是编写一个C程序,读取这个文件，并提取其中的所有数据。

包含头文件并定义文件路径

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "cJSON.h"
#define FILE_PATH "config.json"

读取JSON文件到内存

cJSON库提供了一个方便的函数 cJSON_ParseWithLengthOpts，它需要一个C字符串作为输入，我们首先需要将整个JSON文件内容读入一个字符缓冲区。

char* read_file_to_string(const char* filepath) {
    FILE* fp = fopen(filepath, "rb");
    if (fp == NULL) {
        perror("Failed to open file");
        return NULL;
    }
    fseek(fp, 0, SEEK_END);
    long file_size = ftell(fp);
    fseek(fp, 0, SEEK_SET);
    char* buffer = (char*)malloc(file_size + 1);
    if (buffer == NULL) {
        perror("Failed to allocate memory");
        fclose(fp);
        return NULL;
    }
    size_t bytes_read = fread(buffer, 1, file_size, fp);
    fclose(fp);
    if (bytes_read != file_size) {
        free(buffer);
        perror("Failed to read file");
        return NULL;
    }
    buffer[file_size] = '\0'; // Null-terminate the string
    return buffer;
}

解析JSON并提取数据

现在我们有了包含JSON数据的字符串,可以将其解析成一个cJSON对象，我们就可以通过键来访问值，并根据值的类型进行转换。

int main() {
    // 1. 读取文件内容
    char* json_string = read_file_to_string(FILE_PATH);
    if (json_string == NULL) {
        return 1;
    }
    // 2. 解析JSON字符串
    cJSON* root = cJSON_Parse(json_string);
    free(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. 提取数据
    // 提取字符串
    cJSON* server_item = cJSON_GetObjectItemCaseSensitive(root, "server");
    if (cJSON_IsString(server_item)) {
        printf("Server: %s\n", server_item->valuestring);
    }
    // 提取数字
    cJSON* port_item = cJSON_GetObjectItemCaseSensitive(root, "port");
    if (cJSON_IsNumber(port_item)) {
        printf("Port: %d\n", port_item->valueint);
    }
    // 提取布尔值
    cJSON* enabled_item = cJSON_GetObjectItemCaseSensitive(root, "is_enabled");
    if (cJSON_IsBool(enabled_item)) {
        printf("Is Enabled: %s\n", cJSON_IsTrue(enabled_item) ? "true" : "false");
    }
    // 提取浮点数
    cJSON* timeout_item = cJSON_GetObjectItemCaseSensitive(root, "timeout");
    if (cJSON_IsNumber(timeout_item)) {
        printf("Timeout: %.2f\n", timeout_item->valuedouble);
    }
    // 提取数组
    cJSON* tags_item = cJSON_GetObjectItemCaseSensitive(root, "tags");
    if (cJSON_IsArray(tags_item)) {
        printf("Tags: ");
        cJSON* tag = NULL;
        cJSON_ArrayForEach(tag, tags_item) {
            if (cJSON_IsString(tag)) {
                printf("%s ", tag->valuestring);
            }
        }
        printf("\n");
    }
    // 提取嵌套对象
    cJSON* owner_item = cJSON_GetObjectItemCaseSensitive(root, "owner");
    if (cJSON_IsObject(owner_item)) {
        cJSON* owner_name = cJSON_GetObjectItemCaseSensitive(owner_item, "name");
        cJSON* owner_email = cJSON_GetObjectItemCaseSensitive(owner_item, "email");
        if (cJSON_IsString(owner_name) && cJSON_IsString(owner_email)) {
            printf("Owner Name: %s\n", owner_name->valuestring);
            printf("Owner Email: %s\n", owner_email->valuestring);
        }
    }
    // 4. 释放内存 (非常重要！)
    cJSON_Delete(root);
    return 0;
}

第四步：理解核心概念与最佳实践

内存管理：这是使用cJSON最关键的一点。
- cJSON_Parse()：从字符串创建JSON对象树，你需要负责在最后调用 cJSON_Delete() 来释放整个树所占用的内存。
- cJSON_Delete()：递归地释放JSON对象树中的所有节点。
- 不要使用 free() 来释放由cJSON创建的任何指针（如 root 或通过 valuestring 获取的字符串），这会导致双重释放错误，cJSON内部有自己的内存管理。
类型检查：JSON有多种数据类型（字符串、数字、布尔值、数组、对象等），在C语言中，一个cJSON指针可以指向任何类型的节点，在访问其值之前，必须使用 cJSON_IsString(), cJSON_IsNumber(), cJSON_IsArray() 等宏来检查节点的类型，否则程序可能会崩溃或产生不可预知的结果。
API选择：cJSON_GetObjectItemCaseSensitive 是推荐使用的函数，因为它能确保键的大小写敏感，这更符合大多数现代API的行为。