Go 包依赖管理工具 —— govendor

govendor 是一个基于 vendor 机制实现的 Go 包依赖管理命令行工具。与原生 vendor 无侵入性融合,也支持从其他依赖管理工具迁移,可以很方便的实现同一个包在不同项目中不同版本、以及无相互侵入的开发和管理。

vendor 特性

最开始的时候,Go 并没有提供较为妥当的包管理工具。从 1.5 版本开始提供了 vendor 特性,但需要手动设置环境变量 GO15VENDOREXPERIMENT=1。

在执行 go build 或 go run 命令时,会按照以下顺序去查找包:

  • 当前包下的 vendor 目录

  • 向上级目录查找,直到找到 src 下的 vendor 目录

  • 在 GOROOT 目录下查找

  • 在 GOPATH 下面查找依赖包

在发布 1.6 版本时,该环境变量的值已经默认设置为 1 了,该值可以使用 go env 命令查看。

在发布 1.7 版本时,已去掉该环境变量,默认开启 vendor 特性。

vendor 使用建议

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

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

govendor 简介

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

  • 支持从项目源码中分析出依赖的包,并从 $GOPATH 复制到项目的 vendor 目录下

  • 支持包的指定版本,并用 vendor/vendor.json 进行包和版本管理,这点与 PHP 的 Composer 类似

  • 支持用 govendor add/update 命令从 $GOPATH 中复制依赖包

  • 如果忽略了 vendor/*/ 文件,可用 govendor sync 恢复依赖包

  • 可直接用 govendor fetch 添加或更新依赖包

  • 可用 govendor migrate 从其他 vendor 包管理工具中一键迁移到 govendor

  • 支持 Linux,macOS,Windows,甚至现有所有操作系统

  • 支持 Git、Hg、SVN,BZR(必须指定一个路径)

govendor 使用

要求: - 项目必须在 $GOPATH/src 目录下 - 如果 Go 版本为 1.5,则必须手动设置环境变量 set GO15VENDOREXPERIMENT=1

安装

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 文件内容为:

{

常用命令

  • 将已被引用且在 $GOPATH 下的所有包复制到 vendor 目录
govendor add +external
  • 仅从 $GOPATH 中复制指定包
govendor add gopkg.in/yaml.v2
  • 列出代码中所有被引用到的包及其状态
govendor list
 e  github.com/gin-contrib/sse
  • 列出一个包被哪些包引用
govendor list -v fmt
 e  github.com/gin-contrib/sse
  • 列出一个包被哪些包引用
govendor list -v fmt
 s  fmt
  • 从远程仓库添加或更新某个包(不会在 $GOPATH 也存一份)
govendor fetch golang.org/x/net/context
  • 安装指定版本的包
govendor fetch golang.org/x/net/context@a4bbce9fcae005b22ae5443f6af064d80a6f5a55
  • 只格式化项目自身代码(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

govendor 子命令

各子命令详细用法可通过 govendor COMMAND -h 或阅读 github.com/kardianos/govendor/context 查看源码包如何实现的。

子命令 功能
init 创建 vendor 目录和 vendor.json 文件
list 列出&过滤依赖包及其状态
add $GOPATH 复制包到项目 vendor 目录
update $GOPATH 更新依赖包到项目 vendor 目录
remove vendor 目录移除依赖的包
status 列出所有缺失、过期和修改过的包
fetch 从远程仓库添加或更新包到项目 vendor 目录(不会存储到 $GOPATH)
sync 根据 vendor.json 拉取相匹配的包到 vendor 目录
migrate 从其他基于 vendor 实现的包管理工具中一键迁移
get go get 类似,将包下载到 $GOPATH,再将依赖包复制到 vendor 目录
license 列出所有依赖包的 LICENSE
shell 可一次性运行多个 govendor 命令

govendor 状态参数

状态 缩写 含义
+local l 本地包,即项目内部编写的包
+external e 外部包,即在 GOPATH 中、却不在项目 vendor 目录
+vendor v 已在 vendor 目录下的包
+std s 标准库里的包
+excluded x 明确被排除的外部包
+unused u 未使用的包,即在 vendor 目录下,但项目中并未引用到
+missing m 被引用了但却找不到的包
+program p 主程序包,即可被编译为执行文件的包
+outside
相当于状态为 +external +missing
+all
所有包

支持状态参数的子命令有:listaddupdateremovefetch

Go modules

普大喜奔的是,从 Go 1.11 版本开始,官方已内置了更为强大的 Go modules 来一统多年来 Go 包依赖管理混乱的局面(Go 官方之前推出的 dep工具也几乎胎死腹中),并且将在 1.13 版本中正式默认开启。

目前已受到社区的看好和强烈推荐,建议新项目采用 Go modules。

参考

  • govendor 项目

  • golang使用vendor目录来管理依赖包

  • Golang包管理工具之govendor的使用

出处:http://u6.gg/sDe3r

Golang零基础入门课程

本课程为:网络班6.15正式开班上课

golang 课程 6 月15 日开课,想要学习的小伙伴可以扫码咨询

添加小助手WeChat:17812796384

image
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容

  • vendor 在Go1.5 release的版本的发布vendor目录被添加到除了GOPATH和GOROOT之外的...
    _羊羽_阅读 3,945评论 0 2
  • 回家路上,一下车就看到了夕阳无限。 对“落日余晖”这个词喜欢不上来,总觉得有某种“残喘”的意味,但它那么热烈那么美...
    月未满儿阅读 210评论 2 5
  • 好好的一个村落,本来只是集体从事个纸扎行业都够阴森,现在更加上几十人命丧于此,按照世人的描述,简直就是大凶之地! ...
    万堤小姐姐阅读 230评论 0 0
  • 今天Jason老师与大家一起探讨下动名词和不定式的用法。 动名词通常是名词,但是又不同于其他的名词,因为它来源于动...
    JasonEnglish阅读 777评论 0 0
  • 在没有读到这本书之前,我一直认为自己是个勤奋的人,每天都是忙碌的做着各种各样的事,但后来我发现,自己常常上班下来,...
    ccq_2018阅读 250评论 0 1