go modules 是 golang 1.11 新加的特性,用来支持包管理。
使用时,需要先开启:
go env -w GO111MODULE=on
另外可以顺便设置一下代理go env -w GOPROXY=https://goproxy.cn,direct
常用命令:
init:生成go.mod文件
download:下载go.mod文件中指明的所有依赖
tidy:整理现有的依赖
graph:查看现有的依赖结构
edit:编辑go.mod文件
vendor:导出项目所有的依赖到vendor目录
verity:校验一个模块是否被篡改过
why:查看为什么需要依赖某模块
Go Module 主要解决了2个问题:
- 准确的记录了项目依赖
- 可重复的构建
版本选择机制
在Go Module 时代,module 版本号要遵循语义化版本规范:
版本格式 v(major).(minor).(patch):
major:当发生不兼容的改动时才可以增加该版本
minor:当有了新增的特性时才可以增加该版本
patch:当有 bug 修复时才可以增加该版本
-
最新版本选择
import "github.com/xxx/M"
如果go.mod 的 require 指令中并没有包含这个依赖,那么 go build 指令则会去 github.com/xxx/M 仓库中寻找最新的符合语义化版本规范的版本。如v1.2.3,然后并在go.mod 文件中增加一条require 依赖:
require github.com/xxx/M v1.2.3
-
最小版本选择
有时记录在go.mod 文件中的依赖包版本会随着引入其他依赖包而发生变化。module A 依赖 module M 的1.0.0 版本,但之后 module A 引入了 module D,而module D 又依赖 module M 的 1.1.1 版本,此时优于依赖的传递,module A 也会选择 1.1.1 版本。
require 指令
replace 指令
replace 仅在当前 module 为 main module 时有效。
replace 指令中的=> 前面的包及其版本号必须在 require 中才有效,否则指令无效,也会被忽略。
替换无法下载的包
由于一些地区的网络问题,有些包无法顺利下载,那么可以使用镜像网站调试依赖包
使用 fork 仓库
禁止被依赖
exclude 指令
go.mod 文件中的 exclude 指令用于排除某个包的特定版本,该指令和replace 指令一样,仅在当前 module 为 main module 时有效。
一般来说,该指令很少被使用,因为很少会显示的排除某个包的某个版本,除非我们知道该版本有很严重的bug。
indirect 指令
go.mod 中,有的包后面会出现 "// indirect" 的标识,这个标识总是出现在 require 指令中,其中 "//" 与代码的行注释一样的表示注释的开始,"indirect" 表示间接的依赖。
在执行 go mod tidy
时,Go Module 会自动整理文件,如果有必要则会在部分依赖包的后面增加注释 "// indirect",被添加"// indirect"的依赖包说明该依赖包被间接引用,而没有被添加"// indirect"的则是直接引用,即明确的出现在某个import语句中。
Go Module 还提供了一个go mod why -m <pkg>
命令来查看,我们为什么会依赖某个包。