protoc Go 包命令本地覆盖?
protoc Go Package Command Local Overwrite?
按照 gRPC 官方网站上的快速入门 gRPC Go 指南,它有一个步骤要求用户使用以下命令重新编译更新后的 .proto 文件:
$ protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative helloworld/helloworld.proto
我对新编译的 protobuf 文件如何被“人类编写的”Go 代码使用感到有点困惑。
在示例“人工编写”的 Go 代码中,他们使用以下导入引用 protobuf 代码:
pb "google.golang.org/grpc/examples/helloworld/helloworld"
protoc
不更新此包,而是更新 helloworld/helloworld.proto
命令所在的同一目录中的 运行。protoc
命令如何确保“人类编写的”Go 代码使用了新编译的 protobuf 代码?
我发现这是 Protobufs(和 gRPC)比较混乱的方面之一。
我认为要解决的问题是 Protobufs 需要:
- 允许命名空间将服务|消息范围限定为例如DNS 域
- 支持多种编程语言(以不同方式实现命名空间)。
protoc
具有允许(重新)映射例如使用 protobuf 选项将 protobuf 的包 v1/api
到特定语言的命名空间,例如go_package
)。请参阅 Go Generated Code 了解 Golang。
这在使用 Go Modules 时稍微复杂一些,但总而言之,您遇到的可能是上述的一些(意外的)组合,示例代码假定一个模块名称并且 protoc
是建立在不同的假设之上。
TL;DR 更新代码的模块引用以反映正确生成的 pb
路径。如果生成代码在错误的地方,你可以简单地将它移动到正确的子目录(路径)但是最好更新你的protoc
命令以生成文件到正确的目录。
例子
something.proto
:
syntax = "proto3";
package v1alpha1;
option go_package = "github.com/me/my-protos;v1alpha1";
NOTE go_package
aliases the proto package v1alpha1
to what I want to reference as github.com/me/my-protos
in Golang.
然后我生成:
MODULE="github.com/me/my-protos"
protoc \
--proto_path=. \
--go_out=./api/v1alpha1 \
--go_opt=module=${MODULE} \
--go-grpc_out=./api/v1alpha1 \
--go-grpc_opt=module=${MODULE} \
./something.proto
NOTE This example generate gRPC code too. It avoids (!) protoc
creating a path github.com/me/my-protos
for the generated code because I'm generating the source in that repo. I just want the relative path ./api/v1alpha
where the files will be created.
产生:
my-protos
├── something.proto
├── api
│ └── v1alpha1
│ ├── something_grpc.pb.go
│ └── something.pb.go
├── go.mod
├── go.sum
└── README.md
我可以导入:
import (
pb "github.com/me/my-protos/api/v1alpha1"
)
NOTE From a different repo, I can now access my protos repo github.com/me/my-project/api/v1alpha1
combining the repro and the generated location to give my desired path.
按照 gRPC 官方网站上的快速入门 gRPC Go 指南,它有一个步骤要求用户使用以下命令重新编译更新后的 .proto 文件:
$ protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative helloworld/helloworld.proto
我对新编译的 protobuf 文件如何被“人类编写的”Go 代码使用感到有点困惑。
在示例“人工编写”的 Go 代码中,他们使用以下导入引用 protobuf 代码:
pb "google.golang.org/grpc/examples/helloworld/helloworld"
protoc
不更新此包,而是更新 helloworld/helloworld.proto
命令所在的同一目录中的 运行。protoc
命令如何确保“人类编写的”Go 代码使用了新编译的 protobuf 代码?
我发现这是 Protobufs(和 gRPC)比较混乱的方面之一。
我认为要解决的问题是 Protobufs 需要:
- 允许命名空间将服务|消息范围限定为例如DNS 域
- 支持多种编程语言(以不同方式实现命名空间)。
protoc
具有允许(重新)映射例如使用 protobuf 选项将 protobuf 的包 v1/api
到特定语言的命名空间,例如go_package
)。请参阅 Go Generated Code 了解 Golang。
这在使用 Go Modules 时稍微复杂一些,但总而言之,您遇到的可能是上述的一些(意外的)组合,示例代码假定一个模块名称并且 protoc
是建立在不同的假设之上。
TL;DR 更新代码的模块引用以反映正确生成的 pb
路径。如果生成代码在错误的地方,你可以简单地将它移动到正确的子目录(路径)但是最好更新你的protoc
命令以生成文件到正确的目录。
例子
something.proto
:
syntax = "proto3";
package v1alpha1;
option go_package = "github.com/me/my-protos;v1alpha1";
NOTE
go_package
aliases the proto packagev1alpha1
to what I want to reference asgithub.com/me/my-protos
in Golang.
然后我生成:
MODULE="github.com/me/my-protos"
protoc \
--proto_path=. \
--go_out=./api/v1alpha1 \
--go_opt=module=${MODULE} \
--go-grpc_out=./api/v1alpha1 \
--go-grpc_opt=module=${MODULE} \
./something.proto
NOTE This example generate gRPC code too. It avoids (!)
protoc
creating a pathgithub.com/me/my-protos
for the generated code because I'm generating the source in that repo. I just want the relative path./api/v1alpha
where the files will be created.
产生:
my-protos
├── something.proto
├── api
│ └── v1alpha1
│ ├── something_grpc.pb.go
│ └── something.pb.go
├── go.mod
├── go.sum
└── README.md
我可以导入:
import (
pb "github.com/me/my-protos/api/v1alpha1"
)
NOTE From a different repo, I can now access my protos repo
github.com/me/my-project/api/v1alpha1
combining the repro and the generated location to give my desired path.