依赖管理
为什么需要依赖管理？
最早的时候，Go所依赖的所有的第三方库都放在GOPATH这个目录下面。这就导致了同一个库只能保存一个版本的代码。如果不同的项目依赖同一个第三方的库的不同版本，应该怎么解决？
一、godep
Go语言从v1.5开始开始引入vendor模式，如果项目目录下有vendor目录，那么go工具链会优先使用vendor内的包进行编译、测试等。
godep是一个通过vender模式实现的Go语言的第三方依赖管理工具，类似的还有由社区维护准官方包管理工具dep。
安装
执行以下命令安装godep工具。
2
2
基本命令
安装好godep之后，在终端输入godep查看支持的所有命令。
2
3
4
5
6
7
8
9
2godep go 使用保存的依赖项运行go工具
3godep get 下载并安装具有指定依赖项的包
4godep path 打印依赖的GOPATH路径
5godep restore 在GOPATH中拉取依赖的版本
6godep update 更新选定的包或go版本
7godep diff 显示当前和以前保存的依赖项集之间的差异
8godep version 查看版本信息
9
使用godep help [command]可以看看具体命令的帮助信息。
使用godep
在项目目录下执行godep save命令，会在当前项目中创建Godeps和vender两个文件夹。
其中Godeps文件夹下有一个Godeps.json的文件，里面记录了项目所依赖的包信息。 vender文件夹下是项目依赖的包的源代码文件。
vender机制
Go1.5版本之后开始支持，能够控制Go语言程序编译时依赖包搜索路径的优先级。
例如查找项目的某个依赖包，首先会在项目根目录下的vender文件夹中查找，如果没有找到就会去$GOAPTH/src目录下查找。
godep开发流程
- 保证程序能够正常编译
- 执行godep save保存当前项目的所有第三方依赖的版本信息和代码
- 提交Godeps目录和vender目录到代码库。
- 如果要更新依赖的版本，可以直接修改Godeps.json文件中的对应项
二、go module
go module是Go1.11版本之后官方推出的版本管理工具，并且从Go1.13版本开始，go module将是Go语言默认的依赖管理工具。
GO111MODULE
要启用go module支持首先要设置环境变量GO111MODULE，通过它可以开启或关闭模块支持，它有三个可选值：off、on、auto，默认值是auto。
- GO111MODULE=off禁用模块支持，编译时会从GOPATH和vendor文件夹中查找包。
- GO111MODULE=on启用模块支持，编译时会忽略GOPATH和vendor文件夹，只根据 go.mod下载依赖。
- GO111MODULE=auto，当项目在$GOPATH/src外且项目根目录有go.mod文件时，开启模块支持。
简单来说，设置GO111MODULE=on之后就可以使用go module了，以后就没有必要在GOPATH中创建项目了，并且还能够很好的管理项目依赖的第三方包信息。
使用 go module 管理依赖后会在项目根目录下生成两个文件go.mod和go.sum。
GOPROXY
Go1.11之后设置GOPROXY命令为：
2
3
4
5
2set GOPROXY=https://goproxy.cn (windows)
3
4阿里源 https://mirrors.aliyun.com/goproxy/
5
Go1.13之后GOPROXY默认值为https://proxy.golang.org，在国内是无法访问的，所以十分建议大家设置GOPROXY，这里我推荐使用goproxy.cn。
2
2
go mod命令
常用的go mod命令如下：
2
3
4
5
6
7
8
9
2go mod edit 编辑go.mod文件
3go mod graph 打印模块依赖图
4go mod init 初始化当前文件夹, 创建go.mod文件
5go mod tidy 增加缺少的module，删除无用的module
6go mod vendor 将依赖复制到vendor下
7go mod verify 校验依赖
8go mod why 解释为什么需要依赖
9
go.mod
go.mod文件记录了项目所有的依赖信息，其结构大致如下：
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3go 1.12
4
5require (
6 github.com/go-sql-driver/mysql v1.4.1
7 github.com/golang/protobuf v1.3.2
8 github.com/grpc-ecosystem/grpc-gateway v1.11.3 // indirect
9 github.com/jmoiron/sqlx v1.2.0
10 github.com/micro/go-micro v1.12.0
11 github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4 // indirect
12 go.uber.org/zap v1.10.0
13 google.golang.org/grpc v1.24.0
14 gopkg.in/natefinch/lumberjack.v2 v2.0.0
15)
16
其中，
- module用来定义包名
- require用来定义依赖包及版本
- indirect表示间接引用
依赖的版本
go mod支持语义化版本号，比如go get foo@v1.2.3，也可以跟git的分支或tag，比如go get foo@master，当然也可以跟git提交哈希，比如go get foo@e3702bed2。关于依赖的版本支持以下几种格式：
2
3
4
5
6
2gopkg.in/vmihailenco/msgpack.v2 v2.9.1
3gopkg.in/yaml.v2 <=v2.2.1
4github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e
5latest
6
replace
在国内访问golang.org/x的各个包都需要翻墙，你可以在go.mod中使用replace替换成github上对应的库。
2
3
4
5
6
2 golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac => github.com/golang/crypto v0.0.0-20180820150726-614d502a4dac
3 golang.org/x/net v0.0.0-20180821023952-922f4815f713 => github.com/golang/net v0.0.0-20180826012351-8a410e7b638d
4 golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
5)
6
go get
在项目中执行go get命令可以下载依赖包，并且还可以指定下载的版本。
-
运行go get -u将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号， y是次要版本号)
-
运行go get -u=patch将会升级到最新的修订版本
-
运行go get package@version将会升级到指定的版本号version
2
2
如果下载所有依赖可以使用go mod download命令。
整理依赖
我们在代码中删除依赖代码后，相关的依赖库并不会在go.mod文件中自动移除。这种情况下我们可以使用go mod tidy命令更新go.mod中的依赖关系。
go mod edit
格式化
因为我们可以手动修改go.mod文件，所以有些时候需要格式化该文件。Go提供了一下命令：
2
2
添加依赖项
2
2
移除依赖项
如果只是想修改go.mod文件中的内容，那么可以运行go mod edit -droprequire=package path，比如要在go.mod中移除golang.org/x/text包，可以使用如下命令：
2
2
关于go mod edit的更多用法可以通过go help mod edit查看。
三、在项目中使用go module
既有项目
如果需要对一个已经存在的项目启用go module，可以按照以下步骤操作：
- 在项目目录下执行go mod init，生成一个go.mod文件。
- 编辑文件
- set GO111MODULE=on
- go mod tidy
- 执行go get，查找并记录当前项目的依赖，同时生成一个go.sum记录每个依赖库的版本和哈希值。
新项目
对于一个新创建的项目，我们可以在项目文件夹下按照以下步骤操作：
- 执行go mod init 项目名命令，在当前项目文件夹下创建一个go.mod文件。
- 手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖。
其他请参考：https://blog.csdn.net/zzhongcy/article/details/97243826
2
2
