时间戳

首页 > 解决方案 > Golang 子项目或子模块依赖

go - Golang 子项目或子模块依赖

问题描述

Golang 中推荐的下载依赖项子模块的方法是什么？我认为我的问题可以用例子来最好地描述。

示例 #1：

我有一个客户端和一个服务器。我的服务器是一个 API，并且有许多其他依赖项，例如数据库、消息队列、consul 等。我希望我的客户端是一个轻量级的包，用户只需下载客户端所需的少量依赖项。

您可以说客户端和服务器可以位于不同的存储库中。但是，它们之间也可能有一些通用代码，如果我们遵循这种模式，它们将再次成为另一个存储库。

我正在考虑一些看起来像这样的结构：

service/
---> common/
------> redis.go
------> kafka.go
---> client/
------> client.go
---> server/
------> database/
------> swagger/
------> producer/
------> etc/

示例 #2：

项目共享模型是很常见的。如果我们有通过具有通用模型的消息代理进行通信的微服务，我们可能需要这样的结构。

service/
---> model/
------> message.go
---> service1/
---> service2/

与其他语言的比较

我来自 Scala/Java 背景，不到一个月就开始使用 Golang。与 Scala 相比，我可以通过两种方式处理这个问题。让我们以示例＃2为例

  1. 将模型发布为自己的 jar 并model.jar在每个服务中导入
  2. 在 sbt 中使用多项目设置：https ://www.scala-sbt.org/1.x/docs/Multi-Project.html 。

我在 Go 中探索的一些东西

  1. https://blog.gopheracademy.com/advent-2015/vendor-folder/
  2. https://github.com/golang/go/wiki/Modules#faqs--multi-module-repositories

但到目前为止，他们似乎没有解决我的问题

最后的问题

在 Golang 中解决我在示例中陈述的问题的推荐方法是什么？

谢谢您的帮助！

标签： gogo-get

解决方案

一般来说，尽量坚持一个repo和一个模块。将您的代码库拆分为多个存储库和/或多个模块会产生随时间增长的成本。您需要在自己的模块之间定义清晰的版本依赖关系，仔细进行分阶段升级等。特别是对于中小型项目，一个 repo 和一个模块是最好的方法。

关于您在示例 1中的具体要求，如果“客户端”的用户不拉“服务器”代码至关重要，那么客户端和服务器必须位于单独的模块中。这些模块可以在同一个 repo 中，也可以在不同的 repo 中——这对 Go 没有任何影响。公共代码必须在自己的模块中，例如：

github.com/user/myrepo/
  client/
    go.mod
  server/
    go.mod
  common/
    go.mod

然后，使用您的客户端的模块将在其go.mod：

require github.com/user/myrepo/client <version>

这将拉入clientand common，但不是server。

如果服务器可以依赖客户端，那么您可能会common参与其中client，尽管我不确定这会节省多少。

对于示例 2，这个想法是相似的 - 通用代码可以进入它自己的模块。

我强烈建议您阅读有关使用 Go 模块的官方博客文章。

有关带有模块的简单 Go 项目布局，请参阅这篇文章

推荐阅读