C++ nlohmann json库快速使用

前言

C++ nlohmann/json 库是一个非常易用，高性能的 json 库。

CMake FetchContent方式集成

include(FetchContent)  
FetchContent_Declare(json  
        URL https://github.com/nlohmann/json/releases/download/v3.11.3/json.tar.xz)  
FetchContent_MakeAvailable(json)  
  
target_link_libraries(json_demo PRIVATE nlohmann_json::nlohmann_json)

快速使用

包含头文件以及声明命名空间别名：

#include <nlohmann/json.hpp>
using json = nlohmann::json;

解析json

从文件读取解析

// method 1
std::ifstream f("example.json");
json data = json::parse(f);

// method 2
std::ifstream i("file.json");
json j;
i >> j;

从字符串读取解析

// Using (raw) string literals and json::parse
json ex1 = json::parse(R"(
  {
    "pi": 3.141,
    "happy": true
  }
)");

// Using user-defined (raw) string literals
using namespace nlohmann::literals;
json ex2 = R"(
  {
    "pi": 3.141,
    "happy": true
  }
)"_json;

// Using initializer lists
json ex3 = {
  {"happy", true},
  {"pi", 3.141},
};

遍历

// special iterator member functions for objects
for (json::iterator it = o.begin(); it != o.end(); ++it) {
  std::cout << it.key() << " : " << it.value() << "\n";
}

// the same code as range for
for (auto& el : o.items()) {
  std::cout << el.key() << " : " << el.value() << "\n";
}

// even easier with structured bindings (C++17)
for (auto& [key, value] : o.items()) {
  std::cout << key << " : " << value << "\n";
}

查找 Key

if (j.contains("key")) {
}

if (j.find("foo") != o.end()) {
}

读取 key

auto value = j["key"];
auto value = j.at("key");
std::string value = j["key"].template get<std::string>();

// C++17 
using namespace std::literals;
// 如果key不存在，则返回默认值0
int v_integer = j.value("integer"sv, 0); 

删除 key

// delete an entry
o.erase("foo");

注意：数组可能无法删除单个元素

写入 json 文件

std::ofstream o("pretty.json");
o << std::setw(4) << j << std::endl;

序列化设置缩进

// 按照四个空格缩进打印json
std::cout << j.dump(4) << std::endl;

总结

以上就是在使用 json 库时的常用场景。

https://github.com/nlohmann/json

https://github.com/nlohmann/json/tree/develop/docs/examples