在go1.11版本以后go modules成為了go官方的依賴管理方式,替換一起的Godep。使用go modules管理依賴后會在當(dāng)前的項目根目錄下生成go.mod和go.sum.
-
go.mod
在其中記錄當(dāng)前的項目的所有依賴,文件格式如下:
module go-demos go 1.13 require github.com/x-mod/routine v1.2.7
或
module go-demos go 1.13 require ( github.com/x-mod/routine v1.2.7 ) replace ( // 針對有些被墻不能下載 可以替換成其他依賴包 golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0 )
-
go.sum
在其中記錄每個依賴庫的版本和哈希值,文件格式如下:
cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
一.啟用go modules
1.1 要求
(1)go版本 >= 1.11 (1.11才添加的)
(2)設(shè)置GO111MODULE環(huán)境變量設(shè)置:
? GO111MODULE用來開啟go module。其有三個值:off/on/auto; off關(guān)閉go module,on開啟go moudle,而auto則會根據(jù)當(dāng)前工程project目錄下是否有g(shù)o.mod文件來判斷是否使用modules功能。需要指出的無論go module處于哪種模式下,module功能都不會在GOPATH指定目錄下查找依賴文件,故而盡量設(shè)置代理GOPROXY變量來保證使用go module能夠確保依賴下載到。
? 還有一點需要指出的,使用go module時,盡量手動設(shè)置GO111MODULE全局環(huán)境變量值為off,主要是為了兼容以前未使用go module項目引入go module。
echo export GO111MODULE=off >> ~/.bash_profile
或
直接在文件中手動設(shè)定
go mod命令:詳情見go modules
download 下載依賴的module到本地cache
edit 編輯go.mod文件
graph 打印模塊依賴圖
init 在當(dāng)前文件夾下初始化一個新的module, 創(chuàng)建go.mod文件
tidy 增加丟失的module,去掉未使用的module
vendor 將依賴復(fù)制到vendor下
verify 校驗依賴
why 解釋為什么需要依賴
二. 使用module
2.1 新建項目
$ export GO111MODULE=on
$ go mod init project目錄(TestPro/github.com/XXX/TestPro)
......
$ go build //此時會將當(dāng)前項目引用的依賴包括其依賴的依賴也會添加到go.mod中
2.2 已存在項目
$ export GO111MODULE=on
$ go mod init // 在當(dāng)前project根目錄下創(chuàng)建一個空的go.mod
$ go get 依賴 // 將當(dāng)前項目中使用的依賴添加到go.mod中
需注意一點:go.mod是需要提交到代碼倉庫中的,而go.sum文件并不需要。
三. 打包
需要對前面已增加go module打包進(jìn)行發(fā)布,此時要將當(dāng)前項目需要的依賴下載到本地vendor目錄。
### 指定打包生成的目標(biāo)平臺
export GO111MODULE="on" # 開啟go module
export GOPROXY="https://mirrors.aliyun.com/goproxy/"#指定GOPROXY下載對應(yīng)的依賴也可用replace替換
export CGO_ENABLED="0" # 使用cgo
export GOOS="linux" # 目標(biāo)平臺
export GOARCH=amd64 # 系統(tǒng)架構(gòu)
go mod vendor # 依賴下載到vendor目錄
go build # 構(gòu)建
或
go build -ldflags "-s -w" -a -installsuffix cgo -o audit-webhook .
至此基本的go module已完成。
還有一些需要注意點:go module默認(rèn)是不會在GOPATH下查找依賴文件的,其會在GOPATH/pkg/mod下,這樣其他的module就可以使用已緩存在本地的依賴。