将gRPC / protobuf与go multirepo和go模块一起使用

问题描述

我正在尝试使protoc和protoc-gen-go在使用go模块的多仓库代码库中发挥出色的作用。

我设法使事情或多或少地起作用，直到在我的一个“ api”（即protobuf）存储库中引入了主要版本的改进，并且遇到了一些障碍。

这是我的设置的简化图片：

假设我有两个仓库，github.com/kpruden/base-api和github.com/kpruden/dep-api。

base-api包括由此产生的base-api.proto和base-api.pb.go。

类似地，dep-api包含dep-api.proto和相应的生成代码。另外，dep-api.proto通过base-api.proto语句依赖于import github.com/kpruden/base-api/base-api.proto。

base-api和dep-api都使用go模块，其中dep-api的{​​{1}}指定了对go.mod的依赖。

要完成这项工作，我可以在base-api仓库中运行go mod vendor，将其所有依赖项拉到dep-api目录中，然后将vendor添加到对-I./vendor。

一切正常，直到我决定需要发布protoc的主要版本为止。这是通过将base-api的{​​{1}}行更新为base-api/go.mod来完成的。我不需要保留版本1，因此无需在存储库中创建module子目录，版本2代码和protobuf定义位于存储库的根目录。

起初，这似乎不是问题。由于我没有移动任何文件，因此/v2仍然可以找到v2。但是，在生成的go代码中，必须使用protoc导入base-api.proto的版本2，但是base-api正在生成将其导入import "github.com/kpruden/base-api/v2"的代码。

我的问题是：如何获得protoc生成go代码，以便github.com/kpruden/base-api在正确的模块路径导入protoc？这有可能吗？ protobuf或gRPC的文档都没有关于go模块的很多话要说。 Google在这些项目中为我引出了一些github问题，这些问题涉及支持go模块，但是这些问题大部分是内部讨论，没有太多规定，在处理主要版本发布方面我也没有提及。

解决方法

我能够使某些东西正常工作。我在问题中描述的设置实际上与最终最终可行的设置非常接近。

总而言之，大多数情况下都可以按预期进行：

1. 在父模块中，主要版本更改是通过将/v2附加到module中的go.mod行中来完成的。没有其他要求。特别是，源代码管理中的目录布局不需要在任何地方都有v2。
2. 在子模块中，go代码中引用父模块的v2可以正常处理。使用上面的示例，一个简单的import "github.com/kpruden/base-api/v2"就可以做到。
3. 当包含父protobuf定义时，请使用模块路径：import "github.com/kpruden/base-api/v2/base-api.proto"
4. 为了能够使用protoc生成绑定，请使用go mod vendor将依赖项复制到./vendor中，这样将放置它们，以便可以找到protobuf定义，并在（3 ）。此时protoc -I./vendor ...可以正常工作，生成的go源码中的导入是正确的，大家都很高兴：）