Go中如何让gRPC生成文件的结构体序列化使用camelCase JSON标签
你观察到的两个JSON相关配置根本不是同级的Struct Tag:
- 嵌在
protobuf标签值里的json=isBar是Protobuf体系的内部配置,只对protojson这类Protobuf官方序列化工具生效 - 标准库
encoding/json做序列化时,只会识别字段上独立声明的json:"xxx"标签,也就是你看到的后面那个json:"is_bar,omitempty",所以默认输出蛇形的is_bar字段名。
按维护成本从低到高选择即可:
方案1:用Protobuf官方的protojson序列化(最推荐)
不需要改任何生成配置、不需要改动生成的代码,直接替换序列化用的库即可。protojson默认就会读取protobuf标签里的json=isBar配置,输出你要的驼峰字段名:import "google.golang.org/protobuf/encoding/protojson" // 执行序列化 jsonData, err := protojson.Marshal(&yourFooInstance)这也是Protobuf官方推荐的JSON序列化方式,完全符合Protobuf的JSON映射规范,不会出现字段漏序列化、标签不匹配的问题。
方案2:调整protoc生成参数,直接生成带驼峰标签的代码
如果你必须用标准库encoding/json做序列化,可以在执行protoc生成代码时关闭自动生成蛇形JSON标签的配置,加上参数--go_opt=go_tag_json_name=false:protoc --go_out=. --go_opt=go_tag_json_name=false your_service.proto这个参数会让protoc-gen-go不再强制给字段加蛇形的json tag,如果你在proto文件里给字段显式指定了
json_name,生成的代码就会用你指定的名字作为json tag。比如proto里写:message Foo { bool is_bar = 1 [json_name = "isBar"]; }生成的结构体对应字段的json标签就会是
json:"isBar,omitempty",后续不管怎么重新生成代码都不会变,适合长期维护的项目。方案3:自定义MarshalJSON方法(不改动生成逻辑)
如果既不能换序列化库,也不方便调整protoc的生成配置,可以给Foo类型自定义实现json.Marshaler接口,手动指定驼峰键名:func (f *Foo) MarshalJSON() ([]byte, error) { // 临时定义一个tag符合要求的同结构类型 type alias struct { IsBar bool `json:"isBar,omitempty"` // 其余字段按相同规则补全即可 } return json.Marshal(alias{ IsBar: f.IsBar, }) }缺点是如果结构体字段有增减,需要同步修改这个方法,维护成本稍高。
方案4:临时修改tag(仅适合本地测试)
本地调试的时候可以直接把结构体字段上的json:"is_bar,omitempty"改成json:"isBar,omitempty",但是注意每次重新执行protoc生成代码,这个手动修改都会被覆盖,绝对不要用到生产环境。
内容的提问来源于stack exchange,提问作者Ala_b

