golang 包依赖管理 - govendor

最新推荐文章于 2024-07-20 12:53:04 发布

独一无二的小个性

最新推荐文章于 2024-07-20 12:53:04 发布

阅读量4.9k

点赞数

分类专栏： Golang 文章标签： golang govender 包依赖管理

本文链接：https://blog.csdn.net/u010649766/article/details/80327035

版权

Golang 专栏收录该内容

19 篇文章 0 订阅

订阅专栏

Golang 官方并没有推荐最佳的包管理方案。到了1.5版本时代，官方引入包管理的设计，加了 vendor 目录来支持本地包管理依赖。官方 wiki 推荐了多种支持这种特性的包管理工具，如：Godep、gv、gvt、glide、govendor等。

下面简要介绍一个我在项目中用到的 – govendor。
该工具将项目依赖的外部包拷贝到项目下的 vendor 目录下，并通过 vendor.json 文件来记录依赖包的版本，方便用户使用相对稳定的依赖。
对于 govendor 来说，依赖包主要有以下多种类型:

状态	缩写状态	含义
+local	l	本地包，即项目自身的包组织
+external	e	外部包，即被 $GOPATH 管理，但不在 vendor 目录下
+vendor	v	已被 govendor 管理，即在 vendor 目录下
+std	s	标准库中的包
+unused	u	未使用的包，即包在 vendor 目录下，但项目并没有用到
+missing	m	代码引用了依赖包，但该包并没有找到
+program	p	主程序包，意味着可以编译为执行文件
+outside		外部包和缺失的包
+all		所有的包

Installation

go get -u github.com/kardianos/govendor

命令行执行 govendor，若出现以下信息，则说明安装成功。

➜  ~ govendor
govendor (v1.0.8): record dependencies and copy into vendor folder
    -govendor-licenses    Show govendor's licenses.
    -version              Show govendor version
...
...

Warning： 需要把 $GOPATH/bin/ 加到 PATH 中。

Quickstart

# Setup your project.
cd "my project in GOPATH"
# 初始化 vendor 目录, project 下出现 vendor 目录
govendor init

# Add existing GOPATH files to vendor.
govendor add +external

# View your work.
govendor list

# Look at what is using a package
govendor list -v fmt

# Specify a specific version or revision to fetch
govendor fetch golang.org/x/net/context@a4bbce9fcae005b22ae5443f6af064d80a6f5a55

# Get latest v1.*.* tag or branch.
govendor fetch golang.org/x/net/context@v1   

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

# Update a package to latest, given any prior version constraint
govendor fetch golang.org/x/net/context

# Format your repository only
govendor fmt +local

# Build everything in your repository only
govendor install +local

# Test your repository only
govendor test +local

Sub-commands

init     创建 vendor 文件夹和 vendor.json 文件
list     列出已经存在的依赖包
add      从 $GOPATH 中添加依赖包，会加到 vendor.json
update   从 $GOPATH 升级依赖包
remove   从 vendor 文件夹删除依赖
status   列出本地丢失的、过期的和修改的package
fetch    从远端库增加新的，或者更新 vendor 文件中的依赖包
sync     Pull packages into vendor folder from remote repository with revisions
migrate  Move packages from a legacy tool to the vendor folder with metadata.
get      类似 go get，但是会把依赖包拷贝到 vendor 目录
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.

go tool commands that are wrapped:
      `+<status>` package selection may be used with them
    fmt, build, install, clean, test, vet, generate, tool

warning

The project must be within a $GOPATH/src.
If using go1.5, ensure you set GO15VENDOREXPERIMENT=1.

Vendor目录介绍

随着Go 1.5 release版本的发布，vendor目录被添加到除了GOPATH和GOROOT之外的依赖目录查找的解决方案。在Go 1.6之前，你需要手动的设置环境变量GO15VENDOREXPERIMENT=1才可以使Go找到Vendor目录，然而在Go 1.6之后，这个功能已经不需要配置环境变量就可以实现了。

Note，即使使用vendor，也必须在GOPATH中，在go的工具链中，你逃不掉GOPATH的

那么查找依赖包路径的解决方案如下：

当前包下的vendor目录。
向上级目录查找，直到找到src下的vendor目录。
在GOPATH下面查找依赖包。
在GOROOT目录下查找

一些建议

在使用vendor中，给出如下建议：

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

上面建议的原因如下：

在目录结构中的每个包的实例，即使是同一个包的同一个版本，都会打到最终的二进制文件中，如果每个人都单独的存储自己的依赖包，会迅速导致生成文件的二进制爆发（binary bloat)
在一个目录的某个pacage类型，并不兼容在同一个package但是在不同目录的类型，即便是同一个版本的package，那意味着loggers，数据库连接，和其他共享的实例都没法工作。

举个例子

工程目录如下：

- $GOPATH/src/github.com/mattfarina/golang-broken-vendor
  - foo.go
  - vendor/
    - a/
    - b/
        - vendor/a/

在这个例子中，两个a package都是完全一样的，b package在代码库中保存了a package，在顶级应用代码中也引用了a包。

文件foo.go做了很简单的事情：

func main() {
    var it a.A
    it = "foo"

    b.Do(it)
}

那么问题来了，当我们build的时候，发现出问题了，返回了下面的错误：

$ GO15VENDOREXPERIMENT=1 go build
./foo.go:12: cannot use it (type "github.com/mattfarina/golang-broken-vendor/vendor/a".A) as type "github.com/mattfarina/golang-broken-vendor/vendor/b/vendor/a".A in argument to b.Do

你可以clone这个测试工程到本地重现。