c如何读取json格式文件

C语言读取JSON文件：实用指南与代码示例

JSON（JavaScript Object Notation）因其轻量级、易读易写的特性，已成为现代应用程序中数据交换的主流格式之一，在C语言这种更接近系统底层的语言中处理JSON，虽然不像一些高级语言那样内置原生支持，但借助成熟的第三方库，我们可以高效地实现JSON文件的读取与解析，本文将介绍如何在C语言中使用流行的第三方库（如cJSON）来读取和解析JSON文件。

为什么在C中需要处理JSON？

C语言广泛应用于系统编程、嵌入式开发、高性能服务器等领域，在这些场景中，经常需要从配置文件、API响应或其他数据源中读取结构化数据，JSON提供了一种简洁且标准化的数据表示方式,使得数据交换更加便捷。

选择合适的JSON库

C语言中没有内置的JSON处理库，因此我们需要借助第三方库,社区中存在多个优秀的JSON库，

• cJSON：轻量级、单文件、易于集成，解析速度快，API简单易用,本文将以cJSON为例进行讲解。
• Jansson：功能丰富，提供严格的JSON检查,API设计也比较现代。
• yajl：另一个高性能的JSON解析库,支持流式解析。

对于初学者和大多数应用场景，cJSON是一个非常好的选择。

使用cJSON读取JSON文件的步骤

以下是使用cJSON库读取并解析JSON文件的详细步骤：

获取并集成cJSON库

你需要获取cJSON库，你可以从其GitHub仓库（https://github.com/DaveGamble/cJSON）下载最新版本，cJSON库的核心文件只有cJSON.h和cJSON.c，以及一个CMakeLists.txt（可选）。

在你的C项目中，只需将这两个文件添加到你的工程中即可，如果你使用gcc编译器,可以这样编译：

gcc your_program.c cJSON.c -o your_program -I/path/to/cjson/include (如果cJSON.h不在标准路径)

包含头文件

在你的C源代码文件中,包含cJSON的头文件：

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

读取JSON文件内容到内存

cJSON库提供了一系列函数来解析JSON格式的字符串,我们首先需要将JSON文件的全部内容读取到一个字符串缓冲区中。

char* read_json_file(const char* filename) {
    FILE* file = fopen(filename, "rb"); // 以二进制模式打开
    if (!file) {
        perror("Failed to open file");
        return NULL;
    }
    fseek(file, 0, SEEK_END);
    long length = ftell(file);
    fseek(file, 0, SEEK_SET);
    char* buffer = (char*)malloc(length + 1);
    if (!buffer) {
        fclose(file);
        perror("Failed to allocate memory");
        return NULL;
    }
    size_t read_bytes = fread(buffer, 1, length, file);
    if (read_bytes != length) {
        free(buffer);
        fclose(file);
        perror("Failed to read file");
        return NULL;
    }
    buffer[length] = '\0'; // 确保字符串以null结尾
    fclose(file);
    return buffer;
}

使用cJSON解析JSON字符串

获取到包含JSON数据的字符串后，可以使用cJSON_Parse()函数进行解析：

cJSON* root = cJSON_Parse(json_string);
if (!root) {
    const char* error_ptr = cJSON_GetErrorPtr();
    if (error_ptr) {
        fprintf(stderr, "Error before: %s\n", error_ptr);
    } else {
        fprintf(stderr, "Unknown error parsing JSON.\n");
    }
    free(json_string); // 释放之前分配的内存
    return 1;
}

cJSON_Parse()会返回一个指向cJSON结构体根节点的指针，该结构体代表了JSON数据的顶层结构（例如一个对象或数组）。

遍历和访问JSON数据

解析成功后,我们可以使用cJSON提供的函数来遍历和访问JSON数据中的各个元素。

假设我们有如下一个config.json文件：

{
    "name": "Example App",
    "version": "1.2.3",
    "debug_mode": true,
    "features": [
        "authentication",
        "logging",
        "notifications"
    ],
    "settings": {
        "max_users": 100,
        "timeout": 30
    }
}

我们可以这样访问其内容：

// 访问字符串值
cJSON* name = cJSON_GetObjectItemCaseSensitive(root, "name");
if (name && cJSON_IsString(name)) {
    printf("Name: %s\n", name->valuestring);
}
// 访问布尔值
cJSON* debug_mode = cJSON_GetObjectItemCaseSensitive(root, "debug_mode");
if (debug_mode && cJSON_IsBool(debug_mode)) {
    printf("Debug Mode: %s\n", cJSON_IsTrue(debug_mode) ? "true" : "false");
}
// 访问数组
cJSON* features = cJSON_GetObjectItemCaseSensitive(root, "features");
if (features && cJSON_IsArray(features)) {
    int feature_count = cJSON_GetArraySize(features);
    printf("Features (%d):\n", feature_count);
    for (int i = 0; i < feature_count; i++) {
        cJSON* feature = cJSON_GetArrayItem(features, i);
        if (feature && cJSON_IsString(feature)) {
            printf("  - %s\n", feature->valuestring);
        }
    }
}
// 访问嵌套对象
cJSON* settings = cJSON_GetObjectItemCaseSensitive(root, "settings");
if (settings && cJSON_IsObject(settings)) {
    cJSON* max_users = cJSON_GetObjectItemCaseSensitive(settings, "max_users");
    if (max_users && cJSON_IsNumber(max_users)) {
        printf("Max Users: %d\n", max_users->valueint);
    }
    cJSON* timeout = cJSON_GetObjectItemCaseSensitive(settings, "timeout");
    if (timeout && cJSON_IsNumber(timeout)) {
        printf("Timeout: %d\n", timeout->valueint);
    }
}

注意：cJSON_GetObjectItemCaseSensitive区分大小写，如果需要不区分大小写，可以使用cJSON_GetObjectItem。

释放内存

非常重要的一步是，使用完cJSON对象后，必须调用cJSON_Delete()来释放所有分配的内存,否则会导致内存泄漏。

cJSON_Delete(root); // 释放整个JSON对象树
free(json_string); // 释放之前读取文件时分配的字符串内存

完整示例代码

将上述步骤整合起来，一个完整的读取config.json文件的示例如下：

#include <stdio.h>
#include <stdlib.h>
#include "cJSON.h" // 确保cJSON.h在你的包含路径中
char* read_json_file(const char* filename) {
    FILE* file = fopen(filename, "rb");
    if (!file) {
        perror("Failed to open file");
        return NULL;
    }
    fseek(file, 0, SEEK_END);
    long length = ftell(file);
    fseek(file, 0, SEEK_SET);
    char* buffer = (char*)malloc(length + 1);
    if (!buffer) {
        fclose(file);
        perror("Failed to allocate memory");
        return NULL;
    }
    size_t read_bytes = fread(buffer, 1, length, file);
    if (read_bytes != length) {
        free(buffer);
        fclose(file);
        perror("Failed to read file");
        return NULL;
    }
    buffer[length] = '\0';
    fclose(file);
    return buffer;
}
int main() {
    const char* filename = "config.json";
    char* json_string = read_json_file(filename);
    if (!json_string) {
        return 1;
    }
    cJSON* root = cJSON_Parse(json_string);
    if (!root) {
        const char* error_ptr = cJSON_GetErrorPtr();
        if (error_ptr) {
            fprintf(stderr, "Error before: %s\n", error_ptr);
        } else {
            fprintf(stderr, "Unknown error parsing JSON.\n");
        }
        free(json_string);
        return 1;
    }
    // 解析并使用数据...
    printf("Successfully parsed JSON file: %s\n", filename);
    // 访问示例
    cJSON* name = cJSON_GetObjectItemCaseSensitive(root, "name");
    if (name && cJSON_IsString(name)) {
        printf("App Name: %s\n", name->valuestring);
    }
    cJSON* features = cJSON_GetObjectItemCaseSensitive(root, "features");
    if (features && cJSON_IsArray(features)) {
        printf("Features:\n");
        cJSON* feature = NULL;
        cJSON_ArrayForEach(feature, features) {
            if (cJSON_IsString(feature)) {
                printf("  - %s\n", feature->valuestring);
            }
        }
    }
    // 释放内存
    cJSON_Delete