Golang 依赖管理

go中有两个非常重要的环境变量:

  • GOROOTgolang的安装路径,Linux 下默认会安装在/usr/local/go之下
  • GOPATH:存放SDK以外的第三方类库;收藏的可复用的代码,包含三个子目录: -- src : 存放项目源码文件 -- pkg : 编译后的包文件 -- bin :编译后生成的可执行文件

Go Module

Go1.11版本开始,引入了Go Module功能,在程序中只有一个go.mod文件,存放依赖列表,而依赖的具体的包默认会下载到GOPATH/pkg/mod目录下面

在运行 go build时,优先引用go.mod文件中的依赖,所以Vendor目录逐渐的被替代了,消失在了大部分的项目当中

go mod的使用

go 1.13以后,go mod就是默认的依赖管理工具,在项目中使用如下的方式创建go.mod文件夹管理依赖

go mod int

这样整个项目就可以使用go mod来进行管理了

下面是 go mod的一些常用命令:

go mod download 下载模块到本地缓存,缓存路径是 $GOPATH/pkg/mod/cache
go mod edit 是提供了命令版编辑 go.mod 的功能,例如 go mod edit -fmt go.mod 会格式化 go.mod
go mod graph 把模块之间的依赖图显示出来
go mod init 初始化模块(例如把原本dep管理的依赖关系转换过来)
go mod tidy 增加缺失的包,移除没用的包
go mod vendor 把依赖拷贝到 vendor/ 目录下
go mod verify 确认依赖关系
go mod why 解释为什么需要包和模块

go mod中存在的一些问题:

  1. 依赖包的地址失效或者下载失败

    此时可以使用 go.mod 文件中的 replace 来替换这个包
    
  2. 之前的项目如何使用go mod管理

    首先把项目移出$GOPATH/src目录,然后运行 go mod init module_name,最后执行 go build 即可
    

Go Vendor

Vendor 目录是Golang1.5版本引入的,为项目提供了一种离线保存第三方依赖的方法;使用vendor的项目,搜索依赖的顺序如下:

当前包下的 vendor 目录
向上级目录查找,直到找到 src 下的 vendor 目录
在 GOROOT 目录下查找
在 GOPATH 下面查找依赖包
项目中使用go vendor

安装

go get -u -v github.com/kardianos/govendor

初始化

cd xxx
govendor init

初始化完成后,项目目录中会生成一个vendor文件夹,包含一个vendor.json文件,json文件中包含了项目所依赖的所有包信息

{
 "comment": "",
 "ignore": "test",
 "package": [],
 "rootPath": "govendor-test"
}
govendor常用命令
  • 将已被引用且在 $GOPATH 下的所有包复制到 vendor 目录

    govendor add +external
    
  • 仅从 $GOPATH 中复制指定包

    govendor add gopkg.in/yaml.v2
    
  • 列出一个包被哪些包引用

    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
    
  • 拉取所有依赖的包到 vendor 目录(包括 $GOPATH 存在或不存在的包)

    govendor fetch +out
    
  • 包已在 vendor 目录,但想从 $GOPATH 更新

    govendor update +vendor
    

各子命令详细用法可通过 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

govendor的缺点
  • 使用vendor的项目需要把该项目所有的依赖都下载到这个项目中的vendor目录下,这就会导致项目变的很庞大

  • vendor不区分依赖包的版本,这就意味着可能出现不同的环境依赖了不同版本的包,很有可能导致编译出错

Go mod vendor

为了能够在离线的环境中也能够部署和应用程序,就保存了vendor目录;然后,执行如下的命令:

go mod vendor

就可以将当前程序的依赖拷贝到vendor目录下,当程序中的包使用go mod下载不下来的时候,就可以引用vendor目录下的依赖了

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

推荐阅读更多精彩内容

  • go 很早就考虑了依赖管理的问题,内置 go get 命令,可以直接获取对应的依赖,非常方便,但是有一个巨大的缺陷...
    hatlonely阅读 577评论 0 0
  • 依赖管理是一个语言非常重要的特性,很大程度上决定着一个语言的流行程度,流行的语言大多都有非常成熟的依赖管理工具,j...
    hatlonely阅读 320评论 0 1
  • 1. govendor简介 golang工程的依赖包经常使用go get命令来获取,例如:go get githu...
    叶扬风起阅读 16,555评论 0 4
  • 一、Go的包设计理念 1.代码盒子 在Go程序中,包是代码模块组织的单位,为项目代码组织结构,提高代码的可读性、重...
    GoFuncChan阅读 468评论 0 0
  • go module go module 是Go1.11版本之后官方推出的版本管理工具。并且从Go1.13版本开始,...
    hk_faith阅读 834评论 0 0