编译protobuf文件生成go代码时添加自定义的field tag

场景

需要使用go-playground/validator对入参进行更细致的验证, （一来相比其他grpc validator plugin, 这个包功能完善一些, 二来项目中使用的gin框架也是依赖于才此包, 保持统一)

当然其他场景可能有一些其他需求, 需要对protobuf文件编译出来的结构体, 添加上一些自定义的tag

问题

如果使用的是官方的protoc-gen-go, 则截止目前(2021.1.10), 仍未支持这个功能, 相关讨论可见:

https://github.com/golang/protobuf/issues/52

解决办法

1、使用gogo/protobuf, 并且使用其自己的插件

https://github.com/gogo/protobuf

demo: https://github.com/gogo/protobuf/blob/master/test/tags/tags.proto

2、使用工具修改编译出来的文件(最终采用)

使用的工具是: https://github.com/favadi/protoc-go-inject-tag

最后只需要修改编译protobuf文件的的shell脚本, 新增类似以下逻辑:

（如果你每次编译protobuf文件都是手输命令, 建议写到shell脚本里)

for file in ${pb_go_files[@]} # pb_go_files即编译出来的*.pb.go文件名
do
    if ! command -v protoc-go-inject-tag > /dev/null 2>&1; then
        `cd ~ && go get github.com/favadi/protoc-go-inject-tag` # 因为项目有可能是gomodule模式, 所以进入home目录再下载
    fi  
    protoc-go-inject-tag -input=./pb/${file}
done

简单review了一下这个工具的实现, 使用的是go/parser包对代码进行语义分析后注入的tag, 并不是特别hack的方法, 所以还是挺靠得住的

最终采用该方法的原因主要是:

• 稳妥起见不想替换官方的protoc-gen-go,
• 相对而言对proto文件的修改是以注释的形式, 侵入性较低, 且语法也比较简洁, 团队应该更容易接受一些