Golang 子项目或子模块依赖项

标签 go go-get

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 中解决我在示例中提到的问题的推荐方法是什么?

感谢您的帮助!

最佳答案

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

关于示例 1 中的具体要求,如果“客户端”的用户不提取“服务器”代码至关重要,那么客户端和服务器必须位于单独的模块中。这些模块可以位于同一个存储库中,也可以位于不同的存储库中 - 这对 Go 来说没有区别。公共(public)代码必须位于其自己的模块中,例如:

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

然后,使用您的客户端的模块将在其 go.mod 中包含:

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

这将引入客户端common,但不引入服务器

如果服务器可以依赖客户端,则您可以将common作为客户端的一部分,尽管我不确定这会节省多少。

对于示例 2,其想法是相似的 - 公共(public)代码可以进入其自己的模块。


我强烈建议您阅读 Using Go Modules 上的官方博客文章.

有关包含模块的简单 Go 项目布局,请参阅 this post

关于Golang 子项目或子模块依赖项,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/64666173/

相关文章:

go - 如何在 "pretty"文本中查看mgo的bson.Raw

json - Golang 用方括号包裹一个 JSON

Go lang func参数类型

在获取主要版本模块依赖项时出错

docker - 在 Docker 中,无法 cd 进入安装了 "go get"的目录?

Golang 结构字段与 slice 语义 : "has a" slice of structs vs "is a" slice of structs

go - 我的结构没有正确编码并且缺少一个属性

go - 带有 go get 的 Pin 版本

go - 如何在不尝试更新其他模块的情况下将 'go get' 或 'go mod vendor' 用于特定模块?

去获取私有(private) bitbucket repo,禁止 403