Go語言的依賴管理隨著版本的更迭正逐漸完善起來,
依賴管理
為什么需要依賴管理
最早的時候,Go所依賴的所有的第三方庫都放在GOPATH這個目錄下面,這就導致了同一個庫只能保存一個版本的代碼,如果不同的專案依賴同一個第三方的庫的不同版本,應該怎么解決?
godep
Go語言從v1.5開始開始引入vendor模式,如果專案目錄下有vendor目錄,那么go工具鏈會優先使用vendor內的包進行編譯、測驗等,
godep是一個通過vender模式實作的Go語言的第三方依賴管理工具,類似的還有由社區維護準官方包管理工具dep,
安裝
執行以下命令安裝godep工具,
go get github.com/tools/godep
基本命令
安裝好godep之后,在終端輸入godep查看支持的所有命令,
godep save 將依賴項輸出并復制到Godeps.json檔案中 godep go 使用保存的依賴項運行go工具 godep get 下載并安裝具有指定依賴項的包 godep path 列印依賴的GOPATH路徑 godep restore 在GOPATH中拉取依賴的版本 godep update 更新選定的包或go版本 godep diff 顯示當前和以前保存的依賴項集之間的差異 godep version 查看版本資訊
使用godep help [command]可以看看具體命令的幫助資訊,
使用godep
在專案目錄下執行godep save命令,會在當前專案中創建Godeps和vender兩個檔案夾,
其中Godeps檔案夾下有一個Godeps.json的檔案,里面記錄了專案所依賴的包資訊, vender檔案夾下是專案依賴的包的源代碼檔案,
vender機制
Go1.5版本之后開始支持,能夠控制Go語言程式編譯時依賴包搜索路徑的優先級,
例如查找專案的某個依賴包,首先會在專案根目錄下的vender檔案夾中查找,如果沒有找到就會去$GOAPTH/src目錄下查找,
godep開發流程
- 保證程式能夠正常編譯
- 執行
godep save保存當前專案的所有第三方依賴的版本資訊和代碼 - 提交Godeps目錄和vender目錄到代碼庫,
- 如果要更新依賴的版本,可以直接修改
Godeps.json檔案中的對應項
go module
go module是Go1.11版本之后官方推出的版本管理工具,并且從Go1.13版本開始,go module將是Go語言默認的依賴管理工具,
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 管理依賴后會在專案根目錄下生成兩個檔案go.mod和go.sum,
GOPROXY
Go1.11之后設定GOPROXY命令為:
export GOPROXY=https://goproxy.cn
Go1.13之后GOPROXY默認值為https://proxy.golang.org,在國內是無法訪問的,所以十分建議大家設定GOPROXY,這里我推薦使用goproxy.cn,
go env -w GOPROXY=https://goproxy.cn,direct
go mod命令
常用的go mod命令如下:
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檔案記錄了專案所有的依賴資訊,其結構大致如下:
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 [email protected],也可以跟git的分支或tag,比如go get foo@master,當然也可以跟git提交哈希,比如go get foo@e3702bed2,關于依賴的版本支持以下幾種格式:
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上對應的庫,
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命令可以下載依賴包,并且還可以指定下載的版本,
- 運行
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 edit -fmt
添加依賴項
go mod edit -require=golang.org/x/text
移除依賴項
如果只是想修改go.mod檔案中的內容,那么可以運行go mod edit -droprequire=package path,比如要在go.mod中移除golang.org/x/text包,可以使用如下命令:
go mod edit -droprequire=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自動發現、維護依賴,
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/45074.html
標籤:Go
下一篇:解決go get下載包失敗問題
