快捷導(dǎo)航

Go中Vendo機(jī)制的使用

更新時(shí)間：2024年10月18日 09:59:13 作者：18792721831

自Go1.6起,Go語言正式啟用vendor機(jī)制,允許將項(xiàng)目依賴放入項(xiàng)目?jī)?nèi)的vendor目錄,類似私有GOPATH,本文就來介紹一下Vendo機(jī)制的使用,感興趣的可以了解一下

1. 介紹

自 Go 1.6 起，vendor 機(jī)制正式啟用，它允許把項(xiàng)目的依賴放到一個(gè)位于本項(xiàng)目的 vendor 目錄中，這個(gè) vendor 目錄可以簡(jiǎn)單理解成私有的 GOPATH 目錄。項(xiàng)目編譯時(shí)，編譯器會(huì)優(yōu)先從 vendor 中尋找依賴包，如果 vendor 中找不到，則再到 GOPATH 中尋找。

2. vendor 目錄位置

一個(gè)項(xiàng)目可以有多個(gè) vendor 目錄，分別位于不同的目錄級(jí)別，建議每個(gè)項(xiàng)目只在根目錄下放置一個(gè) vendor 目錄。
假如有一個(gè) github.com/test/testcase 項(xiàng)目，項(xiàng)目目錄結(jié)構(gòu)如下：

GOPATH/src/github.com/test/testcase/testpackage/main/main.go

其中 main.go 中依賴如下幾個(gè)包：

import (
    "golang.org/x/crypto/ssh"
    "github.com/pkg/sftp"
)

在沒有使用 vendor 目錄時(shí)，若想編譯這個(gè)項(xiàng)目，則 GOPATH 目錄經(jīng)過應(yīng)該如下：

GOPATH/src/github.com/test/testcase/
GOPATH/src/github.com/pkg/sftp
GOPATH/src/golang.org/x/crypto/ssh

即所有依賴的包都位于 GOPATH/src 下。
為了把所使用到的 golang.org/x/crypto/ssh 和 github.com/pkg/sftp 版本固化下來，可以使用 vendor 機(jī)制。
在項(xiàng)目 github.com/test/testcase/ 根目錄下創(chuàng)建一個(gè) vendor 目錄，并把 golang.org/x/crypto/ssh 和 github.com/pkg/sftp存放到此目錄中，讓其成為項(xiàng)目的一部分：

GOPATH/src/github.com/test/testcase/testpackage/main/main.go
GOPATH/src/github.com/test/testcase/vendor/github.com/pkg/sftp/
GOPATH/src/github.com/test/testcase/vendor/golang.org/x/crypto/ssh/

使用 vendor 的好處是在項(xiàng)目 github.com/test/testcase 發(fā)布時(shí)可以把其所依賴的軟件一并發(fā)布，編譯時(shí)不會(huì)受到 GOPATH 目錄的影響，即便 GOPATH 下也有一個(gè)
同名但不同版本的依賴包。

3. 搜索順序

編譯器會(huì)從源碼文件所在的目錄開始逐級(jí)向上搜索，在上面的例子中，在編譯 main.go 時(shí)，編譯器搜索依賴包的順序?yàn)椋?/p>

從 GOPATH/src/github.com/test/testcase/testpackage/main/ 下尋找 vendor 目錄，沒有找到，繼續(xù)從上層查找。
從 GOPATH/src/github.com/test/testcase/testpackage/ 下尋找vendor 目錄，沒有找到，繼續(xù)從上層查找。
從 GOPATH/src/github.com/test/testcase/ 下尋找 vendor 目錄，從 vendor 目錄中查找到依賴包，結(jié)束查找。

如果 GOPATH/src/github.com/test/testcase/ 下的 vendor 目錄中沒有依賴包，則返回 GOPATH 目錄繼續(xù)查找。這就是 GOPATH 機(jī)制了。
實(shí)際上 vendor 目錄可以存在于項(xiàng)目的任意目錄下。但是不推薦，如果 vendor 目錄過于分散，則可能同一個(gè)依賴包在項(xiàng)目的多個(gè) vendor 中出現(xiàn)
多次，這樣依賴包會(huì)多次編譯進(jìn)二進(jìn)制文件，從而造成二進(jìn)制文件的體積急劇增大，也很可能出現(xiàn)一個(gè)項(xiàng)目中使用同一個(gè)依賴包的多個(gè)版本的情況。