讲师中心 微信公众号
AI工具推荐 视频效率加速

C++如何将protobuf对象序列化为JSON格式

落静姑娘_3553

落静姑娘_3553

发布时间:2026-07-10 12:51:58

|

1023人浏览过

|

来源于php中文网

原创

Protobuf C++对象转JSON需启用json_format模块并正确链接libprotoc,包含google/protobuf/json/json.h头文件;默认紧凑格式输出下划线命名字段,嵌套消息、repeated字段和枚举按规范转换,timestamp等内置类型自动转RFC3339字符串;须检查消息初始化及oneof分支设置,捕获Status异常而非依赖返回值。

c++如何将protobuf对象序列化为json格式

protobuf对象转JSON需要启用json_format模块

默认编译的Protobuf C++库不带JSON序列化能力,必须显式链接 libprotobuf 和 libprotobuf-lite 之外的 libprotoc(或确保启用了 protobuf_json 构建选项),且代码里要包含 google/protobuf/json/json.h。否则调用 MessageToJsonString 会链接失败或报 undefined reference。

  • 使用 CMake 时需确认 find_package(protobuf REQUIRED) 后,链接了 ${Protobuf_LIBRARIES} —— 某些发行版(如 Ubuntu 的 libprotobuf-dev)默认不含 JSON 支持,得自己从源码编译 Protobuf 并开启 -Dprotobuf_BUILD_PROTOC_BINARIES=ON
  • 头文件路径必须正确:不是 google/protobuf/util/json_util.h(旧版已弃用),而是 google/protobuf/json/json.h
  • 如果用的是 Bazel 或 vcpkg,检查是否启用了 protobuf_json feature;vcpkg 中需安装 protobuf[json]

MessageToJsonString 默认输出紧凑格式,字段名按proto定义而非驼峰

Protobuf 的 JSON 序列化遵循官方规范:字段名用小写下划线(user_name),不是生成的 C++ 成员变量名(user_name_)也不是 CamelCase(userName)。默认不换行、无空格,比如 {"user_id":123,"is_active":true}。

  • 若需可读性更好的缩进格式,传入 google::protobuf::json::JsonPrintOptions 实例,并设置 options.add_whitespace = true
  • 若想把 user_id 输出为 userId,需手动配置 options.always_print_primitive_fields = true 并配合自定义 name mapping —— 但 C++ 原生不支持自动驼峰转换,得自己预处理字段名或改用第三方库(如 nlohmann/json + 手动映射)
  • options.preserve_proto_field_names = false 不生效 —— 这个选项只影响“是否保留原始 proto 字段名”,而默认就是 true;设为 false 反而会触发未定义行为

嵌套消息、repeated 字段和枚举值都按标准规则处理

Protobuf JSON 格式对复合类型有明确定义:嵌套消息转为对象,repeated 转为数组,枚举转为字符串名(如 "STATUS_OK")或数值(取决于 options.enforce_proto3_optional_features 和 enum_as_ints 设置)。

Json Schema Toolkit
Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据,从示例 JSON 生成 schema,并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载
  • 空 repeated 字段默认不输出(除非设 options.always_print_primitive_fields = true,但对 repeated 无效;真要强制输出空数组,得先手动填充一个 dummy 元素再删掉 —— 不推荐,应由上游协议约定是否省略)
  • optional 字段在 proto3 中默认不输出 null,即使值为默认(如 int32 为 0);只有显式调用 set_xxx() 后才序列化 —— 这和 proto2 不同,注意前后端协议一致性
  • timestamp/duration 等 Well-Known Types 会被转成 RFC 3339 字符串(如 "2024-05-20T10:30:00Z"),无需额外处理

常见错误:空指针、未初始化字段、oneof 未设置分支

调用 MessageToJsonString 时传入未 new 或未 initialize 的 message 指针,会 crash;更隐蔽的是 oneof 字段未 set 任何分支,导致序列化时抛出 google::protobuf::util::Status 异常(而非返回空字符串)。

立即学习“C++免费学习笔记(深入)”;

  • 务必检查 message.IsInitialized() 返回 true,尤其含 required 字段(proto2)或 oneof(proto3 中虽无 required,但 oneof 必须选其一)
  • 捕获异常:用 google::protobuf::util::Status status = google::protobuf::json::MessageToJsonString(..., &json),不要依赖返回值是否为空
  • 避免直接传 raw pointer:优先用 const MyProto& 或 std::shared_ptr<const myproto></const>,防止临时对象析构后引用失效

实际序列化代码就三行核心:

#include <google/protobuf/json/json.h>
std::string json;
google::protobuf::util::Status status = google::protobuf::json::MessageToJsonString(my_msg, &json);
if (!status.ok()) { /* 处理 error */ }
真正卡住人的从来不是这行调用,而是前面的构建配置、字段语义理解、以及 oneof 是否 set 的静默失败。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
c++和c语言的区别有哪些
c++和c语言的区别有哪些

c++和c语言的区别:1、面向对象编程(OOP)支持不同;2、新增特性不同;3、标准库不同;4、编译方式不同;5、命名空间不同等等。想了解更多c++的相关内容,可以阅读本专题下面的文章。

2208

2024.03.14

c++和python学习顺序推荐
c++和python学习顺序推荐

一般建议先学习C++,再学习Python,因为这样可以逐步从较为底层的编程语言向更高级的语言过渡。想了解更多python的相关内容,可以阅读本专题下面的文章。

979

2024.03.14

python和c++学习性价比分析
python和c++学习性价比分析

Python易于学习,广泛应用于Web开发、数据科学和人工智能等领域,但性能较低。C语言性能高,适用于对性能要求较高的场景,如游戏开发和系统编程,但学习曲线陡峭,错误处理复杂。想了解更多python的相关内容,可以阅读本专题下面的文章。

407

2024.03.14

c语言和c++一样吗
c语言和c++一样吗

c语言和c++是两种不同的编程语言,虽然有相似之处,但存在显著差异。c语言专注于过程式编程和系统级开发,以简洁、高效著称。c++作为c语言的超集,引入了面向对象编程,增强了代码组织和管理能力,但学习曲线也更陡峭。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

307

2024.03.14

c语言和c++先学哪个好
c语言和c++先学哪个好

初学者选择学习c语言还是c++语言,需要根据个人学习目标、背景以及编程兴趣和预期应用方向来决定。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

386

2024.03.14

c语言和c++的区别和联系
c语言和c++的区别和联系

c语言和c++是计算机科学领域应用广泛的编程语言。虽然它们有着相似的基础,但它们在语言类型、语法功能和内存管理方面存在着显著差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

580

2024.03.14

c++软件中文更改教程
c++软件中文更改教程

对于 ide,可通过打开设置,找到语言设置,选择中文,并保存更改。对于非 ide 应用程序,可查找设置或选项,选择语言设置,更改为中文,并保存更改。想了解更多c++的相关内容,可以阅读本专题下面的文章。

1389

2024.03.21

python和java和c++学习性价比分析
python和java和c++学习性价比分析

Python以其易学性、丰富的库和活跃的社区而著称,适合数据科学、人工智能和Web开发。Java以其跨平台性、企业级应用开发和Android应用开发而闻名。C++以其底层控制能力、高效性能和游戏开发而著称。选择哪种语言取决于个人兴趣、职业方向和特定需求。想了解更多python和java和c++的相关内容,可以阅读本专题下面的文章。

1197

2024.03.22

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn