协议GO_Package的格式正确吗？ [英] Correct format of protoc go_package?

问题描述

我在Go中有一个现有项目，其中我正在使用Protocol Buffers/GRPC。直到最近，go_package选项都是可选的，生成的GO包名将与原型包名相同。

此文件位于项目根目录中。生成的代码文件(authenticator.pb.go)位于同一位置。原型文件：

syntax = "proto3";

package authenticator;

service Authenticator {...}

生成命令指定要在同一目录中输出：

protoc --go_out=plugins=grpc:. authenticator.proto

今天我拉出了新版本的protocol Buffers编译器和github.com/golang/protobuf/protoc-gen-go。在第一次运行时，a收到警告：

WARNING: Missing 'go_package' option in "authenticator.proto",
please specify it with the full Go package path as
a future release of protoc-gen-go will require this be specified.
See https://developers.google.com/protocol-buffers/docs/reference/go-generated#package for more information.

建议的链接或多或少是无用的。但本教程更加明确：

go_package选项定义软件包的导入路径，该路径 将包含此文件的所有生成的代码。围棋包名称 将是导入路径的最后一个路径组件。例如，我们的 示例将使用包名"tutorialpb"。

option go_package = "github.com/protocolbuffers/protobuf/examples/go/tutorialpb";

将此选项添加到proto文件并重新运行该命令后，输出将结束于此路径(相对于项目根)。类似于：

$GOPATH/src/github.com/<org>/authenticator/github.com/<org>/authenticator/authenticator.pb.go

我尝试了以下备选方案作为go_package名称：

• .
• authenticator

生成发生在正确的位置，但我收到警告：

WARNING: Deprecated use of 'go_package' option without a full import path...

那么，在不破坏项目布局的情况下，正确的方法是什么？

推荐答案

对于纯原始世代，您可以执行以下操作

protoc --go_out=paths=source_relative:./gen -I. authenticator.proto

或要为GRPC生成以下内容，可以使用

protoc --go_out=plugins=grpc:./gen --go_opt=paths=source_relative authenticator.proto

如果此操作失败，您可能使用较新版本的proc，需要改用以下命令。

protoc --go-grpc_out=./gen --go-grpc_opt=paths=source_relative authenticator.proto

这只是Google再次就您应该如何编写和管理代码做出孤立的决定。不过，如果你通过挖洞发了足够多的people having similar problems我发现上面的命令现在可以使用了。除了添加另一个答案中所示的完整导入路径

option go_package = "github.com/example/path/gen;gen";

在上面的Package和Protoc命令之后，您将在项目根目录中有一个模块名称为github.com/example/path的proto文件。然后，您的代码将放置在gen文件夹中，您将负责创建该文件夹。

您可能需要调整SOURCE_Relative的输出位置才能使用，但至少最终不会出现路径重复或必须再次依赖于将代码放在GOPATH中的情况。

这可能会因为this ticket中的其他更改而中断。不幸的是，二进制名是完全相同的，所以如果您遇到问题，请阅读该票据并尝试切换您已经安装的版本，直到新的proc-gen-go准备好投入生产。

这篇关于协议GO_Package的格式正确吗？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！