絕大多數情況下,程序和外部交換的數據,都是結構化的數據。
1. 手工實現——必須掌握的基本功
在的業務類型的同一名字空間下,實現 from_json 和 to_json 兩個自由函數(必要時,也可定義為類型的友元函數),即可實現該結構類型與 nlohmann/json 數據的雙向轉換。
示例:
namesapce d2::ec {
struct Order // 訂單
{string id; int customerID; vector<long> items; double totalAmount; string orderDate;
};// json → Order
void from_json(json const& j, Order& o)
{j.at("id").get_to(o.id);j.at("customerID").get_to(o.customerID);j.at("items").get_to(o.totalAmount);j.at("totalAmount").get_to(o.totalAmount);j.at("orderDate").get_to(o.orderDate);
}// Order → json
void to_json(json& j, Order const& o)
{j["id"] = o.id;j["customID"] = o.customerID;j["items"] = o.items; // 完美支持 STL 容器j["totalAmount"] = o.totalAmount;j["orderDate"] = o.orderDate;
}} // namespace d2::ec
2. 借助宏,快速定義
- NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE // 非侵入式
- NLOHMANN_DEFINE_TYPE_INTRUSIVE // 侵入式
- NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT // 非侵入,且字段缺失時不報錯
- NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT // 侵入式,且字段缺失時不報錯
- NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE // 用于派生類,非侵入式
- NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE // 用于派生類,侵入式
- NLOHMANN_DEFINE_DERIVED_TYPE_NON_INTRUSIVE_WITH_DEFAULT //用于派生類,非侵入,字段缺失不報錯
- NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT //用于派生類,侵入,字段缺失不報錯
- NLOHMANN_JSON_SERIALIZE_ENUM //專用于讓枚舉類型的值,以字符串方式進行 JSON 讀寫
3. 視頻:快速實現結構轉換
011-nlohmann/json-3-結構化轉換
4. 代碼:我要打十個!
#include <iostream>
#include <string>
#include <vector>
#include <chrono> // 時間
#include <optional> // 可選值#include <nlohmann/json.hpp>using json = nlohmann::ordered_json; namespace d2::ec // d2school 電商系統
{// 第1個:訂單狀態
enum class OrderStatus // 訂單狀態
{pending, // 待支付paid, // 已支付 shipped, // 已發貨completed, // 已完成cancelled // 已取消
}; NLOHMANN_JSON_SERIALIZE_ENUM(OrderStatus, {{OrderStatus::pending, "pending"},{OrderStatus::paid, "paid"},{OrderStatus::shipped, "shipped"},{OrderStatus::completed, "completed"},{OrderStatus::cancelled, "cancelled"}
})// 第2個:商品
struct Item
{size_t id; // 商品IDstd::string name; // 商品名稱double price; // 商品價格double discount = 1; // 商品折扣
};NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(Item, id, name, price, discount)// 第3個:客戶
struct Customer
{std::string id; // 客戶IDstd::string nick; // 客戶名稱
};NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE(Customer, id, nick)// 第4個:是否允許周末送貨
enum class WeekendDelivery // 是否允許周末送貨
{pending, // 選定allowed, // 允許denied // 拒絕
};NLOHMANN_JSON_SERIALIZE_ENUM(WeekendDelivery, {{WeekendDelivery::pending, "-"},{WeekendDelivery::allowed, "?"},{WeekendDelivery::denied, "?"}
})// 第5個:收貨地址
struct Address
{std::string name; // 收貨人姓名std::string phone; // 收貨人電話std::string provinice; // 省std::string city; // 市std::string street; // 街道std::string detail; // 詳細地址std::string zip; // 郵政編碼WeekendDelivery weekendDelivery = WeekendDelivery::pending; // 是否允許周末送貨
};NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(Address, name, phone, provinice, city, street, detail, zip, weekendDelivery)// 第6個:時間點
struct TimePoint : std::chrono::system_clock::time_point
{ using BaseClass = std::chrono::system_clock::time_point;using BaseClass::BaseClass; // 繼承構造函數TimePoint (BaseClass const& tp) : BaseClass(tp) {}
};void to_json(json& j, TimePoint const& tp)
{auto t = std::chrono::system_clock::to_time_t(static_cast<TimePoint::BaseClass>(tp));char mbstr[100];if (std::strftime(mbstr, sizeof(mbstr), "%Y-%m-%d %H:%M:%S", std::localtime(&t))){j = mbstr; // 轉換為字符串}else {j = nullptr; // 轉換失敗}
}void from_json(json const& j, TimePoint& tp)
{std::string str = j.get<std::string>();std::tm tm = {};std::istringstream ss(str);ss >> std::get_time(&tm, "%Y-%m-%d %H:%M:%S");if (ss.fail()) {throw std::runtime_error("Failed to parse time point");}std::time_t t = std::mktime(&tm);tp = TimePoint(std::chrono::system_clock::from_time_t(std::mktime(&tm)));
}// 第7個:訂單(概要信息)
struct Order // 訂單
{std::string id; // 訂單ID Customer customer; // 客戶// 第8個:對 std::vector<> 的先天支持std::vector<Item> items; // 包含商品double totalAmount; // 訂單總金額 TimePoint orderTime; // 訂單時間Address address; // 收貨地址OrderStatus status = OrderStatus::pending; // 訂單狀態,默認待支付
}; NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(Order, id, customer, items, totalAmount, orderTime, address, status)// 第9個:訂單詳情(派生類)
class OrderDetail : private Order // 訂單詳情
{
public:OrderDetail(Order const& order): Order(order) // 繼承構造函數{if (status >= OrderStatus::paid){UpdatePayTime(); // 更新支付時間}}void UpdateMemo(std::string_view m){this->memo = m; // 更新備注}void UpdateStatus(OrderStatus newStatus){if (this->status == newStatus){return; // 狀態未改變}if (newStatus == OrderStatus::pending){this->payTime.reset(); // 重置支付時間(變成空)}else if (newStatus >= OrderStatus::paid){if (!this->payTime) // 當前支付時間為空{UpdatePayTime(); // 更新支付時間}}this->status = newStatus; // 更新狀態}public: NLOHMANN_DEFINE_DERIVED_TYPE_INTRUSIVE_WITH_DEFAULT(OrderDetail, Order, memo, payTime)private: // 更新支付時間void UpdatePayTime(){ this->payTime = TimePoint(std::chrono::system_clock::now());}std::string memo; // 訂單備注// 第10個:對 std::optional<> 的先天支持std::optional<TimePoint> payTime; // 支付時間
};}; // namespace d2::ecint main(int, char**)
{using namespace d2::ec;// 創建一個訂單Order o1;o1.id = "O-123456"; // 訂單IDo1.customer = {"C10026Aed", "南飛的大圣"}; // 客戶o1.items = // 商品{ {1232, "iPhone 14 Pro", 9999.0, 0.8},{452, "MacBook Pro 16", 19999.0, 0.9},{30098, "iPad Pro", 7999.0}};o1.totalAmount = [&item = o1.items] () -> double{double total = 0.0;for (auto const& i : item){ total += i.price * i.discount;}return total;}();o1.orderTime = TimePoint(std::chrono::system_clock::now()); // 訂單時間o1.address = {"孫悟空", "13800138000", "福建省", "廈門市", "滄海路", "天匯大廈908號", "3602001",WeekendDelivery::denied}; // 收貨地址o1.status = OrderStatus::pending;// 序列化json j1 = o1; // 序列化為 JSONstd::string jStr = j1.dump(4); // 轉換為字符串std::cout << jStr << std::endl; // 打印 JSON// 反序列化json j2 = json::parse(jStr); // 解析 JSONOrder o2 = j2.get<Order>(); // 反序列化為訂單對象json j3 = o2; // 序列化為 JSONstd::cout << j3.dump(2) << std::endl; // 打印 JSONstd::cout << "\n=====================================\n";OrderDetail od1(o1); // 創建訂單詳情json j4 = od1; // 訂單詳情 -> JSONstd::cout << j4.dump(2) << std::endl; // 打印 JSONstd::cout << "\n------------------------------------------\n"; od1.UpdateStatus(OrderStatus::paid); // 更新狀態:已支付od1.UpdateMemo("「商家」:已付款,請盡快發貨,走順風"); // 更新備注json j5 = od1; // 訂單詳情 -> JSONstd::cout << j5.dump(2) << std::endl; // 打印 JSON
}