Golang系列02丨Go的依赖管理

一.为什么需要依赖管理

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

二.go module

go module是Go1.11版本之后官方推出的版本管理工具,并且从Go1.13版本开始,go module将是Go语言默认的依赖管理工具。

三.如何使用go module

要启用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.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 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文件中自动移除。这种情况下我们可以使用go mod tidy命令更新go.mod中的依赖关系。

八.go mod edit使用

格式化

我们可以手动修改go.mod文件,所以有些时候需要格式化该文件。Go提供以下命令:

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自动发现、维护依赖。