Go / 系统课时
看懂 go.work 的作用范围
看懂 go.work 的作用范围
这一课解决本地多模块开发中最容易混淆的问题:到底该改 go.work、go.mod,还是使用 replace。掌握作用范围后,你可以判断一次依赖解析为什么会走本地代码。
学习目标
- 理解
go.work、go.mod和replace各自负责什么 - 判断当前命令是否处于 workspace 模式
- 根据实际需求选择工作区级或模块级配置
go.work 到底影响哪里
Go 默认在 GOWORK=auto 时,从当前目录向父目录查找 go.work;找到有效文件后,其中 use 指定的模块会共同作为当前命令的主模块。也就是说,影响范围不是某一个 go.mod 文件,而是这个工作区内参与构建和依赖解析的多个模块。([Go][1])
例如仓库中有两个模块:app 依赖 lib。把二者加入同一个工作区后,app 可以直接使用工作区中的 lib 源码,不必先发布一个新版本再测试本地改动。([Go][2])

go.mod 和 replace 怎么分工
go.mod 描述单个模块自己的依赖要求,例如需要哪个模块、哪个版本;replace 则改变 Go 查找某个依赖源码的位置。一个本地 replace 通常只影响声明它的主模块,并不会自动传递给依赖这个模块的其他项目。([Go][3])
go.work 也可以写 replace,而且 workspace 中的 replace 优先于各模块 go.mod 里的 replace。这个能力适合解决多个本地模块各自配置不同、导致联调结果不一致的问题。([Go][4])
可以把三者理解成:go.mod 管单个模块的长期依赖声明,go.work 管本地联调时有哪些模块一起工作,replace 管某个模块解析时实际从哪里取得源码。
用命令确认当前作用范围
不要凭目录结构猜 workspace 是否生效,直接查看 GOWORK。下面的命令只查询当前环境,不修改项目文件。
cd <PATH>
go env GOWORK预期输出
<PATH>/go.work若输出为空,说明当前命令没有使用 workspace 文件;也可能是 GOWORK=off,或者在自动查找模式下没有找到 go.work。([Go][1])
再查看工作区文件,可以确认有哪些模块被纳入:
cat go.work预期输出
go <GO_VERSION>
use (
./app
./lib
)这里的 use 路径指向包含 go.mod 的模块目录,并不会因为写了某个父目录就自动把其所有子模块递归加入;需要递归加入时应使用 go work use -r。([Go][5])
什么时候用哪一种
本地同时修改多个模块、希望消费者立即使用本地源码时,优先考虑 go.work。单个模块需要长期声明外部依赖时,写入该模块自己的 go.mod。只有确实要临时改写某个依赖来源时,才使用 replace。
一个实用判断方法是:这是整个本地联调环境的选择,还是这个模块本身的依赖契约? 前者更接近 go.work,后者更接近 go.mod;而 replace 是对依赖来源的定向重定向。这样理解,通常就不会把本地开发配置误提交进模块的长期依赖定义。