go module
是Go1.11版本之后官方推出的版本管理工具,并且從Go1.13版本開(kāi)始,go module
將是Go語(yǔ)言默認(rèn)的依賴管理工具超棺。
GO111MODULE
要啟用go module
支持首先要設(shè)置環(huán)境變量GO111MODULE
,通過(guò)它可以開(kāi)啟或關(guān)閉模塊支持捌袜,它有三個(gè)可選值:off
说搅、on
、auto
虏等,默認(rèn)值是auto
弄唧。
-
GO111MODULE=off
禁用模塊支持适肠,編譯時(shí)會(huì)從GOPATH
和vendor
文件夾中查找包。 -
GO111MODULE=on
啟用模塊支持候引,編譯時(shí)會(huì)忽略GOPATH
和vendor
文件夾侯养,只根據(jù)go.mod
下載依賴。 -
GO111MODULE=auto
澄干,當(dāng)項(xiàng)目在$GOPATH/src
外且項(xiàng)目根目錄有go.mod
文件時(shí)逛揩,開(kāi)啟模塊支持。
簡(jiǎn)單來(lái)說(shuō)麸俘,設(shè)置GO111MODULE=on
之后就可以使用go module
了辩稽,以后就沒(méi)有必要在GOPATH中創(chuàng)建項(xiàng)目了,并且還能夠很好的管理項(xiàng)目依賴的第三方包信息从媚。
使用 go module 管理依賴后會(huì)在項(xiàng)目根目錄下生成兩個(gè)文件go.mod
和go.sum
逞泄。
GOPROXY
Go1.11之后設(shè)置GOPROXY命令為:
export GOPROXY=https://goproxy.cn
Go1.13之后GOPROXY
默認(rèn)值為https://proxy.golang.org
,在國(guó)內(nèi)是無(wú)法訪問(wèn)的拜效,所以十分建議大家設(shè)置GOPROXY喷众,這里我推薦使用goproxy.cn。
go env -w GOPROXY=https://goproxy.cn,direct
go mod命令
常用的go mod
命令如下:
go mod download 下載依賴的module到本地cache(默認(rèn)為$GOPATH/pkg/mod目錄)
go mod edit 編輯go.mod文件
go mod graph 打印模塊依賴圖
go mod init 初始化當(dāng)前文件夾, 創(chuàng)建go.mod文件
go mod tidy 增加缺少的module紧憾,刪除無(wú)用的module
go mod vendor 將依賴復(fù)制到vendor下
go mod verify 校驗(yàn)依賴
go mod why 解釋為什么需要依賴
go.mod
go.mod文件記錄了項(xiàng)目所有的依賴信息到千,其結(jié)構(gòu)大致如下:
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
用來(lái)定義包名 -
require
用來(lái)定義依賴包及版本 -
indirect
表示間接引用
依賴的版本
go mod支持語(yǔ)義化版本號(hào)赴穗,比如go get foo@v1.2.3
憔四,也可以跟git的分支或tag,比如go get foo@master
望抽,當(dāng)然也可以跟git提交哈希加矛,比如go get foo@e3702bed2
。關(guān)于依賴的版本支持以下幾種格式:
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
在國(guó)內(nèi)訪問(wèn)golang.org/x的各個(gè)包都需要翻墻煤篙,你可以在go.mod中使用replace替換成github上對(duì)應(yīng)的庫(kù)斟览。
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
在項(xiàng)目中執(zhí)行go get
命令可以下載依賴包,并且還可以指定下載的版本辑奈。
- 運(yùn)行
go get -u
將會(huì)升級(jí)到最新的次要版本或者修訂版本(x.y.z, z是修訂版本號(hào)苛茂, y是次要版本號(hào)) - 運(yùn)行
go get -u=patch
將會(huì)升級(jí)到最新的修訂版本 - 運(yùn)行
go get package@version
將會(huì)升級(jí)到指定的版本號(hào)version
如果下載所有依賴可以使用go mod download
命令。
整理依賴
我們?cè)诖a中刪除依賴代碼后鸠窗,相關(guān)的依賴庫(kù)并不會(huì)在go.mod
文件中自動(dòng)移除妓羊。這種情況下我們可以使用go mod tidy
命令更新go.mod
中的依賴關(guān)系。
go mod edit
格式化
因?yàn)槲覀兛梢允謩?dòng)修改go.mod文件稍计,所以有些時(shí)候需要格式化該文件躁绸。Go提供了一下命令:
go mod edit -fmt
添加依賴項(xiàng)
go mod edit -require=golang.org/x/text
移除依賴項(xiàng)
如果只是想修改go.mod
文件中的內(nèi)容,那么可以運(yùn)行go mod edit -droprequire=package path
,比如要在go.mod
中移除golang.org/x/text
包净刮,可以使用如下命令:
go mod edit -droprequire=golang.org/x/text
關(guān)于go mod edit
的更多用法可以通過(guò)go help mod edit
查看剥哑。
在項(xiàng)目中使用go module
既有項(xiàng)目
如果需要對(duì)一個(gè)已經(jīng)存在的項(xiàng)目啟用go module
,可以按照以下步驟操作:
- 在項(xiàng)目目錄下執(zhí)行
go mod init
淹父,生成一個(gè)go.mod
文件株婴。 - 執(zhí)行
go get
,查找并記錄當(dāng)前項(xiàng)目的依賴暑认,同時(shí)生成一個(gè)go.sum
記錄每個(gè)依賴庫(kù)的版本和哈希值困介。
新項(xiàng)目
對(duì)于一個(gè)新創(chuàng)建的項(xiàng)目,我們可以在項(xiàng)目文件夾下按照以下步驟操作:
- 執(zhí)行
go mod init 項(xiàng)目名
命令蘸际,在當(dāng)前項(xiàng)目文件夾下創(chuàng)建一個(gè)go.mod
文件座哩。 - 手動(dòng)編輯
go.mod
中的require依賴項(xiàng)或執(zhí)行go get
自動(dòng)發(fā)現(xiàn)、維護(hù)依賴粮彤。