Go / 系统课时
什么时候应该使用 vendor
什么时候应该使用 vendor
Go 默认从模块缓存获取依赖,通常已经能满足开发、测试和构建需求。vendor 则把构建所需的依赖源码复制到项目的 vendor 目录中,让依赖直接进入源码树。本课重点判断两种方式的边界,而不是把 vendor 当成默认必选项。
学习目标
- 理解模块缓存与
vendor的依赖来源差异 - 能根据离线构建、供应链审查等需求判断是否采用
vendor - 能正确生成、检查并使用项目中的
vendor目录
模块缓存和 vendor 的区别
使用模块缓存时,依赖源码由 Go 模块机制根据 go.mod 等信息获取并放入本机模块缓存。不同开发机可以独立完成依赖下载,项目源码本身不必包含第三方源码副本。
使用 vendor 时,依赖源码会被放进项目目录。构建时可以直接使用项目内的这些依赖文件,因此依赖内容与当前源码仓库一起被固定下来。代价是仓库体积增大、依赖更新需要重新生成 vendor,同时团队需要接受维护一份依赖源码副本。
| 场景 | 模块缓存 | vendor |
|---|---|---|
| 常规开发和 CI | 通常足够 | 可用但维护成本更高 |
| 构建环境无法联网 | 需要预先准备缓存 | 更适合把依赖带入源码树 |
| 需要审查仓库内实际依赖源码 | 不直接集中在仓库 | 更直观 |
| 仓库体积和维护简单性 | 更有利 | 成本更高 |
生成并使用 vendor
在模块根目录执行 go mod vendor,Go 会根据当前模块依赖生成或更新 vendor 目录。完成后再检查版本控制差异。
go mod tidy
go mod vendor
git status --short
g`
预期结果
`text
M go.mod
M go.sum
?? vendor/具体状态取决于仓库当前是否已跟踪 vendor,因此这里重点检查是否生成了预期的 vendor 内容,以及其中的依赖是否与当前模块声明一致。
生成后可以通过显式开启 vendor 模式进行构建验证。对于支持自动 vendor 行为的 Go 版本和模块布局,也可能由 Go 在满足条件时自动使用 vendor;需要明确控制构建行为时,显式指定更容易排查。
go build -mod=vendor ./...预期结果
# 命令正常结束且无错误输出,表示当前项目可以使用 vendor 内容完成构建哪些情况下值得采用 vendor
最常见的理由是构建环境对网络依赖有较强限制,例如隔离网络、受控构建环境或需要把依赖源码与项目一起交付。另一类场景是组织希望直接审查构建时使用的依赖源码,把依赖副本作为源码交付物的一部分管理。
但如果团队的 CI 可以稳定访问模块代理,依赖获取过程已经有明确的缓存策略,并且没有把依赖源码纳入仓库的要求,继续使用模块缓存通常更简单。vendor 并不会自动解决所有供应链问题,也不会替代版本锁定和依赖审查。
什么时候不该为了“可复现”而盲目使用 vendor
可复现构建的核心是让输入依赖稳定且可验证,而不是必须把所有依赖源码塞进仓库。对于已经有稳定模块代理、依赖校验、CI 缓存和版本控制流程的团队,模块缓存方案同样可以形成可重复的构建流程。
选择 vendor 前,先确认真正的问题是网络不可用、依赖审查要求,还是构建环境需要携带完整依赖源码。只有这些需求明确存在时,vendor 才值得承担额外的仓库和维护成本。