C++ Jsoncpp 完整使用教程:序列化反序列化+TCP网络项目实战
前言在C网络开发中JSON是最常用的数据交换格式Jsoncpp作为成熟开源库能够快速实现内存对象与JSON字符串互转。本文结合TCP自定义通信协议场景从基础概念、核心类API、序列化/反序列化实操、完整项目落地全方位讲解覆盖Json::Value、Json::Reader、FastWriter、StreamWriter等全部核心组件适配后端网络业务开发。一、基础概念铺垫1.1 序列化与反序列化核心定义序列化将内存中C结构体/自定义业务类转为JSON字符串字节流用于本地文件存储、TCP网络传输。反序列化接收网络字符串/读取文件后将JSON文本还原为C内存对象供业务逻辑读取计算。1.2 项目业务流转场景TCP通信发送流程业务Request对象 → Json序列化JSON字符串 → 协议封装长度\r\n内容\r\n→ Socket发送接收流程Socket读取字节流 → 解码拆分完整JSON报文 → Json反序列化还原Request对象 → 执行业务计算1.3 Jsoncpp核心组件总览Jsoncpp所有能力分为三大模块数据容器、序列化输出工具、反序列化解析工具。类名核心作用使用场景Json::ValueJSON通用数据容器支持对象、数组、数字、字符串、bool、null全部JSON类型序列化/反序列化中间载体所有数据读写都依赖该类Json::FastWriter序列化工具输出无换行无缩进紧凑单行JSON网络传输、接口上报体积最小推荐项目使用Json::StyledWriter序列化工具格式化带缩进换行日志打印、本地调试查看JSON结构Json::StreamWriter新版官方序列化标准工具支持自定义缩进、分隔符新项目、需要灵活定制输出格式场景Json::Reader反序列化解析工具JSON字符串转Json::Value自带错误日志接收网络报文、读取JSON文件解析二、核心容器Json::Value 全API详解Json::Value是整个库的核心序列化前必须把数据存入该对象解析JSON后的结果也统一存储在此类中。2.1 常用构造函数构造写法说明Json::Value val;默认构造初始为null空值Json::Value val(Json::objectValue);指定类型创建空JSON对象可选arrayValue/intValue/stringValue/nullValueJson::Value val(100);直接传入数字自动识别int类型Json::Value val(test);直接传入字符串自动识别string类型2.2 JSON对象键值对读写操作重载[]运算符最常用通过字符串key访问对象字段key不存在时会自动创建key值默认null。Json::Value root; root[username] zhangsan; root[age] 24; root[isVip] true;at()方法严格校验功能与[]一致key不存在直接抛出异常适合需要强校验、防止非法字段场景。std::string name root.at(username).asString();2.3 JSON数组操作append()数组尾部追加元素[下标]下标访问数组元素越界自动扩容Json::Value arr; arr.append(11); arr.append(22); arr.append(json测试); int num arr[0].asInt(); // 获取第一个元素2.4 类型判断接口规避类型转换崩溃取值前优先调用校验存储数据真实类型方法功能说明isNull()是否为空nullisBool()是否布尔值isInt()/isInt64()32/64位有符号整数isUInt()/isUInt64()32/64位无符号整数isDouble()浮点小数isNumeric()任意数字int/doubleisString()字符串类型isArray()JSON数组isObject()JSON键值对象2.5 类型转换取值方法反序列化后从Json::Value取出数据转为原生C类型方法转换类型asBool()boolasInt()/asInt64()有符号整数asUInt()/asUInt64()无符号整数asDouble()double浮点数asString()std::string字符串2.6 通用工具方法方法功能size()对象返回键总数数组返回元素个数empty()判断容器是否无数据clear()清空所有键/数组元素resize(newSize)仅数组可用调整数组长度三、序列化Json::Value → JSON字符串提供4种序列化方案根据网络传输、调试、新项目标准场景区分使用。3.1 Json::FastWriter项目首选网络传输输出单行紧凑JSON无多余空格换行报文体积最小TCP通信推荐。#include iostream #include string #include jsoncpp/json/json.h int main() { Json::Value root; root[name] joe; root[sex] 男; root[age] 25; Json::FastWriter writer; std::string json_str writer.write(root); // 输出{age:25,name:joe,sex:男} std::cout json_str std::endl; return 0; }核心APIstd::string write(const Json::Value root)输入Value对象返回JSON字符串。3.2 Json::StyledWriter调试打印专用带缩进、换行格式化输出可读性强仅用于日志调试不适合网络传输报文偏大。Json::Value root; root[name] joe; root[sex] 男; Json::StyledWriter writer; std::string json_str writer.write(root); std::cout json_str std::endl;输出效果{ name : joe, sex : 男 }3.3 toStyledString() 快捷格式化无需创建Writer实例直接调用Value成员方法等价StyledWriter效果std::string json_str root.toStyledString();3.4 Json::StreamWriter新版官方标准写法官方推荐替代FastWriter/StyledWriter支持自定义缩进、分隔符灵活可控。#include iostream #include string #include sstream #include memory #include jsoncpp/json/json.h int main() { Json::Value root; root[name] joe; root[sex] 男; // 构造工厂 Json::StreamWriterBuilder wbuilder; // 置空缩进实现和FastWriter一致的紧凑输出 wbuilder[indentation] ; std::unique_ptrJson::StreamWriter writer(wbuilder.newStreamWriter()); std::stringstream ss; writer-write(root, ss); std::cout ss.str() std::endl; return 0; }四、反序列化JSON字符串 → Json::Value核心解析类Json::Reader接收JSON文本解析填充至Json::Value并返回解析状态与错误信息。4.1 Reader核心API说明parse(const std::string document, Json::Value root)解析字符串到Value返回值booltrue解析成功false解析失败getFormattedErrorMessages()获取格式化错误日志定位JSON语法错误4.2 基础解析示例#include iostream #include string #include jsoncpp/json/json.h int main() { // 模拟网络接收的JSON报文 std::string json_string {\name\:\张三\, \age\:30, \city\:\北京\}; Json::Reader reader; Json::Value root; bool parse_ok reader.parse(json_string, root); if (!parse_ok) { // 打印解析失败详情 std::cout JSON解析失败 reader.getFormattedErrorMessages() std::endl; return -1; } // 提取字段 std::string name root[name].asString(); int age root[age].asInt(); std::cout 姓名 name 年龄 age std::endl; return 0; }4.3 业务类反序列化封装示例项目中封装成统一接口直接将JSON转为业务对象// 业务类反序列化方法 bool Deserialize(std::string json_buf) { Json::Value root; Json::Reader reader; bool res reader.parse(json_buf, root); if(res) { // 从JSON读取数据赋值成员变量 _data_x root[datax].asInt(); _data_y root[datay].asInt(); _oper static_castchar(root[oper].asInt()); } return res; }五、TCP网络项目完整实战自定义协议5.1 分层业务架构JSON序列化层业务对象 ↔ JSON字符串协议编解码层JSON字符串 ↔ 带长度前缀报文解决TCP粘包5.2 发送端完整流程实例化Request业务对象填充运算数据调用Serialize()FastWriter序列化JSON字符串Encode()封装长度\r\n内容\r\n协议头Socket发送完整报文5.3 接收端完整流程recv读取字节流存入缓冲区Decode()根据长度拆分完整JSON载荷Deserialize()解析JSON还原业务对象执行加减乘除业务计算5.4 可运行完整Demo#include Protocol.hpp #include iostream int main() { // 发送端逻辑 Protocol::Request req(10, 20, ); std::string json_str; req.Serialize(json_str); std::cout 序列化JSON json_str std::endl; // 协议编码增加长度前缀防粘包 std::string send_package Protocol::Encode(json_str); std::cout 编码后完整报文 send_package std::endl; // 模拟网络传输 std::string recv_buffer send_package; // 接收端逻辑 std::string recv_json; bool decode_ok Protocol::Decode(recv_buffer, recv_json); if(!decode_ok) { std::cout 报文解码失败数据不完整 std::endl; return -1; } // 反序列化还原对象 Protocol::Request recv_req; recv_req.Deserialize(recv_json); std::cout 解析结果 recv_req.GetX() recv_req.GetOper() recv_req.GetY() std::endl; return 0; }六、编译配置与开发避坑指南6.1 头文件引入编译命令引入头文件#include jsoncpp/json/json.hg编译链接库g main.cpp -o json_demo -ljsoncpp6.2 高频注意事项键名大小写敏感datax和DataX是两个独立字段序列化、反序列化key必须完全一致类型安全校验取值前先用isXXX()判断类型不同类型直接转换会导致程序崩溃JSON无法解决TCP粘包JSON仅负责数据结构化字节流粘包必须依靠「长度前缀」协议编码处理网络传输优先FastWriter格式化输出体积更大增加网络IO开销仅本地调试使用新版项目推荐StreamWriterFastWriter/StyledWriter属于旧版API官方逐步迭代废弃。总结Json::Value是Jsoncpp唯一数据载体所有JSON对象、数组、基础类型都通过该类存储序列化分三类场景网络传输用FastWriter、调试用StyledWriter、新项目统一使用StreamWriterJson::Reader负责解析JSON文本务必增加解析失败判断与错误日志打印网络开发中JSON仅做数据转换TCP粘包问题需要自定义长度协议配合解决实际项目建议封装序列化/反序列化工具函数统一管理编解码逻辑减少重复代码。