GO语言之依赖管理

---

为什么需要依赖管理

最早的时候，Go所依赖的所有的第三方库都放在GOPATH这个目录下面。这就导致了同一个库只能保存一个版本的代码。如果不同的项目依赖同一个第三方的库的不同版本，应该怎么解决？

go module

1、go module是Go1.11版本之后官方推出的版本管理工具，并且从Go1.13版本开始，go module将是Go语言默认的依赖管理工具。
2、要启用go module支持首先要设置环境变量GO111MODULE，通过它可以开启或关闭模块支持，它有三个可选值：off、on、auto，默认值是auto。
3、可以通过命令：go env查看当前开启状态；
GO111MODULE=off禁用模块支持，编译时会从GOPATH和vendor文件夹中查找包。
GO111MODULE=on启用模块支持，编译时会忽略GOPATH和vendor文件夹，只根据 go.mod下载依赖。
GO111MODULE=auto，当项目在$GOPATH/src外且项目根目录有go.mod文件时，开启模块支持。
4、使用 go module 管理依赖后会在项目根目录下生成两个文件go.mod和go.sum。

GOPROXY

Go1.11之后设置GOPROXY命令为：
export GOPROXY=https://goproxy.cn
Go1.13之后GOPROXY默认值为https://proxy.golang.org，在国内是无法访问的，所以十分建议大家设置GOPROXY，这里我推荐使用goproxy.cn。
go env -w GOPROXY=https://goproxy.cn,direct

go mod命令

go mod download 下载依赖的module到本地cache（默认为$GOPATH/pkg/mod目录）
go mod edit 编辑go.mod文件
go mod graph 打印模块依赖图
go mod init 初始化当前文件夹, 创建go.mod文件
go mod tidy 增加缺少的module，删除无用的module
go mod vendor 将依赖复制到vendor下
go mod verify 校验依赖
go mod why 解释为什么需要依赖

go.mod文件

go.mod文件记录了项目所有的依赖信息，其结构大致如下：

module github.com/Q1mi/studygo/blogger

go 1.12

require (
	github.com/DeanThompson/ginpprof v0.0.0-20190408063150-3be636683586
	github.com/gin-gonic/gin v1.4.0
	github.com/go-sql-driver/mysql v1.4.1
	github.com/jmoiron/sqlx v1.2.0
	github.com/satori/go.uuid v1.2.0
	google.golang.org/appengine v1.6.1 // indirect
)

其中，

module用来定义包名
require用来定义依赖包及版本
indirect表示间接引用

go get

在项目中**执行go get命令可以下载依赖包，**并且还可以指定下载的版本。

运行go get -u将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号， y是次要版本号)
运行go get -u=patch将会升级到最新的修订版本
运行go get package@version将会升级到指定的版本号version
如果下载所有依赖可以使用go mod download 命令。

依赖的版本

mod支持语义化版本号，比如go get foo@v1.2.3，也可以跟git的分支或tag，比如go get foo@master，当然也可以跟git提交哈希，比如go get foo@e3702bed2。关于依赖的版本支持以下几种格式：

replace

在国内访问golang.org/x的各个包都需要翻墙，你可以在go.mod中使用replace替换成github上对应的库。

replace (
	golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac => github.com/golang/crypto v0.0.0-20180820150726-614d502a4dac
	golang.org/x/net v0.0.0-20180821023952-922f4815f713 => github.com/golang/net v0.0.0-20180826012351-8a410e7b638d
	golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
)

整理依赖

我们在代码中删除依赖代码后，相关的依赖库并不会在go.mod文件中自动移除。这种情况下我们可以使用go mod tidy命令更新go.mod中的依赖关系。

go mod edit

手动修改go.mod文件
格式化 go mod edit -fmt
添加依赖项 go mod edit -require=golang.org/x/text
移除依赖项 如果只是想修改go.mod文件中的内容，那么可以运行go mod edit -droprequire=package path，比如要在go.mod中移除golang.org/x/text包，可以使用如下命令：
go mod edit -droprequire=golang.org/x/text
关于go mod edit的更多用法可以通过go help mod edit查看。

在项目中使用go module

既有项目
如果需要对一个已经存在的项目启用go module，可以按照以下步骤操作：
在项目目录下执行go mod init，生成一个go.mod文件。
执行go get，查找并记录当前项目的依赖，同时生成一个go.sum记录每个依赖库的版本和哈希值。
新项目
对于一个新创建的项目，我们可以在项目文件夹下按照以下步骤操作：
执行go mod init 项目名命令，在当前项目文件夹下创建一个go.mod文件。
手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖。

go module解决问题

主要解决两个问题
准确地记录项目依赖（项目依赖哪些 package，以及精确的 package 版本）
可重复构建，指项目无论在谁的环境中（同平台）构建，产物都是相同的（这个主要解决 GOPATH 时代问题，每个人的 GOPATH 环境中可能同名依赖包但版本不一，因此构建出的产物会有所不同），这个就是依赖上面的准确记录，因此可以重复构建

一个 module 的版本号规则必须遵循语义化规范，版本号必须使用 v(major).(minor).(patch),如 v0.1.0、v1/5/0-rc.1
major 不兼容的改动时增加此版本
minor 新增特性时增加此版本
patch bug 修复时增加此版本
语义化版本规范的好处是：用户通过版本号就能了解版本信息

package和module的概念
package(包)类似于c++的命名空间，每个package可以有多个源码文件，但是必须位于同一层目录。package内可以有子目录，只不过子目录下就是另一个package的源码了。package内可以使用同一个package的所有资源，不需要像c一样先声明再使用。当import一个package后就可以使用其中的大写字母开头的函数和变量了。
module（模块）就像一个语言级的项目工程文件，每个程序的顶层都要有一个，这个文件主要为了记录该项目依赖的包名和包版本。

一般在代码根目录下执行“go mod init NAME”来生成本module的go.mod文件。如果增删了依赖项，可以用“go mod tidy”来更新go.mod文件。

依赖包的存储

GOMODULE 模式下，依赖包存储在 $GOPATH/pkg/mod 下，该目录下可以存储特定依赖包的多个版本
$GOPATH/pkg/mod 还有个 cache 目录，用来存储依赖包的缓存，每次下载新依赖包都会在此缓存一份
较于 GOPATH 模式，GOMODULE 有两处不同点
依赖包的目录中包含了版本号，每个版本占用一个目录
依赖包的特定版本目录中只包含依赖包文件，不包含 .git 目录
优点

由于依赖包每个版本都有唯一的目录，所以在多目录场景中使用同一依赖包的多版本时才不会发生冲突
由于依赖包的每个版本都有唯一的目录，表示该目录内容不会发生改变，因此没必要存储其位于版本管理系统（Git）中的版本历史信息
只需要下载模块的代码文件，不必克隆整个仓库，大大节省网络带宽和存储资源