protoc 自动生成go文件最重要,也比较容易混淆的问题时,是生成路径的参数,本文简要介绍编写protoc go插件的参数形式,以及影响go文件生成的路径
命令行参数
通常protoc-gen-go生成器不需要命令行参数。但是,在某些复杂的情况下,它们是完成任务的唯一方法,尤其是在设置要在生成的代码中使用的导入路径时。
- 传递参数
通过将参数值放在--go_out后,传递给go生成器。参数是由多个键值对(key=value)使用“,”连接起来的字符串, 如"a=111,b=222,c=333"。
下面的例子中, 参数 a=111,b=222以及import_prefix=xxx/传给 test 生成器,protoc-gen-test 是自定义的测试代码,会打印接收到的参数值。
protoc --test_out=a=111,b=222,import_prefix=xxx/:./db/ --plugin=protoc-gen-test=./protoc-gen-test feed.proto
2021/03/05 11:13:58 protoc-gen-test: info: map[string]string{"a":"111", "b":"222", "import_prefix":"xxx/"}
proto-gen-go的路径参数
影响 proto-gen-go 中的路径参数由如下几个:
- import_prefix=xxx/: 它为所有生成的import路径添加前缀
- go_package : proto file 文件中的option选项, 控制生成文件的包路径
- import_path=foo/bar:如果文件没有声明go_package,则用作包名。如果它包含斜杠,那么最右边的斜杠将被忽略。
- Mfoo/bar.proto=quux/shme: M参数,指定.proto文件编译后的包名(foo/bar.proto编译后为包名为quux/shme)
- paths
其中import_prefix 和 M 参数的区别是:import_prefix 是整体, M 参数是每个包单独修改
import_prefix
包公共前缀, 会在生成的import导入源前统一添加引用路径前缀
为使用import_prefix 生成的文件
package com_ktkt_srv_feed
// Code generated by protoc-gen-test. DO NOT EDIT.
// source: feed.proto
package com_ktkt_srv_feed
import (
proto "github.com/golang/protobuf/proto"
)
// Reference imports to suppress errors if they are not otherwise used.
var _ = proto.Marshal
使用 import_prefix=xxx/生成的文件, 会在import的路径前自动添加 xxx/前缀
// Code generated by protoc-gen-test. DO NOT EDIT.
// source: feed.proto
package com_ktkt_srv_feed
import (
proto "xxx/github.com/golang/protobuf/proto"
)
// Reference imports to suppress errors if they are not otherwise used.
var _ = proto.Marshal
go_package options
protocol buffer language 的 package 概念和go语言中的概念不太吻合。因此增加了一个go_package 的选项,定义了go包文件的导入路径,路径的最后一个部分,将成为go package的名称。
package com.ktkt.srv.feed;
option go_package = "github.com/test/aaa/bbb/testpb";
执行生成命令
protoc --test_out=./db/ --plugin=protoc-gen-test=./protoc-gen-test feed.proto
生成的文件路径:
最终生成的文件, go包名为testpb, 为go_package的最终一级路径
// Code generated by protoc-gen-test. DO NOT EDIT.
// source: feed.proto
package testpb
import (
proto "github.com/golang/protobuf/proto"
)
var _ = proto.Marshal
import_path
如果没有go_package 选项, import_path 确定包名称。如果import_path 包含斜线, 则最右侧斜线之前的内容都会被忽略掉, 最右侧斜线后面的内容作为包名
M<proto filename>=<go import path>
M的作用是修改单个包的生成和引用路径
例如: Mfoo/bar.proto=quux/shme 声明 foo/bar.proto生成的包为 quux/shme。 这也取决于 import_prefix 参数.
使用:
1. 在定义proto文件时, 添加import,引入外部proto文件
2. 生成时指定M选项
syntax = "proto3";
package stock;
import "google/api/annotations.proto";
protoc -I=$GOPATH/src --gogo_out=plugins=Mgoogle/api/annotations.proto=github.com/gogo/googleapis/google/api:. input/*.proto
paths
用于指定生成文件的路径的结构,有两个值
- paths=import 相对于导入路径, 默认值
- paths=source_relative 相对于输入文件,即proto文件的路径
参考文献:
- https://chromium.googlesource.com/external/github.com/golang/protobuf/+/v1.1.0/README.md
- https://developers.google.com/protocol-buffers/docs/proto3#packages
- https://developers.google.com/protocol-buffers/docs/reference/go-generated
有疑问加站长微信联系(非本文作者)