半夏的博客

liangbogopher's blog

使用 godep 管理 golang 的包依赖

介绍

godep是解决包依赖的管理工具,目前最主流的一种,原理是扫描记录版本控制的信息,并在go命令前加壳来做到依赖管理,建议在 golang 1.6 以后使用。

安装

go get -u -v github.com/tools/godep

成功安装后,在$GOPATH的bin目录下会有一个godep可执行的二进制文件,后面执行的命令都是用这个,建议这个目录加入到全局环境变量中

使用

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

检出依赖 save

godep save
  • 自动扫描当前目录所属包中import的所有外部依赖库(非系统库)

  • 将所有的依赖库下来下来到当前工程中,产生文件 Godeps\Godeps.json 文件

  • 在没有 Godeps\ 文件的情况下,生成模组依赖目录vendor\文件夹

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

  • 当前或者需扫描的包均能够编译成功:因此所有依赖包事先都应该已经或go get或手工操作保存当前GOPATH路径下

  • 依赖包必须使用了某个代码管理工具(如git,hg):这是因为godep需要记录revision

拉取依赖 restore 用于开发

godep restore

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

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

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

godep 命令

save     list and copy dependencies into Godeps
go       run the go tool with saved dependencies
get      download and install packages with specified dependencies
path     print GOPATH for dependency code
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

Top