需手动为自定义 struct 添加 MSGPACK_DEFINE 宏声明序列化成员,该宏须置于 struct 内部且不可受 private: 等访问控制符干扰,否则触发编译错误“no matching function for call to 'msgpack::operator”。

msgpack-c 本身不直接支持 C++ 类的自动序列化,必须手动定义 MSGPACK_DEFINE 或重载 msgpack::pack/msgpack::convert,否则会编译失败或运行时解包出错。
如何为自定义 struct 添加 msgpack 序列化支持
msgpack-c 要求显式声明哪些成员参与序列化。最常用方式是用 MSGPACK_DEFINE 宏,它必须放在类/struct 内部且不能有访问控制符干扰(比如不能在 private: 后面直接写)。
常见错误现象:error: no matching function for call to 'msgpack::operator 或解包后字段全为零值——多半是宏没生效或成员名拼错。
- 结构体必须是 POD 类型,或至少所有成员可被直接读写(含 public 继承链中的成员)
-
MSGPACK_DEFINE中的字段顺序要和序列化/反序列化两端严格一致,否则字段错位 - 不支持带默认参数的构造函数自动推导;若需构造对象,应单独实现
msgpack::object::with_type或重载convert - 示例:
struct Person {
std::string name;
int age;
MSGPACK_DEFINE(name, age); // 注意:必须放在这里,且不能加 semicolon
};
序列化到 buffer 和从 buffer 反序列化的典型流程
msgpack-c 的核心是 msgpack::sbuffer(内存 buffer)和 msgpack::unpack(解析器),不依赖文件或网络 I/O,需要自己管理二进制数据流转。
使用场景:跨进程通信、RPC payload、日志快照等需紧凑二进制格式的场合。
- 序列化用
msgpack::pack,返回的是msgpack::sbuffer,其data()和size()可直接用于传输 - 反序列化不能直接用
msgpack::unpack(buf)得到对象,必须再调用get().as,否则只是得到一个泛型() msgpack::object - 若 buffer 来自不可信来源(如网络),务必检查
msgpack::unpack返回的msgpack::unique_ptr<:zone>是否为空,避免空指针解引用 - 示例:
Person p{"Alice", 30};
msgpack::sbuffer sbuf;
msgpack::pack(sbuf, p);
// 反序列化
msgpack::unpacked result;
msgpack::unpack(result, sbuf.data(), sbuf.size());
Person restored = result.get().as<person>();
</person>
处理 std::vector、std::map 等标准容器时的注意事项
msgpack-c 原生支持 std::vector、std::map、std::unordered_map(需额外 include msgpack/adaptor/unordered_map.hpp),但行为和直觉略有差异。
性能影响:嵌套过深或元素极多的容器会显著增加 pack/unpack 时间,且 msgpack::object 构建过程涉及多次内存拷贝。
-
std::vector会被打包为 msgpack array;std::map<:string int>对应 msgpack map,key 必须是 string(其他类型作 key 需自定义 adaptor) - 不要对
std::vector<:shared_ptr>>直接 pack —— shared_ptr 不可序列化,得先解包为裸指针或值语义对象 - 若容器元素是自定义类型,该类型也必须已注册序列化逻辑(即含
MSGPACK_DEFINE或对应 adaptor) - std::string 的编码默认是 binary,不是 UTF-8 校验模式;如需校验,得手动 wrap 成
msgpack::type::raw_ref并指定 encoding
最容易被忽略的是:msgpack 的 schema 是隐式的,没有运行时 type check。发送端改了结构体字段但接收端没同步更新 MSGPACK_DEFINE,程序不会报错,只会静默错位或截断——必须靠版本号字段或封装层做兼容性管控。
C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!











