golang中的包管理工具——govendor和godep简单学习

为什么用vendor目录

依赖问题

我们知道，一个工程稍大一点，通常会依赖各种各样的包。而Go使用统一的GOPATH管理依赖包，且每个包仅保留一个版本。而不同的依赖包由各自的版本工具独立管理，所以当所依赖的包在新版本发生接口变更或删除时，会面临很多问题。
为避免此类问题，我们可能会为不同的工程设置不同的GOPATH，或者更改依赖包路径名称。这样手动维护起来也很头疼。

解决方式

如果我们已经使用GOPATH去存储packages了，问什么还需要使用vendor目录呢？这是为了解决同一个包不同版本之间依赖问题。
假如多个应用使用一个依赖包的不同版本？这个问题不只是Go应用，其他语言也会有这个问题。
vendor目录允许不同的代码库拥有它自己的依赖包，并且不同于其他代码库的版本，这就很好的做到了工程的隔离。

常用的依赖包管理工具有godep，govendor等，这里选择vendor作为golang中的包管理工具。
Go 1.5引入了vendor文件夹，其对语言使用，go命令没有任何影响。若某个路径下边包含vendor文件夹，则在某处引用包时，会优先搜索vendor文件夹下的包。
在Go 1.5开启该项特性需设置GO15VENDOREXPERIMENT=1，而从Go 1.6开始，该项特性默认开启。vendor在go build时能够将应用搜索路径调整成为 “当前项目目录/vendor目录”的方式。通过这种形式，可以实现类似于 godep 方式的项目依赖管理。

注意：即使在项目中已经使用了vendor，该项目及vendor文件夹路径也必须在GOPATH中。在go项目及其工具链中，目前是逃不掉GOPATH的。

安装与简单使用

安装

使用go get命令即可实现快速安装。

go get -u github.com/kardianos/govendor

使用说明

#进入到项目目录
cd /Users/username/go/src/goproject

#初始化vendor目录
govendor init

#使用ls查看goproject项目下的目录，可以看到已经生成了vendor目录
ls
cache cmd comman database  main.go model service utils vendor  #这里是ls命令返回的结果

#vendor会将GOPATH中本工程使用到的依赖包自动移动到vendor目录中
#说明：如果本地GOPATH没有依赖包，先go get安装相应的依赖包，然后使用下面命令添加进vendor目录
govendor add +external 或使用缩写： govendor add +e 

#Go1.6以上版本默认开启 GO15VENDOREXPERIMENT 环境变量，可忽略下面的步骤。
#Go1.5通过设置环境变量 GO15VENDOREXPERIMENT=1 使用vendor文件夹构建文件。
#可以选择 export GO15VENDOREXPERIMENT=1 或 GO15VENDOREXPERIMENT=1 go build 执行编译
export GO15VENDOREXPERIMENT=1

govendor只是用来管理项目的依赖包，如果GOPATH中本身没有项目的依赖包，则需要通过go get先下载到GOPATH中，再通过govendor add +external拷贝到vendor目录中。Go 1.6以上版本默认开启GO15VENDOREXPERIMENT环境变量。

命令使用

常见的命令如下，格式为 govendor COMMAND。
命令 功能

命令	功能
init	初始化 vendor 目录
list	列出所有的依赖包
add	添加包到 vendor 目录，如 govendor add +external 添加所有外部包
add PKG_PATH	添加指定的依赖包到 vendor 目录
get	类似 go get 命令，拉取依赖包到 vendor 目录
update	从 $GOPATH 更新依赖包到 vendor 目录
remove	从 vendor 管理中删除依赖
status	列出所有缺失、过期和修改过的包
fetch	添加或更新包到本地 vendor 目录
sync	本地存在 vendor.json 时候拉取依赖包，匹配所记录的版本
migrate	从原有工具中移动包到带有元数据的vendor文件夹

一些命令的缩写形式

使用规约

使用vendor时，建议遵循如下两条规约。
a) 当欲将某包vendor时，可能想将所有依赖包均vendor；
b) 尽量将vendor依赖包结构扁平化，不要vendor套vendor。
如下示例代码演示vendor扁平化使用。
main.go位于$GOPATH/src/github.com/olzhy/test下。

package main

import (
    "strings"
    "sync"
    "time"

    "github.com/z"
    "github.com/y"
    "golang.org/z"
)
...

$GOPATH/src/github.com/olzhy/test目录树。

├─ main.go
└─ vendor
├─ github.com
│ ├─ x
│ └─ y
└─ golang.org
└─ z

godep学习

介绍

godep是golang的包管理工具，是解决包依赖的管理工具，是目前最主流的一种，原理是扫描记录版本控制的信息来做到依赖管理。

• godep 建议在 golang 1.6 以后使用
• godep 依赖 vendor 具体查看 https://stackoverflow.com/questions/37237036/how-should-i-use-vendor-in-go-1-6
• 请做好 vendor 管理

安装

git地址https://github.com/tools/godep

go get -u -v github.com/tools/godep
成功安装后，在$GOPATH的bin目录下会有一个godep可执行的二进制文件，后面执行的命令都是用这个，建议这个目录加入到全局环境变量中

使用 godep进行包管理

以下命令都是在工程的根目录运行

拉取依赖用于开发restore

命令：godep restore
建议开发过程使用这个命令来同步依赖库。

如果下载的项目中只有Godeps.json文件，而没有包含第三库则可以使用godep restore这个命令将所有的依赖库下载到$GOPATH\src中 用于开发。

