【转】protoc-go-inject-tag 作用


原文:https://www.jianshu.com/p/744d8c080d59

----------------------------

protobuf导出golang,调整默认tag的方法

问题概述

在protobuf导出到golang的时候,生成的.go文件里的struct的tag是没办法灵活设置的,以下面这个message为例




test.proto

type MyMessage struct {
    state         protoimpl.MessageState
    sizeCache     protoimpl.SizeCache
    unknownFields protoimpl.UnknownFields

    Code int64 `protobuf:"varint,1,opt,name=Code,proto3" json:"Code,omitempty"`
}

可以看到Code字段的protobuf和json的tag都是固定的(目前还没有找到方法能通过protoc命令的参数来设置tag),但是这样的struct有时候并不是我们所期待的,比如下面的代码片段:

syntax=proto3;
package test;

option go_package = ".;test";

message MyMessage {
    // @inject_tag: json:"Code"
    int64 Code = 1;
}

可以看到与之前不同的是我们在Code这个字段上面加了一行注释// @inject_tag: json:"Code"
执行

type MyMessage struct {
    state         protoimpl.MessageState
    sizeCache     protoimpl.SizeCache
    unknownFields protoimpl.UnknownFields

    // @inject_tag: json:"Code"
    Code int64 `protobuf:"varint,1,opt,name=Code,proto3" json:"Code"`
}

可以看到Code字段的json tag里的omitempty没有了,这时候如果我们再执行

msg := &MyMessage{Code: 0}
bdata, _ := json.Marshal(msg)
fmt.Println(string(bdata))

这个代码片段,输出就是{"Code": 0}了。达到我们的目的了。当然inject_tag不仅仅可以设置json的tag,它可以设置任何的tag。

总结

protobuf的protoc工具导出golang的时候,导出的结构体的tag是固定死的,在实际的使用中会导致很多不方便或是不灵活,通过protoc-go-inject-tag这个工具,可以inject tag,这样就能灵活的调整导出的pb.go文件里的结构体的tag。



作者:大菜狗RookieDog
链接:https://www.jianshu.com/p/744d8c080d59
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。