go包管理工具 govendor

govendor介绍

govendor 是 GoLang 常用的一个第三方包管理工具，它的出现解决了不同用户在 clone 同一个项目时从外部获取不同依赖库版本的问题。

govendor会将项目需要的依赖包添加到项目的 vendor 目录下，并且该目录中 vendor.json 文件会保存添加的依赖包的路径等信息。

Golang 项目中的go文件在查找依赖的顺序是，先在当前包下的 vendor 目录中查找，vendor 没找到，然后在 GOPATH 中查找，都没找到最后在 GOROOT 中查找。

govendor只是用来管理项目的依赖包，如果 GOPATH 中本身没有项目的依赖包，则需要通过go get先下载到 GOPATH 中，再通过govendor add +external拷贝到 vendor 目录中。

从 GoLang 1.11 版本开始，官方推出了一个崭新的包管理工具 — go module，随着 GoLang 1.13 版本的发布，go module 默认开启，官方开始强推 go module，使用 go module 作为包管理工具已经成为了官方倡导的趋势。

go module基本使用

安装与使用

govendor安装

在使用Govendor之前，需要安装Govendor。

go get -u github.com/kardianos/govendor

从 Go 1.17 版本开始，'go get' 命令在安装可执行文件方面已经被弃用。

应该使用 'go install' 命令来安装可执行文件。

go install github.com/kardianos/govendor@latest

为了便于项目使用Govendor。建议将 $GOPATH/bin 添加到 PATH 中。

export PATH="$GOPATH/bin:$PATH"

govendor使用

在使用govendor时，当前项目需要在$GOPATH路径下，并且Go版本>=1.5，需要设置GO15VENDOREXPERIMENT=1。

在 Golang1.5 版本后，Go 提供了 GO15VENDOREXPERIMENT 环境变量，并从 GoLang1.6 版本开始默认开启该环境变量。

一旦开启 GO15VENDOREXPERIMENT，go build 等工具除了搜索 $GOPATH/src 路径外，还会搜索当前项目的 vendor 路径，govendor 正是利用了这一特性来实现的。

export GO15VENDOREXPERIMENT=1

1 . govendor初始化（同时创建 vendor 文件夹和 vendor.json 文件）

govendor init

2 . 从 $GOPATH 中复制依赖包到 vendor 目录

govendor add +external

如果你只想添加某个包，执行：

govendor fetch github.com/tjfoc/gmsm/

3 . 从$GOPATH目录下添加依赖包，依赖包会加到 vendor.json

govendor add github.com/tjfoc/gmsm/

4 . 从远程仓库添加包并下载到$GOPATH目录

govendor get github.com/tjfoc/gmsm/

5 . 基于vendor.json 中记录的依赖包信息，拉取更新

govendor sync

6 . 列出代码引用的包及状态

govendor list

7 . 找出使用的对应包

govendor list -v fmt

8 . 从远程仓库添加或更新拉取指定版本的包

govendor fetch golang.org/x/net/context

govendor fetch golang.org/x/net/context@a4bbce9fcae005b22ae5443f6af064d80a6f5a55
govendor fetch golang.org/x/net/context@v1   # Get latest v1.*.* tag or branch.
govendor fetch golang.org/x/net/context@=v1  # Get the tag or branch named "v1".

常见的命令

格式为 govendor COMMAND。

命令	功能
init	初始化 vendor 目录
list	列出所有的依赖包
add	添加包到 vendor 目录，如 govendor add +external 添加所有外部包
add PKG_PATH	添加指定的依赖包到 vendor 目录
update	从 $GOPATH 更新依赖包到 vendor 目录
remove	从 vendor 管理中删除依赖
status	列出所有缺失、过期和修改过的包
fetch	添加或更新包到本地 vendor 目录
sync	本地存在 vendor.json 时候拉去依赖包，匹配所记录的版本
get	类似 go get 目录，拉取依赖包到 vendor 目录

go vendor –help查看子命令

Sub-Commands

    init     Create the "vendor" folder and the "vendor.json" file.
    list     List and filter existing dependencies and packages.
    add      Add packages from $GOPATH.
    update   Update packages from $GOPATH.
    remove   Remove packages from the vendor folder.
    status   Lists any packages missing, out-of-date, or modified locally.
    fetch    Add new or update vendor folder packages from remote repository.
    sync     Pull packages into vendor folder from remote repository with revisions
                   from vendor.json file.
    migrate  Move packages from a legacy tool to the vendor folder with metadata.
    get      Like "go get" but copies dependencies into a "vendor" folder.
    license  List discovered licenses for the given status or import paths.
    shell    Run a "shell" to make multiple sub-commands more efficient for large
                 projects.

govendor命令参数

Status Types

    +local    (l) packages in your project
    +external (e) referenced packages in GOPATH but not in current project
    +vendor   (v) packages in the vendor folder
    +std      (s) packages in the standard library

    +excluded (x) external packages explicitly excluded from vendoring
    +unused   (u) packages in the vendor folder, but unused
    +missing  (m) referenced packages but not found

    +program  (p) package is a main package

    +outside  +external +missing
    +all      +all packages

注意事项

• 如果引用包目录下不存在go文件，使用fetch、get等命令会报错

• 如果$GOPATH目录下存在引用包，使用fetch命令会出现无法下载包的情况