[TOC]
介紹
godep是解決包依賴的管理工具,目前最主流的一種虚吟,原理是掃描記錄版本控制的信息寸认,并在go命令前加殼來做到依賴管理
godep 建議在 golang 1.6 以后使用
godep 依賴 vendor 具體查看 https://stackoverflow.com/questions/37237036/how-should-i-use-vendor-in-go-1-6
請做好 vendor 管理
安裝
https://github.com/tools/godep
go get -u -v github.com/tools/godep
成功安裝后,在$GOPATH的bin目錄
下會(huì)有一個(gè)godep可執(zhí)行的二進(jìn)制文件串慰,后面執(zhí)行的命令都是用這個(gè)偏塞,建議這個(gè)目錄加入到全局環(huán)境變量中
包管理使用 godep
以下命令都是在工程的根目錄運(yùn)行
拉取依賴 restore 用于開發(fā)
godep restore
建議開發(fā)過程使用這個(gè)命令來同步依賴庫
如果下載的項(xiàng)目中只有Godeps.json文件,而沒有包含第三庫則可以使用godep restore這個(gè)命令將所有的依賴庫下來到$GOPATH\src
中 用于開發(fā)
godep restore執(zhí)行時(shí)邦鲫,godep會(huì)按照Godeps/Godeps.json
內(nèi)列表灸叼,依次執(zhí)行go get -d -v
來下載對應(yīng)依賴包到GOPATH路徑下
如果某個(gè)原先的依賴包保存路徑(GOPATH下的相對路徑)與下載url路徑不一致,比如kuberbetes在github上路徑是github.com/kubernetes庆捺,而代碼內(nèi)import則是my.io古今,則會(huì)導(dǎo)致無法下載成功,也就是說godep restore不成功滔以。這種只能手動(dòng)沧卢,比如手動(dòng)創(chuàng)建$GOPATH/my.io目錄,然后git clone
檢出依賴 save
godep save
自動(dòng)掃描當(dāng)前目錄所屬包中import的所有外部依賴庫(非系統(tǒng)庫)
將所有的依賴庫下來下來到當(dāng)前工程中醉者,產(chǎn)生文件
Godeps\Godeps.json
文件在沒有
Godeps\
文件的情況下但狭,生成模組依賴目錄vendor\
文件夾
如果是開發(fā)依賴使用三方庫,需要固定使用某個(gè)版本撬即,請完全提交
Godeps\
和vendor\
文件夾
低版本的 godep 生成的是
Godeps/_workspace
立磁,建議升級
godep save能否成功執(zhí)行需要有兩個(gè)要素:
- 當(dāng)前或者需掃描的包均能夠編譯成功:因此所有依賴包事先都應(yīng)該已經(jīng)或go get或手工操作保存當(dāng)前GOPATH路徑下
- 依賴包必須使用了某個(gè)代碼管理工具(如git,hg):這是因?yàn)間odep需要記錄revision
這個(gè)命令用于編譯構(gòu)建的剥槐,三方構(gòu)建工具需要額外配置構(gòu)建參數(shù)
godep 編譯運(yùn)行 build
項(xiàng)目用godep管理后唱歧,要編譯和運(yùn)行項(xiàng)目的時(shí)候再用go run和go build顯然就不行
因?yàn)間o命令是直接到GOPATH目錄下去找第三方庫,且在1.6以后支持
vendor
方式編譯粒竖,而使用godep下載的依賴庫放到Godeps/workspace目錄下的颅崩,但是不影響繼續(xù)使用依賴GOPATH目錄,所以與三方工具本身不沖突
故使用
godep go build XXX
godep中的go命令蕊苗,就是將原先的go命令加了一層殼沿后,執(zhí)行g(shù)odep go的時(shí)候,會(huì)將當(dāng)前項(xiàng)目的workspace目錄加入GOPATH變量中
Godeps目錄的作用
godep save時(shí)godep把所有依賴包代碼從GOPATH路徑拷貝到Godeps目錄下朽砰,并去除代碼管理目錄尖滚。這個(gè)用處主要是為了支撐godep go tool的一系列操作,尤其是git clone了代碼庫下來后瞧柔,通常直接用godep go install xxx即可完成編譯漆弄,一定程度上能夠緩解golang比較嚴(yán)格的代碼路徑和包管理帶來的煩惱。
而在使用IDE時(shí)
造锅,可以通過把vendor
添加到GOPATH實(shí)現(xiàn)代碼跳轉(zhuǎn)和編譯等功能撼唾,比較方便
godep其他命令
save list and copy dependencies into Godeps
go run the go tool with saved dependencies
get download and install packages with specified dependencies
path print GOPATH for dependency code
restore check out listed dependency versions in GOPATH
update update selected packages or the go version
diff shows the diff between current and previously saved set of dependencies
version show version info