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

如何为 Protocol Buffers 扩展字段自定义 JSON 字段名

星辰同学_4565

星辰同学_4565

发布时间:2026-09-09 10:44:14

|

443人浏览过

|

来源于php中文网

原创

如何为 Protocol Buffers 扩展字段自定义 JSON 字段名

Protocol Buffers 默认将扩展字段序列化为形如 [package.message.field] 的 JSON 键名,但可通过 json_name 选项直接指定更简洁、符合 API 一致性的字段名,无需修改底层 marshalling 逻辑。

protocol buffers 默认将扩展字段序列化为形如 `[package.message.field]` 的 json 键名,但可通过 `json_name` 选项直接指定更简洁、符合 api 一致性的字段名,无需修改底层 marshalling 逻辑。

在使用 Protocol Buffers(尤其是 proto3)进行 JSON 序列化时,扩展字段(extensions)默认会以带方括号的规范格式(如 "[my.package.MyMessage.my_extension]")作为 JSON 键名输出。这种命名虽符合 protobuf 规范,但在实际 REST API 设计中往往显得冗长且与已有字段风格不一致,影响可读性与兼容性。

幸运的是,protobuf 提供了标准且轻量的解决方案:json_name 字段选项。该选项允许你显式声明任意字段(包括扩展字段)在 JSON 中使用的键名,完全覆盖默认行为。

✅ 正确用法示例(在 .proto 文件中定义):

Comprehensive Three.js 3D graphics reference
Comprehensive Three.js 3D graphics reference

详细的 Three.js 3D 图形参考,涵盖场景设置、相机、几何体、材质、光照、动画、控制器、加载器、数学工具和调试。

下载
syntax = "proto3";

package example;

import "google/protobuf/descriptor.proto";

// 定义扩展目标消息
message TargetMessage {
  // 常规字段(可选)
  string id = 1;
}

// 定义扩展消息
message ExtensionData {
  string metadata = 1;
  int32 priority = 2;
}

// 声明扩展,并通过 json_name 指定友好键名
extend TargetMessage {
  ExtensionData my_extension = 100 [json_name = "extension_data"];
}

⚠️ 注意事项:

  • json_name 必须是合法的 JSON 键名字符串(建议使用小写字母+下划线或小驼峰,避免空格或特殊符号);
  • 该选项仅影响 JSON 编码/解码行为,不影响二进制 wire 格式或 gRPC 通信;
  • 使用 json_name 后,反序列化(unmarshalling)时也需按此名称传入 JSON 字段,否则字段将被忽略;
  • 若多个扩展共用同一 json_name,会导致 JSON 解析冲突,应确保唯一性;
  • Go 中需使用 google.golang.org/protobuf/encoding/jsonpb(v2)或 google.golang.org/protobuf/encoding/protojson(推荐),旧版 github.com/golang/protobuf/jsonpb(v1)不支持扩展字段的 json_name —— 这是关键兼容性前提。

? 小贴士:对于已广泛使用的扩展,可通过添加别名字段 + json_name 并保留旧字段(标记为 deprecated = true)实现平滑迁移,兼顾向后兼容与接口整洁性。

综上,无需 hack 底层 marshalling 逻辑或自定义 encoder,只需在 .proto 中为扩展字段添加 json_name 选项,即可优雅实现语义清晰、风格统一的 JSON 接口设计。

热门AI工具

更多
SkildArt
SkildArt Hot

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

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

DeepSeek

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

3856

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1215

2023.07.28

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

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

1578

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

9323

2023.08.17

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

860

2023.09.01

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

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

2284

2023.09.04

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

1449

2023.09.14

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

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

3849

2023.09.21

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

160

2026.09.23

热门下载

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

精品课程

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

共101课时 | 20.6万人学习

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

共39课时 | 4.7万人学习

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

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