c怎么将json格式化

C语言中如何优雅地格式化JSON数据**

在C语言中处理JSON数据,尤其是需要将其以人类可读的格式（即格式化输出）进行展示或存储时，相较于一些高级语言可能会稍微繁琐一些，因为C语言本身并没有内置原生的JSON处理库，借助一些优秀的第三方C JSON库，我们可以轻松实现JSON数据的格式化，本文将介绍几种常用的方法，重点围绕流行的cJSON库展开，并简要提及其他可能性。

为什么需要格式化JSON？

JSON（JavaScript Object Notation）虽然是一种轻量级的数据交换格式，但其原始形式（紧凑形式）可能是一行连续的字符串，不包含任何多余的空格或换行符，这在机器解析时效率很高，但人类阅读起来却比较困难，格式化JSON（通常称为“美化”或“缩进”）意味着：

1. 可读性增强：通过添加适当的换行符和缩进，使JSON数据的层级结构一目了然。
2. 调试便利：在开发过程中，格式化后的JSON更容易检查数据是否正确。
3. 日志友好：日志中的格式化JSON信息更易于追踪和分析。

主流方法：使用cJSON库进行格式化

cJSON 是一个轻量级、简单易用的C语言JSON解析器和生成器，被广泛应用于各种C/C++项目中，它提供了方便的函数来生成和解析JSON数据，同时也支持格式化输出。

准备工作：获取并集成cJSON

你需要获取cJSON库,你可以从其GitHub仓库下载源代码，或者使用包管理器（如vcpkg, conan等）安装。

将下载的cJSON源文件（如cJSON.c和cJSON.h）添加到你的项目中，并确保在编译时链接cJSON源文件或其生成的静态/动态库。

使用cJSON_Print与cJSON_PrintUnformatted

cJSON提供了两个主要的打印函数：

• char *cJSON_Print(const cJSON *item)：将JSON对象格式化为字符串，输出会包含缩进和换行，便于阅读。
• char *cJSON_PrintUnformatted(const cJSON *item)：将JSON对象输出为紧凑的、无缩进无换行的字符串。

示例代码：

#include <stdio.h>
#include <stdlib.h>
#include "cJSON.h"
int main() {
    // 1. 创建JSON对象
    cJSON *root = cJSON_CreateObject();
    cJSON_AddStringToObject(root, "name", "John Doe");
    cJSON_AddNumberToObject(root, "age", 30);
    cJSON_AddBoolToObject(root, "isStudent", cJSON_False);
    cJSON *address = cJSON_CreateObject();
    cJSON_AddStringToObject(address, "street", "123 Main St");
    cJSON_AddStringToObject(address, "city", "New York");
    cJSON_AddItemToObject(root, "address", address); // 添加嵌套对象
    cJSON *hobbies = cJSON_CreateArray();
    cJSON_AddItemToArray(hobbies, cJSON_CreateString("reading"));
    cJSON_AddItemToArray(hobbies, cJSON_CreateString("swimming"));
    cJSON_AddItemToArray(hobbies, cJSON_CreateString("coding"));
    cJSON_AddItemToObject(root, "hobbies", hobbies); // 添加数组
    // 2. 格式化输出JSON
    char *formatted_json = cJSON_Print(root);
    if (formatted_json) {
        printf("Formatted JSON:\n%s\n", formatted_json);
        free(formatted_json); // 记得释放内存
    }
    // 3. 非格式化输出JSON
    char *unformatted_json = cJSON_PrintUnformatted(root);
    if (unformatted_json) {
        printf("\nUnformatted JSON:\n%s\n", unformatted_json);
        free(unformatted_json); // 记得释放内存
    }
    // 4. 释放JSON对象所占内存
    cJSON_Delete(root);
    return 0;
}

编译与运行（假设cJSON.h和cJSON.c在同一目录）：

gcc -o json_format json_format.c cJSON.c -lm
./json_format

输出结果：

Formatted JSON:
{
    "name":    "John Doe",
    "age":     30,
    "isStudent":    false,
    "address":       {
        "street":   "123 Main St",
        "city":     "New York"
    },
    "hobbies":       [
        "reading",
        "swimming",
        "coding"
    ]
}
Unformatted JSON:
{"name":"John Doe","age":30,"isStudent":false,"address":{"street":"123 Main St","city":"New York"},"hobbies":["reading","swimming","coding"]}

从示例中可以清楚地看到,cJSON_Print输出了带有缩进和换行的格式化JSON，而cJSON_PrintUnformatted则输出了一行紧凑的字符串。

注意事项

• 内存管理：cJSON_Print和cJSON_PrintUnformatted返回的字符串都是动态分配的内存，使用完毕后必须调用free()释放，否则会导致内存泄漏。
• 错误处理：虽然示例中省略了，但在实际开发中，应该检查这些函数的返回值是否为NULL，以处理可能的内存分配失败等情况。
• 缩进风格：cJSON的默认缩进风格是4个空格，如果你需要自定义缩进字符（如制表符）或缩进大小，cJSON本身没有直接提供参数，但你可以通过修改cJSON的源码中的CJSON_NESTED_GET_VALUE等宏定义的相关打印逻辑来实现，或者在使用cJSON_Print后对结果字符串进行后处理（不推荐，除非必要），通常使用默认格式即可。

其他C JSON库及其格式化方法

除了cJSON,还有其他一些C JSON库也支持格式化：

1. JSMN (JSON Minimal Parser)：

   特点：极简、快速、单头文件（jsmn.h），但它是一个解析器，不直接提供生成JSON的功能，因此也不直接提供格式化输出的函数，如果你需要用JSMN解析JSON后再手动格式化输出，需要自己编写格式化逻辑，相对复杂。

2. Parson：

   • 特点：轻量级、易用、单头文件（parson.h），它提供了parson_serialize_string_to_buffer等函数，可以通过参数控制格式化，在序列化时设置适当的缩进选项。

   Parson 示例（概念性）：

   // parson 使用示例（简化）
   JSON_Value *root_value = json_value_init_object();
   JSON_Object *root_object = json_value_get_object(root_value);
   json_object_set_string(root_object, "name", "Alice");
   json_object_set_number(root_object, "age", 25);
   // 格式化输出，缩进使用4个空格
   char *serialized_string = json_serialize_to_string_pretty(root_value);
   printf("%s\n", serialized_string);
   free(serialized_string);
   json_value_free(root_value);

3. ujson：

   特点：追求极致性能，适用于对解析速度要求极高的场景，它主要关注解析和生成，格式化功能可能不如cJSON或Parson直接友好，或者需要特定配置。

手动实现简单格式化（不推荐，仅作理解）

如果由于某些原因不能使用第三方库,且JSON结构非常简单，理论上可以自己编写一个递归函数来遍历JSON结构（如果你已经手动解析了JSON字符串），并在遍历时添加换行符和缩进，但这：

• 非常繁琐,需要处理各种数据类型和嵌套情况。
• 容易出错,特别是在处理转义字符、引号等特殊情况时。
• 维护成本高。

强烈建议使用成熟的第三方库如cJSON，它们已经解决了这些问题。

在C语言中格式化JSON数据,最推荐和常用的方法是使用cJSON库，其cJSON_Print()函数能够简单高效地将JSON对象转换为格式化的字符串，大大提升了代码的可读性和调试效率，记得在使用后妥善处理内存分配，根据项目具体需求（如性能、依赖、易用性等），也可以考虑Parson等其他库，但cJSON因其广泛的应用和良好的平衡性，通常是大多数C/C++项目的首选，对于复杂的JSON处理任务，避免重复造轮子，善用开源库是明智之举。