godep restore执行时，godep会按照Godeps/Godeps.json内的列表，依次执行go get -d -v来下载对应依赖包到GOPATH路径下。

⚠️注意：如果某个原先的依赖包保存路径（GOPATH下的相对路径）与下载url路径不一致，比如kuberbetes在github上路径是github.com/kubernetes，而代码内import则是my.io，则会导致无法下载成功，也就是说godep restore不成功。这种情况只能手动，比如手动创建$GOPATH/my.io目录，然后git clone

检出依赖 save

命令：godep save
godep save命令执行后，背后运行流程如下：

• 自动扫描当前目录所属包中import的所有外部依赖库（非系统库）
• 将所有的依赖库下载下来放到当前工程中，产生文件 Godeps\Godeps.json 文件
• 在没有 Godeps\ 文件夹的情况下，生成模组依赖目录vendor\文件夹

⚠️注意：如果开发使用了第三方库，需要固定使用某个版本，请完全提交Godeps\和vendor\文件夹。低版本的 godep 生成的是Godeps/_workspace，建议升级

godep save能否成功执行需要有两个要素：

• 当前或者需扫描的包均能够编译成功：因此所有依赖包事先都应该已经或go get或手工操作保存到当前GOPATH路径下；
• 依赖包必须使用了某个代码管理工具（如git，hg）：这是因为godep需要记录revision
  这个命令用于编译构建，三方构建工具需要额外配置构建参数。

编译运行 build

命令：godep go build XXX

项目用godep管理后，如果要编译和运行项目，这时候再使用go run和go build显然就不行。因为go命令是直接到GOPATH目录下去找第三方库，且在1.6以后支持vendor方式编译，而使用godep下载的依赖库放到Godeps/workspace目录下，但是不影响继续使用依赖GOPATH目录，所以与三方工具本身不冲突，故可以使用godep go build XXX进行编译。

godep中的go命令，就是将原先的go命令加了一层壳，执行godep go的时候，会将当前项目的workspace目录加入GOPATH变量中。

Godeps目录的作用

godep save时，godep把所有依赖包代码从GOPATH路径拷贝到Godeps目录下，并去除代码管理目录。这个用处主要是为了支撑godep go tool的一系列操作，尤其是git clone了代码库下来后，通常直接用godep go install xxx即可完成编译，一定程度上能够缓解golang比较严格的代码路径和包管理带来的烦恼。

而在使用IDE时，可以通过把vendor添加到GOPATH中，实现代码跳转和编译等功能。

godep其他命令

save 列出并复制依赖到Godeps目录中
go 使用保存的依赖版本运行go工具
get 下载并安装指定的依赖包
path 为依赖的代码打印GOPATH
restore check out listed dependency versions in GOPATH
update update selected packages or the go version
diff shows the diff between current and previously saved set of dependencies
version show version info

dep与godep傻傻分不清楚

目前依赖工具有很多，如：glide、godep等。dep是官方出品的，注意它和godep不是一个东西。
github地址不同
godep :https://github.com/tools/godep
dep:https://github.com/golang/dep
按照Peter Bourgon博文来说，它们的作者都有相同的人，但dep是官方版本，godep是第三方工具。
选择dep有什么好处呢？
1、官方出的，不用担心更新维护问题。
2、相对来说，比其他第三方工具兼容问题要好。

这里着重说一下dep init和dep ensure两个命令

dep init

扫描目录获取dependency在同一级目录下生成两个文件
Gopkg.lock包含先用的所有dependcy的package及其版本，每次dep ensure会自动刷新。
格式大概是这样的：

`[[projects]]
branch = “master”
name = “golang.org/x/sys”
packages = [
“windows”,
“windows/svc”
]
revision = “661970f62f5897bc0cd5fdca7e087ba8a98a8fa1”

[solve-meta]
analyzer-name = “dep”
analyzer-version = 1
inputs-digest = “d47ae3c107eee6969aec751badb5b6e788202f5351f8a9dd83ef9059804d5882”
solver-name = “gps-cdcl”
solver-version = 1

Gopkg.toml包含所有的dependency信息，包括name，revision，source等参数，可以指定特定的版本，可以手动修改 。
格式大概是这样的:
[[constraint]]
name = “github.com/BurntSushi/toml”
revision = “2dff11163ee667d51dcc066660925a92ce138deb”`

vendor里面包含了dependency的包，可直接从自己的vendor里去拿。

dep ensure

根据Gopkg.toml去拉下所有的dependency存放在vendor里，并更新或产生Gopkg.lock文件

推荐Glide

我们发现Glide是非常好的包管理解决方案，他将依赖包平展开存放在顶级vendor目录中，如果一个包被另一个程序引用了，那么这个包最好不要存储外部依赖项。如果使用Glide，你可以在glide.yml文件中指定依赖包，Glide会帮你管理，并使用正确的版本。

参考

golang使用vendor目录来管理依赖包https://studygolang.com/articles/10312
Golang vendor文件夹使用https://leileiluoluo.com/posts/golang-vendoring.html
Golang包管理工具之govendor的使用https://www.cnblogs.com/liuzhongchao/p/9233177.html
golang 包依赖管理 godep 使用https://www.jianshu.com/p/db59b10c8c51
go之官方依赖管理工具dep安装和使用https://blog.csdn.net/guyan0319/article/details/81588316