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



我想知道如何正确引用外部proto文件。假设我有一个.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找到这个文件。

我的问题是:实际引用这个文件的最佳实践是什么,特别是为了让版本控制满意?原蟾蜍似乎没有go mod等效物。我看到它被逐字复制到项目中(例如在grpc网关中(,或者只是从本地文件系统中引用。

我想你在这里回答了自己的问题。我已经成功地完成了这两项工作:手动逐字复制必要的文件(来自https://github.com/googleapis/googleapis/tree/master/google和https://github.com/protocolbuffers/protobuf/tree/master/src/google/protobuf),并引用了文件的本地副本。

如果您想做到这一点并使版本控制愉快,您可以将这两个存储库作为git子模块添加到存储库中。只需确保使用-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>

最新更新