slootsu/jsonxx

A C++ light-weight class for JSON

jsonxx

一个为 C++ 量身打造的轻量级 JSON 通用工具，轻松完成 JSON 解析和序列化功能，并和 C++ 输入输出流交互。

使用介绍

• 引入 jsonxx 头文件

#include "jsonxx/json.hpp"
using namespace jsonxx;

• 使用 C++ 的方式的创建 JSON 对象

使用 operator[] 为 JSON 对象赋值

json j;
j["number"] = 1;
j["float"] = 1.5;
j["string"] = "this is a string";
j["boolean"] = true;
j["user"]["id"] = 10;
j["user"]["name"] = "Nomango";

使用 std::initializer_list 为 JSON 对象赋值

// 使用初始化列表构造数组
json arr = { 1, 2, 3 };
// 使用初始化列表构造对象
json obj = {
    {
        "user", {
            { "id", 10 },
            { "name", "Nomango" }
        }
    }
};
// 第二个对象
json obj2 = {
    { "nul", nullptr },
    { "number", 1 },
    { "float", 1.3 },
    { "boolean", false },
    { "string", "中文测试" },
    { "array", { 1, 2, true, 1.4 } },
    { "object", { "key", "value" } }
};

使用辅助方法构造数组或对象

json arr = json::array({ 1 });
json obj = json::object({ "user", { { "id", 1 }, { "name", "Nomango" } } });

• 判断 JSON 对象的值类型

// 判断 JSON 值类型
bool is_null();
bool is_boolean();
bool is_integer();
bool is_float();
bool is_array();
bool is_object();

• 将 JSON 对象进行显式或隐式转换

// 显示转换
auto b = j["boolean"].as_boolean();        // bool
auto i = j["number"].as_integer();         // int32_t
auto f = j["float"].as_float();            // float
const auto& arr = j["array"].as_array();   // arr 实际是 std::vector<json> 类型
const auto& obj = j["user"].as_object();   // obj 实际是 std::map<std::string, json> 类型

// 隐式转换
bool b = j["boolean"];
int i = j["number"];           // int32_t 自动转换为 int
double d = j["float"];         // float 自动转换成 double
std::vector<json> arr = j["array"];
std::map<std::string, json> obj = j["user"];

若 JSON 值类型与待转换类型不相同也不协变，会引发 json_type_error 异常

• 取值的同时判断类型

int n;
bool ret = j["boolean"].get_value(&n); // 若取值成功，ret 为 true

• JSON 对象类型和数组类型的遍历

// 增强 for 循环
for (auto& j : obj) {
    std::cout << j << std::endl;
}

// 使用迭代器遍历
for (auto iter = obj.begin(); iter != obj.end(); iter++) {
    std::cout << iter.key() << ":" << iter.value() << std::endl;
}

• JSON 解析

// 解析字符串
json j = json::parse("{ \"happy\": true, \"pi\": 3.141 }");

// 从文件读取 JSON
std::ifstream ifs("sample.json");

json j;
ifs >> j;

// 从标准输入流读取 JSON
json j;
std::cin >> j;

• JSON 序列化

// 序列化为字符串
std::string json_str = j.dump();
// 美化输出，使用 4 个空格对输出进行格式化
std::string pretty_str = j.dump(4, ' ');

// 将 JSON 内容输出到文件
std::ofstream ofs("output.json");
ofs << j << std::endl;

// 将 JSON 内容输出到文件，并美化
std::ofstream ofs("pretty.json");
ofs << std::setw(4) << j << std::endl;

// 将 JSON 内容输出到标准输出流
json j;
std::cout << j;    // 可以使用 std::setw(4) 对输出内容美化

更多

若你需要将 JSON 解析和序列化应用到非 std::basic_stream 流中，可以通过创建自定义 output_adapter 和 input_adapter 的方式实现。

实际上 json::parse() 和 json::dump() 函数也是通过自定义的 string_output_adapter 和 string_input_adapter 实现对字符串内容的输入和输出。

详细内容请参考 json_parser.hpp 和 json_serializer.hpp

鸣谢

感谢 nlohmann 的 JSON for Modern C++ 项目，本仓库的许多概念和灵感都来源于此。