引用外部原型，如 google/rpc/status.proto

Question

我想知道如何正确引用外部原型文件。假设我有一个 .proto 文件，它引用了标准的 protobuf 类型，例如 Timestamp:

syntax = "proto3";
package api;

import "google/protobuf/timestamp.proto";

message ServerTimeResponse {
  google.protobuf.Timestamp ts = 1;
}

简单。时间戳在编译时自动可用。

现在我添加一个外部输入，说 google.rpc.Status:

syntax = "proto3";
package api;

import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";

message ServerTimeResponse {
  google.protobuf.Timestamp ts = 1;
  google.rpc.Status status = 2;
}

当然我们必须告诉protoc如何通过-I/--proto_path.

找到这个文件。

我的问题是：实际引用此文件的最佳做法是什么，特别是为了让版本控制满意？ protobufs 似乎没有 go mod 等价物。我已经看到它逐字复制到项目中（例如在 grpc-gateway 中）或者只是从本地文件系统中引用。

Answer 1

我认为您在这里回答了您自己的问题。我已经成功地完成了这两件事：手动逐字复制必要的文件（来自 https://github.com/googleapis/googleapis/tree/master/google and https://github.com/protocolbuffers/protobuf/tree/master/src/google/protobuf），并引用文件的本地副本。

如果您想这样做并使版本控制满意，您可以将这两个存储库作为 git submodules 添加到您的存储库中。只需确保使用 -I 将正确的位置传递给 protoc。例如：

cd $PROJECT_DIR
mkdir third_party && cd third_party
git submodule add https://github.com/googleapis/googleapis/tree/master/google
cd $PROJECT_DIR
<git commit the change>
protoc -I third_party/google <the rest of your protoc command>

至于引用文件的本地副本，并确保它们在尝试构建之前存在，您可能会发现将如下内容添加到 Makefile 中会有所帮助（这是在 Go 构建环境中）：

go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
go get -u github.com/golang/protobuf/protoc-gen-go
grpc_gateway_path=$(go list -m -f '{{.Dir}}' github.com/grpc-ecosystem/grpc-gateway)
googleapis_path="$grpc_gateway_path/third_party/googleapis"
protoc -I $googleapis_path --go_out=. <list of input files>

引用外部原型，如 google/rpc/status.proto

Referencing external protos like google/rpc/status.proto

protocol-buffers