Go 包管理工具 govendor 使用指南

yongxinz發表於2019-01-11

專欄地址:技術文章專欄

govendor 是 go 語言依賴管理工具。

安裝及初始化

安裝:

go get -u -v github.com/kardianos/govendor複製程式碼

初始化:

# Setup your project.cd "my project in GOPATH"govendor init# Add existing GOPATH files to vendor.govendor add +external複製程式碼

下載依賴包

下面介紹三個命令:

  • govendor fetch:不但可以下載自身的包,還可以下載依賴。
  • govendor get:如官網所述 Like “go get” but copies dependencies into a “vendor” folder,實際上只複製了依賴包進到 vendor 目錄而已。
  • govendor add:Add packages from $GOPATH,意思是從本地載入依賴包。

綜上,如果是下載依賴包,一定是用 govendor fetch

govendor fetch github.com/gin-gonic/gin@v1.2 # 只拷貝 gin/ 目錄的內容,而不包含其子目錄govendor fetch github.com/gin-gonic/gin/...@v1.2 # 可以得到 gin/ 目錄,及其所有子目錄複製程式碼

@v1.2 表示使用 v1.2 版本,其實就是 git tag 為 v1.2 的 revision,這個功能很實用。

再說一個可能會碰到的問題,有時候我們使用第三方依賴包,而且還有 bug,修復之後,期望使用自己倉庫的時候,可以這樣做:

govendor get 'github.com/go-sql-driver/mysql::github.com/yongxinz/go-mysql'複製程式碼

原倉庫的 github.com/go-sql-driver/mysql 存在一個小問題,此時期望使用自己修復過的 github.com/yongxinz/go-mysql

版本管理

不要將整個 vendor/ 目錄的內容都提到 git 倉庫,只提交 vendor/vendor.json 檔案就可以了。

當我們拉程式碼之後,需要安裝依賴包時,只需要執行下面這條命令就可以了。

govendor sync複製程式碼

.gitignore 檔案,重點在最後兩行:

# Created by https://www.gitignore.io/api/go### Go #### Binaries for programs and plugins*.exe*.exe~*.dll*.so*.dylib# Test binary, build with `go test -c`*.test# Output of the go coverage tool, specifically when used with LiteIDE*.out### Go Patch ###/vendor/!/vendor/vendor.json複製程式碼

所以,一般的開發流程可以這樣來做:如果是新建專案,先安裝 govendor 並初始化,然後通過 govendor 來安裝依賴包;如果是已有專案,先從版本庫拉下來,然後安裝 govendor,再執行同步命令即可。

其他命令

govendor status: 檢視當前包狀態

govendor list +e: 檢視當前專案的依賴但是未被新增到 vendor 中的包

govendor add +e: 新增依賴的包。如果 vendor.json 中存在,但是 vendor 目錄下不存在(即 govendor status 顯示缺失)的包也會被重新新增

govendor remove +u: 刪除在 vendor 下但是未依賴的包

在實際過程中,有部分包是團隊的公共包。 這部分包通常有自己的單獨專案,並且已經被我們新增到 $GOPATH 下,可能就不需要新增到當前專案的 vendor 下。

這時候可以結合 listadd 來使用, 先用 list -no-status +e 列出依賴包,然後使用 grep 過濾,再呼叫 add 命令新增:

govendor list -no-status +e | grep -v 'myteam/common' | xargs govendor add複製程式碼

相關文件:
github.com/kardianos/g…
www.orztu.com/post/using-…
linkscue.com/2018/08/09/…

來源:https://juejin.im/post/5c38b83f6fb9a049d9756da3#comment

相關文章