protoc Go 包命令本地覆盖？

如何解决protoc Go 包命令本地覆盖？

按照官方 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 需要：

1. 允许命名空间将服务|消息范围限定为例如DNS 域
2. 支持多种编程语言（以不同方式实现命名空间）。

protoc 具有允许（重新）映射的选项，例如使用 protobuf 选项将 protobuf 的包 v1/api 分配到特定于语言的命名空间，例如go_package）。有关 Golang，请参阅 Go Generated Code。

这在使用 Go Modules 时稍微复杂一些，但总而言之，您遇到的可能是上述情况的一些（意外）组合，示例代码假定一个模块名称，而 protoc 正在构建另一个假设。

TL;DR 更新代码的模块引用以反映正确生成的 pb 路径。如果生成代码在错误的位置，您可以简单地将其移动到正确的子目录（路径）但最好更新您的 protoc 命令以将文件生成到正确的目录。

示例

something.proto：

syntax = "proto3";

package v1alpha1;

option go_package = "github.com/me/my-protos;v1alpha1";

注意 go_package 将 proto 包 v1alpha1 别名为我想在 Golang 中引用为 github.com/me/my-protos 的内容。

然后我生成：

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

注意 此示例也生成 gRPC 代码。它避免 (!) protoc 为生成的代码创建路径 github.com/me/my-protos，因为我在该存储库中生成源代码。我只想要创建文件的相对路径 ./api/v1alpha。

产生的结果：

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"
)

注意，我现在可以从不同的存储库访问我的 protos 存储库 github.com/me/my-project/api/v1alpha1，结合存储库和生成的位置来提供我想要的路径。