Go Vendor 使用指南

Go Vendor简介

govendor 是一个基于 vendor 目录机制的包管理工具。

最开始的时候，Go 并没有提供较为妥当的包管理工具。从 1.5 版本开始提供了 vendor 特性，但需要手动设置环境变量 GO15VENDOREXPERIMENT=1。在执行 go build 或 go run 命令时，会按照以下顺序去查找包：

• 在当前vendor目录（如果当前目录存在vendor目录的话）查找依赖包；
• 如果当前目录不存在vendor目录，则到上一级目录继续查找；
• 重复步骤2，直到到达$GOPATH/src目录，查找vendor目录中是否存在依赖包；
• 如何没有查找到依赖包，则继续在$GOROOT目录查找；
• 如果没有查找到，则继续在$GOPATH/src目录查找。

在发布 1.6 版本时，该环境变量的值已经默认设置为 1 了，该值可以使用 go env 命令查看。在发布 1.7 版本时，已去掉该环境变量，默认开启 vendor 特性。

govendor 功能

• 支持从项目源码中分析出依赖的包，并从 $GOPATH 复制到项目的 vendor 目录下；
• 支持包的指定版本，并用 vendor/vendor.json 进行包和版本管理；
• 支持用 govendor add/update 命令从 $GOPATH 中复制依赖包；
• 如果忽略了 vendor/*/ 文件，可用 govendor sync 恢复依赖包；
• 可直接用 govendor fetch 添加或更新依赖包；
• 可用 govendor migrate 从其他 vendor 包管理工具中一键迁移到 govendor；
• 支持 Linux，macOS，Windows，甚至现有所有操作系统；
• 支持 Git、Hg、SVN，BZR（必须指定一个路径）；

govendor 使用建议

• 一个库工程（不包含 main 的 package）不应该在自己的版本控制中存储外部的包在 vendor 目录中，除非有特殊原因并且知道为什么要这么做。

• 在一个应用中，（包含 main 的 package），建议只有一个 vendor 目录，且在代码库一级目录。

govendor 命令

• 状态参数

• 支持状态参数的子命令有：list、add、update、remove、fetch

govendor 使用

安装

go get -u github.com/kardianos/govendor

为了方便快捷使用 govendor，建议将 $GOPATH/bin 添加到 PATH 中。Linux/macOS 如下设置：

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

初始化

在项目根目录下执行以下命令进行 vendor 初始化：

govendor init

项目根目录下即会自动生成 vendor 目录和 vendor.json 文件。此时 vendor.json 文件内容为：

{
	"comment": "",
	"ignore": "test",
	"package": [],
	"rootPath": "govendor-example"
}

常用命令

• 将已被引用且在 $GOPATH 下的所有包复制到 vendor 目录

govendor add +external

• 仅从 $GOPATH 中复制指定包

govendor add gopkg.in/yaml.v2

• 列出代码中所有被引用到的包及其状态

govendor list

• 列出一个包被哪些包引用

govendor list -v fmt

• 从远程仓库添加或更新某个包(不会在 $GOPATH 也存一份)

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".

• 只格式化项目自身代码(vendor 目录下的不变动)

govendor fmt +local

• 只构建编译项目内部的包

govendor install +local

• 只测试项目内部的测试案例

govendor test +local

• 构建所有 vendor 包

govendor install +vendor,^program

• 拉取所有依赖的包到 vendor 目录(包括 $GOPATH 存在或不存在的包)

govendor fetch +out

• 包已在 vendor 目录，但想从 $GOPATH 更新

govendor update +vendor

• 已修改了 $GOPATH 里的某个包，现在想将已修改且未提交的包更新到 vendor

govendor update -uncommitted <updated-package-import-path>

• Fork 了某个包，但尚未合并，该如何引用到最新的代码包

govendor fetch github.com/normal/pkg::github.com/myfork/pkg

此时将从 myfork 拉取代码，而不是 normal。

• vendor.json 中记录了依赖包信息，该如何拉取更新

govendor sync

参考

https://lucasfcosta.com/2017/02/07/Understanding-Go-Dependency-Management.html

到此这篇关于Go Vendor 使用指南的文章就介绍到这了,更多相关Go Vendor 使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论