转载

忘掉GOPATH，迎接Go modules，进入Go项目依赖库版本管理新时代

Go SDK 1.13测试版马上就要发布了。从此版本开始，Go modules依赖库版本管理特性将正式开始推荐使用。本文将解释一些和Go modules相关的一些命令和概念。

Module（模块）定义为一些Go代码包的集合。通常体现为一个含有若干代码包的目录。每个模块可以发布一系列版本。版本号使用 semver（语义化版本）表示。一个模块可能依赖于其它若干模块；准确说来，是依赖于其它若干模块的各自的某个具体版本。每个模块可以在自己的根目录下的 go.mod 文件中指定其所依赖的各个模块的具体版本。

如果你所维护的某个模块尚未使用Go modules管理依赖，你可以打开一个命令行终端，进入此模块根目录，运行下面这条命令将此模块转换为一个使用Go modules管理依赖的模块。

go mod init host.prefex/mypkg

其中， host.prefex/mypkg 为其它包引入此模块中的包时的引入路径的前缀。常常地， host.prefex 为 github.com 等源代码托管网站； mypkg 常为 user/project 这种形式。当然，你也可以将你自己的域名 my.website 用做引入路径的前缀（ host.prefex ）。但是这时如果不能从引入路径 my.website/mypkg 中判断出此代码包使用何种源代码版本管理工具（比如git/hg/svn等），则 my.website 网站必须响应 https://my.website/mypkg?go-get=1 HTTPS请求（HTTP也可以但不推荐），并在在HTML的返回体中的 <head> 部分包含一个 <meta> 标签来指名具体到哪里下载此模块。（本公众号将另开一篇文章详解自定义域名引入路径。）

当go.mod文件已经创建出来之后，我们可以在此文件中手动指定此模块所要依赖的其它模块和这些以来模块的版本号（版本号必须指定但可以使用伪版本号，比如 <v1.12.3 、 >=v1.5.6 、 latest 和分支名 master 等）。我们也可以运行go build和go test等命令来自动发现并且在 go.mod 文件中加入依赖模块和它们的具体版本。手动指定的伪模块版本号将被 go build 等命令更改为确切的版本号。其中

latest 伪版本号将被解读为最新正式发布版本，正式发布版本是标号为形如 vX.Y.Z 的语义化版本（semver， X / Y / Z 均为整数数字）。
分支名伪版本号将被解读为指定分支的最新提交。
而 <v1.12.3 将被解读为 v1.12 系列版中最大的小于 v1.12.3 的版本。

当使用源代码版本管理工具时，一个tag的名称将被视为一个版本号。形如 v1.2.3-pre1 的预发布版本不属于正式版本。（关于模块的版本匹配规则，本公众号将另发一篇文章详述。）

go build 等命令将下载并缓存尚未缓存的依赖模块的版本代码，并将各个模块（包括直接和间接依赖）的哈希存储在 go.sum 文件（和 go.mod 文件处于同一目录）中。

在一个模块目录下运行 go get a.b.c/x/y@v1.2.3 将在此模块的 go.mod 文件中加入一个依赖。

默认情况下， go build 等命令将访问sumdb（Checksum Database，默认值为 https://sum.golang.org/ ）验证各个直接或者间接依赖模块的哈希值是否和各个 go.sum 中记录的哈希值相匹配。如果不匹配，很可能某些环节出了问题（比如下载的模块代码被人恶意更改了）。（关于sumdb，本公众号将另发一篇文章详述。）

一般说来， go.mod 文件中只记录当前模块的直接依赖。每个依赖体现为一条 require 或者 replace 指令。比如

module my.website/cmd/myprogram

require github.com/boltdb/bolt v1.3.0

replace my.website/mypkg github.com/myname/myproject v1.0.0

其中的 replace 指令表示，当遇到引入路径前缀为 my.website/mypkg 的代码包时，真实的下载的代码包为处于路径 github.com/myname/myproject 的 v1.0.0 版本的模块下的相应代码包。

如果你的一个旧项目是使用其它流行第三方工具（比如deps和glide等）来管理包依赖的，则在此项目下运行 go mod init host.prefex/mypkg 命令将自动将此项目转换为一个使用 go modules 管理依赖的项目。

如果你的一个新项目需要依赖于一个当前正使用其它流行第三方工具来管理包依赖的库，则请到此库的根目录下运行以下 go mod init a.b/c 命令（引入路径可任意），然后将生成的 go.mod 中的所有 require 指令复制到你的新项目下的 go.mod 文件中。（至少对于目前的Go SDK 1.12是如此，以后的Go SDK版本可能会对此过程进行改进。）

一些其它的和modules相关的常用命令和命令选项：