Go的依赖管理

早期go依赖管理很混乱,自己的包和第三方的都是放在%GOPATH/src中,无法导入不同版本的一个包,因此后面推出了go module

GO111MODULE

要启用 go module支持首先要设置环境变量 GO111MODULE,通过它可以开启或关闭模块支持,它有三个可选值:offonauto,默认值是 auto

  1. GO111MODULE=off禁用模块支持,编译时会从 GOPATHvendor文件夹中查找包。
  2. GO111MODULE=on启用模块支持,编译时会忽略 GOPATHvendor文件夹,只根据 go.mod下载依赖。
  3. GO111MODULE=auto,当项目在 $GOPATH/src外且项目根目录有 go.mod文件时,开启模块支持。

简单来说,设置 GO111MODULE=on之后就可以使用 go module了,以后就没有必要在GOPATH中创建项目了,并且还能够很好的管理项目依赖的第三方包信息。(如果要使用go module就不能将项目放到GOPATH中,会导致包混乱)

使用 go module 管理依赖后会在项目根目录下生成两个文件 go.modgo.sum

GOPROXY

Go1.11之后设置GOPROXY命令为:

1
export GOPROXY=https://goproxy.cn

Go1.13之后 GOPROXY默认值为 https://proxy.golang.org,在国内是无法访问的,所以设置GOPROXY为goproxy.cn。(中转)

1
go env -w GOPROXY=https://goproxy.cn,direct

go mod命令

常用的 go mod命令如下:

1
2
3
4
5
6
7
8
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文件记录了项目所有的依赖信息,其结构大致如下:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
module github.com/Q1mi/studygo/blogger

go 1.12

require (
	github.com/DeanThompson/ginpprof v0.0.0-20190408063150-3be636683586
	github.com/gin-gonic/gin v1.4.0
	github.com/go-sql-driver/mysql v1.4.1
	github.com/jmoiron/sqlx v1.2.0
	github.com/satori/go.uuid v1.2.0
	google.golang.org/appengine v1.6.1 // indirect
)

其中,

  • module用来定义包名
  • require用来定义依赖包及版本
  • indirect表示间接引用(自己的包没使用,但是引用的包又引用了这个包就是间接引用)

依赖的版本

go mod支持语义化版本号,比如 go get foo@v1.2.3,也可以跟git的分支或tag,比如 go get foo@master,当然也可以跟git提交哈希,比如 go get foo@e3702bed2。关于依赖的版本支持以下几种格式:

1
2
3
4
5
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
gopkg.in/vmihailenco/msgpack.v2 v2.9.1
gopkg.in/yaml.v2 <=v2.2.1
github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e
latest

replace

在国内访问golang.org/x的各个包都需要翻墙,可以在go.mod中使用replace替换成github上对应的库。(go在github中有搭镜像,也可以直接导入github中相对应的包)

1
2
3
4
5
replace (
	golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac => github.com/golang/crypto v0.0.0-20180820150726-614d502a4dac
	golang.org/x/net v0.0.0-20180821023952-922f4815f713 => github.com/golang/net v0.0.0-20180826012351-8a410e7b638d
	golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
)

go get

在项目中执行 go get命令可以下载依赖包,并且还可以指定下载的版本。

  1. 运行 go get -u将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号, y是次要版本号)
  2. 运行 go get -u=patch将会升级到最新的修订版本
  3. 运行 go get package@version将会升级到指定的版本号version

如果下载所有依赖可以使用 go mod download命令。

整理依赖

我们在代码中删除依赖代码后,相关的依赖库并不会在 go.mod文件中自动移除。这种情况下我们可以使用 go mod tidy命令更新 go.mod中的依赖关系。

go mod edit

格式化

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

1
go mod edit -fmt

添加依赖项

1
go mod edit -require=golang.org/x/text

移除依赖项

如果只是想修改 go.mod文件中的内容,那么可以运行 go mod edit -droprequire=package path,比如要在 go.mod中移除 golang.org/x/text包,可以使用如下命令:

1
go mod edit -droprequire=golang.org/x/text

关于 go mod edit的更多用法可以通过 go help mod edit查看。

在项目中使用go module

既有项目

如果需要对一个已经存在的项目启用 go module,可以按照以下步骤操作:

  1. 在项目目录下执行 go mod init,生成一个 go.mod文件。
  2. 执行 go get,查找并记录当前项目的依赖,同时生成一个 go.sum记录每个依赖库的版本和哈希值。

新项目

对于一个新创建的项目,我们可以在项目文件夹下按照以下步骤操作:

  1. 执行 go mod init 项目名命令,在当前项目文件夹下创建一个 go.mod文件。
  2. 手动编辑 go.mod中的require依赖项或执go get自动发现、维护依赖。
Licensed under CC BY-NC-SA 4.0