早期go依赖管理很混乱,自己的包和第三方的都是放在%GOPATH/src中,无法导入不同版本的一个包,因此后面推出了go module
GO111MODULE
要启用 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就不能将项目放到GOPATH中,会导致包混乱)
使用 go module 管理依赖后会在项目根目录下生成两个文件 go.mod
和 go.sum
。
GOPROXY
Go1.11之后设置GOPROXY命令为:
|
|
Go1.13之后 GOPROXY
默认值为 https://proxy.golang.org
,在国内是无法访问的,所以设置GOPROXY为goproxy.cn。(中转)
|
|
go mod命令
常用的 go mod
命令如下:
|
|
go.mod
go.mod文件记录了项目所有的依赖信息,其结构大致如下:
|
|
其中,
module
用来定义包名require
用来定义依赖包及版本indirect
表示间接引用(自己的包没使用,但是引用的包又引用了这个包就是间接引用)
依赖的版本
go mod支持语义化版本号,比如 go get foo@v1.2.3
,也可以跟git的分支或tag,比如 go get foo@master
,当然也可以跟git提交哈希,比如 go get foo@e3702bed2
。关于依赖的版本支持以下几种格式:
|
|
replace
在国内访问golang.org/x的各个包都需要翻墙,可以在go.mod中使用replace替换成github上对应的库。(go在github中有搭镜像,也可以直接导入github中相对应的包)
|
|
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
文件中的内容,那么可以运行 go mod edit -droprequire=package path
,比如要在 go.mod
中移除 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
自动发现、维护依赖。