c++如何将内存中的Protobuf对象转为Json文本【技巧】

首页

编程语言

热心网友

转载

2026-05-06

C++如何将内存中的Protobuf对象转为Json文本【技巧】

c++如何将内存中的Protobuf对象转为Json文本【技巧】

免费影视、动漫、音乐、游戏、小说资源长期稳定更新！ 👉 点此立即查看 👈

先明确一个核心事实：Protobuf 3 默认并不支持直接序列化为JSON。很多开发者初次尝试时，会下意识地寻找一个类似 SerializeToJsonString() 的方法，结果发现根本不存在。这其实是一个常见的认知误区。

Protobuf 3 默认不支持直接序列化为 JSON

Google 官方的 Protobuf C++ 库（从 v3.0 开始）在设计上就将核心序列化与 JSON 转换功能分开了。基础库只负责二进制格式的读写，而将对象转为 JSON 文本这个“高级”功能，被放在了独立的工具模块里。

具体来说，你在网上教程里看到的 JsonPrintOptions 或 MessageToJsonString() 函数，它们的真实地址是 google/protobuf/util/json_util.h。这个头文件隶属于 protobuf::util 工具模块，需要你显式地链接对应的库文件（通常是 libprotobuf-util）。

如果你忽略了这一步，编译时就会遇到那个经典的链接错误：undefined reference to 'google::protobuf::util::MessageToJsonString'。这本质上就是告诉开发者：你只带了核心引擎，但忘了装变速箱。

所以，正确的准备工作是：

包含正确的头文件：#include
链接必要的库：在编译命令中添加 -lprotobuf -lprotobuf-util（如果使用 CMake，则是在 target_link_libraries 中添加 protobuf 和 protobuf_util）。
检查版本：确保你的 Protobuf 版本不低于 3.0.0，早期的版本没有这个工具模块。

使用 `MessageToJsonString()` 的基本流程

搞定了依赖，实际转换就非常简单了。MessageToJsonString() 是最直接、最轻量的方式，非常适合用于调试日志或简单的数据导出。

它的默认行为可以概括为“规范 JSON”模式：字段名会自动从 proto 定义的小驼峰（如 userName）转换为下划线形式（user_name），所有等于默认值的字段（比如 int32 类型的 0）会被省略，未知字段也不会被输出。

#include 
#include "your_message.pb.h"

YourMessage msg;
msg.set_id(123);
msg.set_name("test");

std::string json;
google::protobuf::util::MessageToJsonString(msg, &json);
// 此时 json 的内容将是：{"id":123,"name":"test"}

几个需要注意的细节：

默认输出的 JSON 字符串是紧凑格式，没有换行和缩进。如果需要更易读的“美化”格式，需要通过选项开启。
如果字段类型是 bytes，默认会进行 Base64 编码后输出。
对于嵌套的 message 或 repeated 数组字段，函数会自动递归处理，开发者无需手动遍历，这一点非常省心。

控制 JSON 输出行为：`JsonPrintOptions` 关键参数

默认行为对调试很友好，但在生产环境中，往往需要根据前后端约定进行定制。比如，前端要求字段名保持原样（PascalCase），或者要求即使值为 0 的字段也必须出现在 JSON 中。

这时候，JsonPrintOptions 就派上用场了。它提供了一系列开关，让你能精细控制输出结果。

立即学习“C++免费学习笔记（深入）”；

google::protobuf::util::JsonPrintOptions options;
options.preserve_proto_field_names = true;  // 使用 proto 中定义的原始字段名，不进行任何转换
options.always_print_primitive_fields = true;  // 强制输出所有原始类型字段，即使其值为默认值（如 int32 id = 0; 会输出 "id": 0）
options.add_whitespace = true;  // 输出带换行和缩进（2个空格）的美化格式
options.format_int64_as_number = true;  // 将 int64/uint64 字段输出为 JSON 数字，而不是默认的字符串（为防止 Ja vaScript 中的大数精度丢失）

std::string json;
google::protobuf::util::MessageToJsonString(msg, &json, options);

这里有几个实用的经验：

preserve_proto_field_names 可能是对接老系统时最常用的选项，它能确保字段名在传输过程中“原汁原味”。
format_int64_as_number 需要谨慎使用。虽然输出为数字更符合直觉，但 Ja vaScript 的安全整数上限是 2^53-1。如果 int64 的值可能超过这个范围，保持字符串形式反而是更安全的选择，以避免前端精度丢失。
如果不传递 options 参数，函数内部会使用一个所有值均为默认的 JsonPrintOptions 对象，也就是我们最开始提到的“规范 JSON”模式。

遇到 unknown field 或 Any 类型怎么办

Protobuf 的 Any 类型和未知字段（比如用旧版 proto 生成的程序收到了带有新字段的数据）在序列化为 JSON 时会遇到一些特殊情况。默认情况下，它们会被直接忽略。

如果你的业务逻辑依赖这些数据（例如动态配置下发、灰度字段），就需要一些额外处理：

对于 Any 类型：通常需要先调用 Any::UnpackTo(&target_msg) 将其解包到具体的消息类型中，然后再序列化该目标消息。或者，在解析端配合使用 JsonParseOptions::ignore_unknown_fields = false 进行反向操作。
对于未知字段：让序列化函数直接输出未知字段是比较复杂的。即便在解析端设置了 ignore_unknown_fields = false，打印端默认仍然不会输出。一个高级做法是利用反射 API，通过 GetReflection()->GetUnknownFields() 获取未知字段并手动拼接成 JSON，但这在实践中相当少见。
更务实的建议：对于长期存在的需求，最好的办法是升级 .proto 文件定义并重新生成代码，让字段变得“已知”。或者，可以约定将 Any 字段的内容封装为一个标准的 JSON 字符串，由业务层在需要时进行二次解码。