Parson JSON 库使用文档

1. 安装指南

要安装 Parson JSON 库，请按照以下步骤操作：

1. 克隆 GitHub 仓库：

   git clone https://github.com/kgabis/parson.git
   

2. 将 parson.h 和 parson.c 文件复制到您的源代码目录中。

3. 运行测试以验证安装：

   make test
   

2. 项目使用说明

Parson 是一个轻量级的 C 语言编写的 JSON 库，支持以下特性：

• 轻量级（仅两个文件）
• 简单的 API
• 使用点符号访问 JSON 值（类似于 C 结构体或大多数面向对象语言的对象）
• C89 兼容
• 测试套件

以下是几个使用 Parson 的示例：

解析 JSON

以下函数会打印出 GitHub 仓库的基本提交信息（日期、SHA 和作者）：

void print_commits_info(const char *username, const char *repo) {
    JSON_Value *root_value;
    JSON_Array *commits;
    JSON_Object *commit;
    size_t i;

    char curl_command[512];
    char cleanup_command[256];
    char output_filename[] = "commits.json";

    sprintf(curl_command,
        "curl -s \"https://api.github.com/repos/%s/%s/commits\" > %s",
        username, repo, output_filename);
    sprintf(cleanup_command, "rm -f %s", output_filename);
    system(curl_command);

    root_value = json_parse_file(output_filename);
    if (json_value_get_type(root_value) != JSONArray) {
        system(cleanup_command);
        return;
    }

    commits = json_value_get_array(root_value);
    printf("%-10.10s %-10.10s %s\n", "Date", "SHA", "Author");
    for (i = 0; i < json_array_get_count(commits); i++) {
        commit = json_array_get_object(commits, i);
        printf("%.10s %.10s %s\n",
               json_object_dotget_string(commit, "commit.author.date"),
               json_object_get_string(commit, "sha"),
               json_object_dotget_string(commit, "commit.author.name"));
    }

    json_value_free(root_value);
    system(cleanup_command);
}

持久化

以下示例使用 Parson 将用户信息保存到文件中，然后加载并验证：

void persistence_example(void) {
    JSON_Value *schema = json_parse_string("{\"name\":\"\"}");
    JSON_Value *user_data = json_parse_file("user_data.json");
    char buf[256];
    const char *name = NULL;
    if (user_data == NULL || json_validate(schema, user_data) != JSONSuccess) {
        puts("Enter your name:");
        scanf("%s", buf);
        user_data = json_value_init_object();
        json_object_set_string(json_object(user_data), "name", buf);
        json_serialize_to_file(user_data, "user_data.json");
    }
    name = json_object_get_string(json_object(user_data), "name");
    printf("Hello, %s.", name);

    json_value_free(schema);
    json_value_free(user_data);
}

序列化

创建 JSON 值非常简单，多亏了点符号。在访问特定字段时，对象层次结构会自动创建。以下示例创建了一个包含个人基本信息的简单 JSON 值：

void serialization_example(void) {
    JSON_Value *root_value = json_value_init_object();
    JSON_Object *root_object = json_value_get_object(root_value);
    char *serialized_string = NULL;
    json_object_set_string(root_object, "name", "John Smith");
    json_object_set_number(root_object, "age", 25);
    json_object_dotset_string(root_object, "address.city", "Cupertino");
    json_object_dotset_value(root_object, "contact.emails", json_parse_string("[\"[e-mail]\",\"[e-mail]\"]"));
    serialized_string = json_serialize_to_string_pretty(root_value);
    puts(serialized_string);
    json_free_serialized_string(serialized_string);
    json_value_free(root_value);
}

输出：

{
    "name": "John Smith",
    "age": 25,
    "address": {
        "city": "Cupertino"
    },
    "contact": {
        "emails": [
            "[e-mail]",
            "[e-mail]"
        ]
    }
}

3. 项目 API 使用文档

Parson 提供了以下主要 API 函数：

• json_parse_file：从文件解析 JSON。
• json_value_get_type：获取 JSON 值的类型。
• json_array_get_count：获取 JSON 数组的元素数量。
• json_array_get_object：从 JSON 数组中获取对象。
• json_object_get_string：从 JSON 对象中获取字符串值。
• json_object_dotget_string：使用点符号从 JSON 对象中获取字符串值。
• json_value_init_object：初始化一个 JSON 对象值。
• json_object_set_string：设置 JSON 对象中的字符串值。
• json_object_dotset_string：使用点符号设置 JSON 对象中的字符串值。
• json_serialize_to_string_pretty：将 JSON 值序列化为格式化的字符串。
• json_free_serialized_string：释放序列化字符串的内存。
• json_value_free：释放 JSON 值的内存。

4. 项目安装方式

请参考“安装指南”部分进行项目安装。