Go语言依赖管理
一开始接触go的时候,接触的是比较原始的教程,发现go是把所有的第三方库都放在GOPATH这个目录下面。这种方法显然很不雅,而且同一个库只能保存一个版本的代码。
后来发现了module,以及godep,目前,Go语言的依赖管理还在随着版本的更迭正逐渐完善。
godep
Go语言从v1.5开始开始引入vendor模式,如果项目目录下有vendor目录,那么go工具链会优先使用vendor内的包进行编译、测试等。
godep是一个通过vender模式实现的Go语言的第三方依赖管理工具,类似的还有由社区维护准官方包管理工具dep。
执行以下命令安装godep工具。
go get github.com/tools/godep
安装好godep之后,在终端输入godep查看支持的所有命令。
godep save 将依赖项输出并复制到Godeps.json文件中
godep go 使用保存的依赖项运行go工具
godep get 下载并安装具有指定依赖项的包
godep path 打印依赖的GOPATH路径
godep restore 在GOPATH中拉取依赖的版本
godep update 更新选定的包或go版本
godep diff 显示当前和以前保存的依赖项集之间的差异
godep version 查看版本信息
使用godep help [command]可以看看具体命令的帮助信息。
在项目目录下执行godep save命令,会在当前项目中创建Godeps和vender两个文件夹。
其中Godeps文件夹下有一个Godeps.json的文件,里面记录了项目所依赖的包信息。 vender文件夹下是项目依赖的包的源代码文件。
go module
go module是Go1.11版本之后官方推出的版本管理工具,并且从Go1.13版本开始,go module将是Go语言默认的依赖管理工具。
个人认为这是最舒服的方式,入手也比较简单。
GO111MODULE
首先要在环境变量GO111MODULE改成可用。
GOPROXY
相当于搜索第三方库可选的根路径,可用用国内代理来加速。
go mod命令
常用的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用来定义包名
- 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命令。
整理依赖
在修改代码的时候可能有一些依赖弃用了,需要重新整理依赖。
可以使用go mod tidy命令更新go.mod中的依赖关系。
go mod edit
就是修改go.mod,可以在go help mod edit查看用法。
如何使用
- 既有项目
如果需要对一个已经存在的项目启用go module,可以按照以下步骤操作:
- 在项目目录下执行go mod init,生成一个go.mod文件。
- 执行go get,查找并记录当前项目的依赖,同时生成一个go.sum记录每个依赖库的版本和哈希值。
- 新项目
对于一个新创建的项目,我们可以在项目文件夹下按照以下步骤操作:
- 执行go mod init 项目名命令,在当前项目文件夹下创建一个go.mod文件。
- 手动编辑go.mod中的require依赖项或执行go get自动发现、维护依赖。