govendor 好多依賴要管理

• 系列：下班加減學點Golang與Docker系列 第 11 篇
• Day：11
• 發佈時間：2019-09-18 00:01:28
• 原文：https://ithelp.ithome.com.tw/articles/10216807

回憶一下之前Day01提到的

Go WorkSpace 工作目錄

我們安裝好Go之後進去預設的GOPATH目錄下, 就會看到這樣的目錄結構.

- GOPATH
    |
    -- bin/
    |
    -- pkg/
    |
    -- src/
        |
        -- project1/
                |
                -- vendor/
        |
        -- project2/
                |
                -- vendor/

• bin 包含可安裝並執行的command (可執行的二進制文件)
• pkg 包含各種package objects (二進制的library檔, *.a檔)
• src 包含各專案的代碼

GOPATH

GOPATH是一個環境變數, 用絕對路徑來指定工作目錄的位置.
要是我們多人參與開發, 每個人都有一套自己的目錄結構, 讀取配置文件的位置也不統一, 這樣輸出的二進制文件也不會統一, 會導致開發的標準不一.

GOPATH存在的目的是

• 所有在Go代碼裡, 透過import 宣告的package path, 用來計算該包的路徑用.
• 儲存任何透過go get獲取的依賴包.
• go build、go install產生的二進制文件會放在$GOPATH/bin底下

go get

官方提供的工具, 會把go get取得的第三方套件代碼存放到$GOPATH/src中.

有許多社群做了幾個package management工具 Glide、dep、 govendor, 包含後面出的gomodule等, 都是為了方便專案去管理使用了哪些依賴包跟對應的版本, 以及下載位置.
小弟接觸比較晚, 就挑了govendor和gomodule來學習.
這兩個可以共存XD

vendor

在Go Module還沒出來時, 在1.5版提供了vendor. 但要手動環境變數GO15VENDOREXPERIMENT=1
1.6版則是默認是1
1.7版則是不必再設定該環境變數, 默認開啟vendor

vendor特性

在我們執行go build 或者是go run時, go會依照下列順序依序去找我們的要的依賴包

1. 當下專案目錄的vendor資料夾
2. 一路往上層目錄查找, 直到找到$GOPATH/src下的vendor
3. 在GOROOT目錄下查找
4. 在GOPATH下查找

vendor使用建議

• 一個專案只會有一個vendor目錄, 且就位於專案的根目錄內.

govendor

govendor就是一個基於vendor這種目錄機制所做出來的套件管理工具.
go在以前常用的套件包管理工具其中之一就是govendor.
能在go build時的應用路徑搜尋調整成為當前專案項目目錄/vendor目錄的方式.

安裝govendor

go get -u -v github.com/kardianos/govendor

安裝好到$GOPATH/bin下, 會看到govendor的可執行檔.

使用govendor

初始化vendor

// 移動該專案的根目錄
govendor init

下載依賴包

下載master主幹下最新的commit

govendor fetch 路徑

vendor.json
用來紀錄依賴包的commit的hash跟時間等等

下載特定的版本

govendor fetch 路徑@v版本

vendor.json
用來紀錄依賴包的列表版本, commit的hash跟時間等等

下載特定的tag 或是branch

govendor fetch 路徑@=tag_name
govendor fetch 路徑@=branch_name

加入GOPATH現有的包到vendor管理下

從GOPATH下複製指定的包

govendor add path

這依賴包位於我的$GOPATH/src/githut.com/xwb1989/sqlparser目錄下

添加所有的依賴包

govendor add +external

使用自己小改過的包來取代官方第三方依賴包

可能內部對github.com/go-sql-driver/mysql有加入點東西, 就能用這種方式改用自己的,但是程式import 還是照常github.com/go-sql-driver/mysql

govendor get 'github.com/go-sql-driver/mysql::github.com/tedmax100/go-mysql'

刪除沒用的依賴包

govendor remove +unused

輸入完之後, 會發現全空, 因為我這時該專案目錄下還沒有任何程式作import.

package main

import (
	log "github.com/sirupsen/logrus"
)

func main() {
	log.WithFields(log.Fields{
		"animal": "walrus",
	}).Info("A walrus appears")
}

透過govendor再次安裝依賴包

govendor fetch github.com/sirupsen/logrus@v1.4.2  
govendor add github.com/xwb1989/sqlparser/

govendor remove +unused

只會留下有用到的.

再次清空govendor所有依賴
執行add

govendor add +external

也會得到跟上圖一樣的結果.

go run main.go

成功執行!

列出該專案所有存在的依賴包

govendor list

從vendor.json恢復所有依賴包原始碼到vendor目錄下

govendor sync

與npm、yarn相同的使用命令

govendor看似完美了, 但幹麻還出gomodule?

因為govendor要求一定要在$GOPATH/src下執行.
不然會報錯誤

下一篇的go module就是能解決這問題