golang版本管理工具GO111MODULE

Posted 2020-11-15 embedded-linux

在go1.11版本前，想要对go语言包进行管理，只能依赖第三方库实现，比如Vendor，GoVendor，GoDep，Dep，Glide等等。

1. 开启GO111MODULE

用环境变量 GO111MODULE 开启或关闭模块支持，它有三个可选值：off、on、auto，默认值是 auto。

• GO111MODULE=off 无模块支持，go 会从 GOPATH 和 vendor 文件夹寻找包。
• GO111MODULE=on 模块支持，go 会忽略 GOPATH 和 vendor 文件夹，只根据 go.mod 下载依赖。
• GO111MODULE=auto 在 $GOPATH/src 外面且根目录有 go.mod 文件时，开启模块支持。

在使用模块的时候，GOPATH 是无意义的，不过它还是会把下载的依赖储存在 $GOPATH/src/mod 中，也会把 go install 的结果放在 $GOPATH/bin 中。

2. 定义module

模块根目录和其子目录的所有包构成模块，在根目录下存在 go.mod 文件，子目录会向着父目录、爷目录一直找到 go.mod 文件。

模块路径指模块根目录的导入路径，也是其他子目录导入路径的前缀。

go.mod 文件第一行定义了模块路径，有了这一行才算作是一个模块。

go.mod 文件接下来的篇幅用来定义当前模块的依赖和依赖版本，也可以排除依赖和替换依赖。

module example.com/m 

require (
    golang.org/x/text v0.3.0
    gopkg.in/yaml.v2 v2.1.0 
)

replace (
    golang.org/x/text => github.com/golang/text v0.3.0
)

这个文件不用手写，可以用 go mod init example.com/m 生成 go.mod 的第一行，文件的剩余部分也不用担心，在执行 go build、go test、go list 命令时会根据需要的依赖自动生成 require 语句。

官方建议经常维护这个文件，保持依赖项是干净的。对于国内用户来说，手动维护这个文件是必然的，因为你需要把 golang.org/x/text 替换成 github.com/golang/text 。

3. 相关命令

go list 命令

go list -m 可以查看当前的依赖和版本

go mod 命令

这个子命令用来处理 go.mod 文件。

download download modules to local cache
edit edit go.mod from tools or scripts
graph print module requirement graph
init initialize new module in current directory
tidy add missing and remove unused modules
vendor make vendored copy of dependencies
verify verify dependencies have expected content
why explain why packages or modules are needed

go get 命令

获取依赖的特定版本，用来升级和降级依赖。可以自动修改 go.mod 文件，而且依赖的依赖版本号也可能会变。在 go.mod 中使用 exclude 排除的包，不能 go get 下来。

与以前不同的是，新版 go get 可以在末尾加 @ 符号，用来指定版本。

它要求仓库必须用 v1.2.0 格式打 tag，像 v1.2 少个零都不行的，必须是语义化的、带 v 前缀的版本号。

go get github.com/gorilla/mux    # 匹配最新的一个 tag
go get github.com/gorilla/mux@latest    # 和上面一样
go get github.com/gorilla/mux@v1.6.2    # 匹配 v1.6.2
go get github.com/gorilla/mux@e3702bed2 # 匹配 v1.6.2
go get github.com/gorilla/mux@c856192   # 匹配 c85619274f5d
go get github.com/gorilla/mux@master    # 匹配 master 分支

latest 匹配最新的 tag。

v1.2.6 完整版本的写法。

v1、v1.2 匹配带这个前缀的最新版本，如果最新版是 1.2.7，它们会匹配 1.2.7。

c856192 版本 hash 前缀、分支名、无语义化的标签，在 go.mod 里都会会使用约定写法 v0.0.0-20180517173623-c85619274f5d，也被称作伪版本。

go get 可以模糊匹配版本号，但 go.mod 文件只体现完整的版本号，即 v1.2.0、v0.0.0-20180517173623-c85619274f5d，只不过不需要手写这么长的版本号，用 go get 或上文的 go mod -require 模糊匹配即可，它会把匹配到的完整版本号写进 go.mod 文件。

go build 命令

go build -getmode=vendor 在开启模块支持的情况下，用这个可以退回到使用 vendor 的时代。

 

参考：

1. 用 golang 1.11 module 做项目版本管理

2. Go 1.11 Module全攻略