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

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

大晨酱_3816

大晨酱_3816

发布时间:2026-09-09 17:37:45

|

543人浏览过

|

来源于php中文网

原创

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

Protocol Buffer 的扩展字段默认序列化为形如 [package.message.extension] 的 JSON 键名,但可通过 json_name 选项覆盖为简洁、语义清晰的名称,实现与 API 其他部分的一致性。

protocol buffer 的扩展字段默认序列化为形如 `[package.message.extension]` 的 json 键名,但可通过 `json_name` 选项覆盖为简洁、语义清晰的名称,实现与 api 其他部分的一致性。

在使用 Protocol Buffer(尤其是 proto3)与 JSON 交互时,扩展字段(extensions)的默认 JSON 序列化行为往往不符合实际 API 设计需求。例如,当定义了 extend MyMessage 后,jsonpb(或新版 google.golang.org/protobuf/encoding/protojson)会将该扩展字段序列化为带方括号和全限定名的键,如 "[my.package.MyExtension]" —— 这不仅冗长,还破坏了字段命名的一致性,尤其当该扩展逻辑上对应一个业务实体(如 user_profile)且已在其他接口中以扁平键名(如 "user_profile")暴露时。

幸运的是,Protocol Buffer 官方明确支持通过 json_name 字段选项来自定义 JSON 键名,该机制同样适用于扩展字段所引用的子消息字段(注意:json_name 不能直接写在 extend 声明上,而应作用于扩展类型内部的目标字段)。

✅ 正确做法是:在定义扩展所指向的 message 类型时,为其关键字段显式指定 json_name:

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

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

下载
// example.proto
syntax = "proto3";

package myapi;

message UserProfile {
  string name = 1 [json_name = "name"];
  int32 age  = 2 [json_name = "age"];
}

// 扩展目标消息
message User {
  string id = 1;
}

// 定义扩展
extend User {
  UserProfile user_profile = 100;
}

⚠️ 注意:json_name 必须加在 UserProfile 的字段上(如 name, age),而非 extend User { ... } 这一行。这是因为 json_name 控制的是该字段在 JSON 对象中的 key 名,而扩展本身在序列化时仍需通过其类型(UserProfile)生成结构;最终整个 user_profile 子对象将以 "user_profile" 为键嵌入 User 的 JSON 中——这正是你期望的扁平、无括号、无包前缀的效果。

? 补充说明:

  • json_name 值必须是合法的 JSON 键(推荐使用小写字母+下划线或 lowerCamelCase);
  • 若未指定 json_name,系统默认按 lowerCamelCase 规则转换字段名(如 user_profile → userProfile),但无法消除扩展标识符的方括号包装——因此必须依赖上述“在扩展类型内部控制字段名”的间接方式;
  • 使用新版 protojson.MarshalOptions{UseProtoNames: false}(默认即启用)可确保 json_name 生效;旧版 jsonpb 已弃用,建议迁移到 google.golang.org/protobuf/encoding/protojson。

总结:Protocol Buffer 扩展字段的 JSON 键名不可直接重写,但可通过精心设计扩展消息的内部字段 json_name,配合合理的消息结构抽象,完全达成语义清晰、风格统一的 JSON 输出效果。这是符合规范、无需 hack、且长期兼容的最佳实践。

热门AI工具

更多
立刻MV
立刻MV Hot

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

Loomy
Loomy Hot

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

DeepSeek

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

LibLibAI
LibLibAI Hot

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

咔片AIPPT

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

讯飞智作

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

WorkBuddy

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

豆包大模型

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

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

186

2026.02.24

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

113

2026.02.24

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

617

2026.02.24

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

198

2026.02.24

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

437

2026.02.24

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

168

2026.02.24

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

524

2026.02.26

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

185

2026.02.26

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

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

120

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