Go語言的依賴管理隨著版本的更迭正逐漸完善起來邪锌。
windows開啟go module:set GO111MODULE=on
Linux開啟go module:export GO111MODULE=on
set GO111MODULE=on
set GOPROXY=https://mirrors.aliyun.com/goproxy
visual studio code配置go
主要是vscode加載gotools由于墻的原因韭邓。出現(xiàn)failed的情況
輸入 go env查看GO111MODULE=""
GOPROXY=“https://proxy.golang.org,direct”
我們需要改一下配置
go env -w GO111MODULE=on
go env
-w GOPROXY=GOPROXY=“https://proxy.golang.org,direct”
保存重啟就可以正常加載了
依賴管理
為什么需要依賴管理
最早的時候稻励,Go所依賴的所有的第三方庫都放在GOPATH這個目錄下面沉填。這就導(dǎo)致了同一個庫只能保存一個版本的代碼超埋。如果不同的項(xiàng)目依賴同一個第三方的庫的不同版本续膳,應(yīng)該怎么解決题山?
godep
Go語言從v1.5開始開始引入vendor
模式坯临,如果項(xiàng)目目錄下有vendor目錄焊唬,那么go工具鏈會優(yōu)先使用vendor
內(nèi)的包進(jìn)行編譯恋昼、測試等。
godep
是一個通過vender模式實(shí)現(xiàn)的Go語言的第三方依賴管理工具赶促,類似的還有由社區(qū)維護(hù)準(zhǔn)官方包管理工具dep
液肌。
安裝
執(zhí)行以下命令安裝godep
工具。
go get github.com/tools/godep
基本命令
安裝好godep之后芳杏,在終端輸入godep
查看支持的所有命令矩屁。
godep save 將依賴項(xiàng)輸出并復(fù)制到Godeps.json文件中
godep go 使用保存的依賴項(xiàng)運(yùn)行g(shù)o工具
godep get 下載并安裝具有指定依賴項(xiàng)的包
godep path 打印依賴的GOPATH路徑
godep restore 在GOPATH中拉取依賴的版本
godep update 更新選定的包或go版本
godep diff 顯示當(dāng)前和以前保存的依賴項(xiàng)集之間的差異
godep version 查看版本信息
使用godep help [command]
可以看看具體命令的幫助信息。
使用godep
在項(xiàng)目目錄下執(zhí)行godep save
命令爵赵,會在當(dāng)前項(xiàng)目中創(chuàng)建Godeps
和vender
兩個文件夾吝秕。
其中Godeps
文件夾下有一個Godeps.json
的文件,里面記錄了項(xiàng)目所依賴的包信息空幻。 vender
文件夾下是項(xiàng)目依賴的包的源代碼文件烁峭。
vender機(jī)制
Go1.5版本之后開始支持,能夠控制Go語言程序編譯時依賴包搜索路徑的優(yōu)先級秕铛。
例如查找項(xiàng)目的某個依賴包约郁,首先會在項(xiàng)目根目錄下的vender
文件夾中查找,如果沒有找到就會去$GOAPTH/src
目錄下查找但两。
godep開發(fā)流程
- 保證程序能夠正常編譯
- 執(zhí)行
godep save
保存當(dāng)前項(xiàng)目的所有第三方依賴的版本信息和代碼 - 提交Godeps目錄和vender目錄到代碼庫鬓梅。
- 如果要更新依賴的版本,可以直接修改
Godeps.json
文件中的對應(yīng)項(xiàng)
go module
go module
是Go1.11版本之后官方推出的版本管理工具谨湘,并且從Go1.13版本開始绽快,go module
將是Go語言默認(rèn)的依賴管理工具。
GO111MODULE
要啟用go module
支持首先要設(shè)置環(huán)境變量GO111MODULE
紧阔,通過它可以開啟或關(guān)閉模塊支持坊罢,它有三個可選值:off
、on
擅耽、auto
活孩,默認(rèn)值是auto
。
-
GO111MODULE=off
禁用模塊支持乖仇,編譯時會從GOPATH
和vendor
文件夾中查找包憾儒。 -
GO111MODULE=on
啟用模塊支持,編譯時會忽略GOPATH
和vendor
文件夾乃沙,只根據(jù)go.mod
下載依賴航夺。 -
GO111MODULE=auto
,當(dāng)項(xiàng)目在$GOPATH/src
外且項(xiàng)目根目錄有go.mod
文件時崔涂,開啟模塊支持阳掐。
簡單來說,設(shè)置GO111MODULE=on
之后就可以使用go module
了,以后就沒有必要在GOPATH中創(chuàng)建項(xiàng)目了缭保,并且還能夠很好的管理項(xiàng)目依賴的第三方包信息汛闸。
使用 go module 管理依賴后會在項(xiàng)目根目錄下生成兩個文件go.mod
和go.sum
。
GOPROXY
Go1.11之后設(shè)置GOPROXY命令為:
export GOPROXY=https://goproxy.cn
Go1.13之后GOPROXY
默認(rèn)值為https://proxy.golang.org
艺骂,在國內(nèi)是無法訪問的诸老,所以十分建議大家設(shè)置GOPROXY,這里我推薦使用goproxy.cn钳恕。
go env -w GOPROXY=https://goproxy.cn,direct
//也可更換為國內(nèi)源别伏。
go env -w GOPROXY=https://mirrors.aliyun.com/goproxy
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,刪除無用的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
用來定義包名 -
require
用來定義依賴包及版本 -
indirect
表示間接引用
依賴的版本
go mod支持語義化版本號,比如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
在國內(nèi)訪問golang.org/x的各個包都需要翻墻,你可以在go.mod中使用replace替換成github上對應(yīng)的庫示启。
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
將會升級到最新的次要版本或者修訂版本(x.y.z, z是修訂版本號夫嗓, y是次要版本號) - 運(yùn)行
go get -u=patch
將會升級到最新的修訂版本 - 運(yùn)行
go get package@version
將會升級到指定的版本號version
如果下載所有依賴可以使用go mod download
命令厦瓢。
整理依賴
我們在代碼中刪除依賴代碼后,相關(guān)的依賴庫并不會在go.mod
文件中自動移除啤月。這種情況下我們可以使用go mod tidy
命令更新go.mod
中的依賴關(guān)系。
go mod edit
格式化
因?yàn)槲覀兛梢允謩有薷膅o.mod文件劳跃,所以有些時候需要格式化該文件谎仲。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
的更多用法可以通過go help mod edit
查看。
在項(xiàng)目中使用go module
既有項(xiàng)目
如果需要對一個已經(jīng)存在的項(xiàng)目啟用go module
杉武,可以按照以下步驟操作:
- 在項(xiàng)目目錄下執(zhí)行
go mod init
辙诞,生成一個go.mod
文件。 - 執(zhí)行
go get
轻抱,查找并記錄當(dāng)前項(xiàng)目的依賴飞涂,同時生成一個go.sum
記錄每個依賴庫的版本和哈希值。
新項(xiàng)目
對于一個新創(chuàng)建的項(xiàng)目,我們可以在項(xiàng)目文件夾下按照以下步驟操作:
- 執(zhí)行
go mod init 項(xiàng)目名
命令较店,在當(dāng)前項(xiàng)目文件夾下創(chuàng)建一個go.mod
文件士八。 - 手動編輯
go.mod
中的require依賴項(xiàng)或執(zhí)行go get
自動發(fā)現(xiàn)、維護(hù)依賴梁呈。
go module常用命令
go mod init [包名] //初始化姓名
go mod tidy //檢查代碼里的依賴去更新go.mod文件中的依賴
go get
go mod download
context
context.Background()
context.TODO()
//四個方法
context.WithCancel(context.Background())
context.WithDeadline(context.Background().time.Time)
context.WithTimeout(context.Background(),time.Duration)
context.WithValue(context.Background(),key,value)
雖然gomodule脫離了gopath在任意地方編寫go代碼婚度,但是在go mod init 時,必須加模塊名稱官卡,否則報錯非gopath下蝗茁,可見,gopath下可以不用加模塊名稱寻咒,會有默認(rèn)名稱哮翘,非gopath則不行。