go mod学习|青训营笔记

105 阅读4分钟

go mod

Go模块(Go Mod)是Go语言从1.11版本开始引入的一种依赖管理系统。它解决了Go语言在依赖管理上的一些问题,并提供了一种标准的方式来处理Go项目的依赖。

模块是什么:

在Go中,模块是一个版本化的代码包集合。每个模块都有一个go.mod文件在其根目录下,该文件定义了模块的路径(其导入路径的前缀)和其依赖项。

依赖管理:

Go Mod允许你明确地管理你的项目依赖的版本。你可以指定依赖的确切版本,或者允许Go Mod为你选择一个兼容的版本。

版本选择:

Go Mod使用语义版本控制。如果一个模块的作者遵循语义版本控制,那么Go Mod可以理解版本之间的兼容性。

版本升级:

你可以使用go get命令来升级到一个模块的新版本,Go Mod会自动更新go.mod文件。

可重复构建:

由于go.mod文件包含了精确的版本信息,所以你的构建是可重复的。其他人获取你的代码时,将会得到相同的依赖版本。

模块代理:

Go Mod支持使用模块代理来提高获取依赖的速度和可靠性。Go团队维护了一个模块代理,但你也可以运行你自己的代理。

如何使用Go Mod

  1. 初始化一个新的模块

使用go mod init命令来初始化一个新的模块。 这会在当前目录下创建一个go.mod文件。

  1. 添加依赖

当你在代码中导入一个新的包,Go Mod会自动添加它。

也可以使用go get命令来手动添加一个依赖。

  1. 更新依赖

使用go get -u命令来更新一个依赖到最新版本。

  1. 删除依赖

使用go mod tidy命令来删除所有未使用的依赖。

  1. 构建和测试

go build go test

怎么理解go.mod文件

go.mod文件是Go Mod用来管理项目依赖的主要文件。它在项目的根目录下,并包含了以下的信息:

  1. 模块路径:这是在go.mod文件的第一行,定义了模块的根导入路径。例如,如果你的模块在GitHub上,那么模块路径可能是module github.com/yourusername/yourproject
  2. Go版本:这定义了你的项目需要的最低Go版本。例如,go 1.13表示你的项目需要Go 1.13或更高版本。
  3. 依赖项:这是go.mod文件的主要部分,列出了你的项目依赖的所有模块及其版本。每个依赖项都有一个路径和一个版本号。例如,require github.com/gin-gonic/gin v1.6.3表示你的项目依赖于github.com/gin-gonic/gin模块的v1.6.3版本。
  4. 替换和排除replaceexclude指令允许你替换或排除特定的模块版本。这在处理依赖冲突或使用分支和修订版时非常有用。

以下是一个go.mod文件的示例:

module github.com/yourusername/yourproject

go 1.13

require (
    github.com/gin-gonic/gin v1.6.3
    github.com/go-sql-driver/mysql v1.5.0
)

replace github.com/gin-gonic/gin v1.6.3 => github.com/gin-gonic/gin v1.6.2

在这个例子中,模块路径是github.com/yourusername/yourproject,Go版本是1.13,项目有两个依赖:github.com/gin-gonic/gingithub.com/go-sql-driver/mysql。并且,github.com/gin-gonic/ginv1.6.3版本被替换为v1.6.2版本。

怎么理解go.sum文件

go.sum文件是Go模块的一部分,它包含了项目所有依赖项的预期加密哈希值。Go使用这些哈希值来确保项目依赖的模块版本在不同的时间和不同的机器上都是一致的,这样可以提高构建过程的可重复性和安全性。

每当你添加或更新一个依赖项,Go都会计算该模块内容的哈希值,并将其添加到go.sum文件中。当你构建或测试你的项目时,Go会检查每个依赖项的哈希值是否与go.sum文件中的值匹配。如果不匹配,Go会报错并停止构建过程。(这也太强了,不愧是你啊go mod)

go.sum文件中的每一行都包含一个模块路径、版本和哈希值。例如,以下是go.sum文件的一部分:

github.com/gin-gonic/gin v1.6.3 h1:W0QH3qGZXK7cZlM8Z6Vn+5e891nEe3lSJ4VhY4Jypf4=
github.com/gin-gonic/gin v1.6.3/go.mod h1:75x/JY7E3Z20YGQjZ0B3m3IDSjjpZ8/J6u4Nyp7rR1M=

在这个例子中,github.com/gin-gonic/gin模块的v1.6.3版本有两个哈希值:

  • 一个是模块内容的哈希值,
  • 另一个是go.mod文件的哈希值。

需要注意的是,go.sum文件可能包含你项目未直接依赖的模块的哈希值。这是因为Go会计算所有依赖项(包括间接依赖项)的哈希值。

总的来说,go.sum文件是Go模块安全性的重要组成部分。它确保了你的项目依赖的模块版本在任何时候都是一致的.

参考资料: