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

大磊吖_9165

大磊吖_9165

2026-04-11

584人浏览

原创

protobuf3 默认不支持直接序列化为json,需通过google/protobuf/util/json_util.h中的messagetojsonstring()实现,并显式链接libprotobuf-util;默认省略默认值字段,可通过jsonprintoptions控制输出行为。

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

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

Google 官方的 protobuf C++ 库(v3.0+)本身不提供开箱即用的 SerializeToJsonString() 方法。你看到的很多教程里调用的 JsonPrintOptions 或 MessageToJsonString(),其实来自 google/protobuf/util/json_util.h —— 这个头文件不是基础库的一部分,而是 protobuf::util 工具模块,需要显式链接 libprotobuf-util(或对应静态/动态库),否则链接会失败。

常见错误现象:undefined reference to 'google::protobuf::util::MessageToJsonString',本质就是漏了链接或没包含正确头文件。

  • 必须 #include <google></google>
  • 编译时需链接 -lprotobuf -lprotobuf-util(CMake 中对应 target_link_libraries(... protobuf protobuf_util))
  • 确保 Protobuf 版本 ≥ 3.0.0;低于此版本无该工具模块

使用 MessageToJsonString() 的基本流程

这是最常用、最轻量的方式,适合调试和简单导出。它默认使用“规范 JSON”格式(字段名小驼峰转下划线,省略默认值,不保留未知字段)。

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
#include <google>
#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"}
</google>
  • 输出字符串不含换行缩进,如需美化,用 JsonPrintOptions::add_whitespace = true
  • 若字段含 bytes 类型,默认 Base64 编码;设 options.always_print_primitive_fields = true 可强制输出空字段
  • 遇到嵌套 message 或 repeated 字段,自动递归处理,无需手动展开

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

默认行为对调试友好,但生产环境常需定制。比如前端要求 PascalCase 字段名、保留 0 值字段、或兼容旧版 API。

google::protobuf::util::JsonPrintOptions options;
options.preserve_proto_field_names = true;  // 用 proto 定义名(如 user_name),而非 JSON 风格名(user_name → user_name)
options.always_print_primitive_fields = true;  // 输出 int32 id = 0; 对应 "id": 0
options.add_whitespace = true;  // 换行 + 2 空格缩进
options.format_int64_as_number = true;  // int64 输出为数字而非字符串(默认是字符串,防 JS number 精度丢失)

std::string json;
google::protobuf::util::MessageToJsonString(msg, &json, options);
  • preserve_proto_field_names = true 是对接老系统最常开的选项,避免字段名被自动转换
  • format_int64_as_number = true 要谨慎:JS 安全整数上限是 2^53−1,超限后精度丢失,某些场景反而要保持字符串形式
  • 不设置 options 时,所有字段均为默认值,等价于传入一个空构造的 JsonPrintOptions

遇到 unknown field 或 Any 类型怎么办

Protobuf 的 Any 和未知字段(比如新字段被旧客户端收到)在默认 JSON 打印中会被忽略。如果业务依赖这些数据(例如配置下发、灰度字段),必须显式启用解析支持。

  • 对 Any:需先调用 Any::UnpackTo(&target_msg) 再序列化,或使用 JsonParseOptions::ignore_unknown_fields = false 配合反向操作
  • 对未知字段:设 options.ignore_unknown_fields = false 并配合 JsonParseOptions 在解析端启用,但打印端仍不输出;真正要导出未知字段,得用反射遍历 GetReflection()->GetUnknownFields() 手动拼接 —— 这属于高级用法,非常少见
  • 更实际的做法:升级 .proto 文件并重新生成代码,让字段“已知”;或者约定 Any 字段内部封装为标准 JSON string,由业务层二次 decode

真正难的不是怎么转 JSON,而是想清楚哪些字段该出现、用什么命名规则、int64 怎么传、以及 unknown field 是否真的需要暴露 —— 这些决策比写几行代码花的时间多得多。

C++免费学习笔记(深入):立即使用
在学习笔记中,你将探索 C++ 的入门与实战技巧!

相关文章

c++速学教程(入门到精通)
c++速学教程(入门到精通)

c++怎么学习?c++怎么入门?c++在哪学?c++怎么学才快?不用担心,这里为大家提供了c++速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json c++

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2135

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3262

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1096

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

3739

7

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.02

6379

3

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1738

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2684

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

6064

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

5669

6

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习