JeayeSON 使用与技术文档

1. 安装指南

JeayeSON 是一个头文件仅为的 C++14 JSON 库，因此安装非常简单。首先，你需要确保你的系统中有一个支持 C++14 的编译器（推荐 GCC 5.x 或 Clang 3.8+）。此外，JeayeSON 还依赖于 Boost 库（推荐版本 1.55.0+）。

1. 使用 ./configure 脚本生成 jeayeson/config.hpp 文件。这个文件用于配置 JeayeSON 的类型设置。
2. 将 include 目录下的内容复制到你的项目中，或者更优的做法是，将 JeayeSON 作为子模块添加到你的项目中，并将其 include 目录添加到头文件搜索路径中。
3. 若要进行完整安装，可以执行 ./configure && make install。具体前缀选项可以查看 ./configure 脚本。

2. 项目的使用说明

引入头文件

在 C++ 文件中包含 JeayeSON 的头文件：

#include <jeayeson/jeayeson.hpp>

如果是 Windows 系统，并且符号链接无效，可以使用：

#include <jeayeson/value.hpp>

构建和解析 JSON

JeayeSON 提供了简洁的 API 用于创建和解析 JSON。

创建 JSON

构建以下 JSON：

{
  "hello": "world",
  "arr":
  [ 1.1, 2.2, 3.3 ],
  "person":
  {
    "name": "Tom",
    "age": 36,
    "weapon": null
  }
}

可以使用以下代码：

json_value val; // json_value 可以是任何 json 类型；这里，它是一个 json_map
{
  { "hello", "world" }, // 嵌套的键值对表示键/值
  {
    "arr",
    { 1.1, 2.2, 3.3 } // 数组很容易构建
  },
  {
    "person",
    {
      { "name", "Tom" },
      { "age", 36 },
      { "weapon", nullptr } // 也可以使用 json_null
    }
  }
};

读取 JSON 字符串

std::string json; // 在其他地方获取/初始化
json_array arr{ json_data{ json } }; // 用于类型安全的简单聚合

读取文件

json_map map{ json_file{ "my_file.json" } }; // 用于类型安全的简单聚合

写入 JSON

// maps, arrays, 和 values 都可以用在流中
json_map map{ json_file{ "my_file.json" } };
std::cout << map << std::endl;

// 也可以直接写入字符串
std::string const json{ map.to_string() };

JSON 类型的检查和转换

json_map json
{
  { "boolean", false },
  { "str", "..." }
};

// 使用 is<T>() 检查类型
json["boolean"].is<json_value::type::boolean>(); // true
json["str"].is<json_value::type::string>(); // true

// 查询类型枚举
auto const type(json["str"].get_type());

// 使用 as<T>() 进行类型转换以获取完整类型
auto const str(json["str"].as<json_string>());

3. 项目 API 使用文档

JeayeSON 的 API 设计简洁一致，支持类型安全，易于使用。以下是一些关键 API 的简要说明：

• json_value：JSON 值的通用类型，可以是任何 JSON 类型。
• json_map：一个映射，其键为 std::string，值为 json_value。
• json_array：一个 json_value 类型的连续数组。
• json_null：表示 JSON 的 null 值。
• json_int：默认为 int64_t 的 JSON 整数类型。
• json_float：默认为 double 的 JSON 浮点类型。
• json_file：表示文件名的聚合类型。
• json_data：表示 JSON 数据为字符串的聚合类型。

4. 项目安装方式

请参考“安装指南”部分中的步骤进行安装。简要概述如下：

1. 运行 ./configure 脚本以生成配置文件。
2. 将头文件复制到你的项目中或将其作为子模块添加。
3. 若需要完整安装，执行 make install 命令。