gRPC 服务器和客户端应该在同一个存储库中吗？

Question

我正在使用 Go 使用 gRPC 服务器，我了解 gRPC/Protobuf 的好处之一是您可以使用它通过使用服务器代码中使用的相同消息/服务 API 轻松创建客户端库.如果我正在为我的服务实现一个客户端库，它显然需要导入服务代码和 API，所以我最终会有一个服务、一个服务器和一个客户端组件。在生产级代码中 - 所有这些组件是否应该存在于同一个存储库中并且仅由 go 包分隔？该服务是否应该是它自己的存储库并作为任何希望为该服务实现服务器/客户端库的人的依赖项？

Answer 1

所有这些组件是否应该存在于同一个存储库中并且仅由 go 包分隔？

各种 gRPC 组件不需要都存在于同一个 repo 中。

该服务是否应该是它自己的存储库并作为任何希望为该服务实现服务器/客户端库的人的依赖项？

我使用以下回购组织：

• myapp-proto（通用仓库；客户端和服务器都标记和使用的 git）

• 我的应用程序客户端

• 我的应用服务1

• 我的应用服务2

• 我的应用服务3

例如，从各种数据源（REST API、MySQL、LDAP 等）中提取数据的几个 gRPC 服务——这些服务器 gRPC 服务中的每一个都存在于它们自己的存储库中。有一个 gRPC 客户端包也存在于它自己的存储库中。为了保持变更控制的健全，通用proto定义（和生成的 go 代码）存在于单独的单个 repo 中。

上述设置利用git 版本标记和go 模块来确保客户端和所有服务器都使用兼容版本的 gRPC 消息/服务。向 gRPC 添加方法/字段proto可以独立于客户端/服务器部分完成 - 并在成熟时分阶段进行。

Answer 2

根据我的经验，最好的方法是将原型定义和生成的文件保存在服务器上。我通常将它们放入{SERVER}/pkg/grpc，然后{CLIENT}/internal/services/{SERVER}/grpc根据您的项目结构将它们导入客户端或类似的东西。