Go / 系统课时

用 go work use 组合模块

用 go work use 组合模块

开发多个相互依赖的 Go 模块时,逐个修改 replace 很快会让本地联调配置变得零散。go work use 可以把多个本地模块加入同一个 go.work 工作区,让 Go 在工作区上下文中把这些模块作为主模块共同参与构建。([Go][2])

学习目标

  • 会创建并查看一个 Go 工作区
  • 会用 go work use 加入单个本地模块
  • 能判断工作区什么时候适合联调、什么时候应回到正常模块依赖

先准备两个本地模块

假设目录如下,service 依赖同级的 shared:

text
workspace/
├── service/
│   └── go.mod
└── shared/
    └── go.mod

两个目录都必须是真实的 Go module,也就是各自存在 go.mod。工作区并不要求所有模块必须位于同一个父目录,但 use 指向的是模块目录路径。([Go][2])

用 go work use 加入模块

在 workspace 目录中先创建工作区,再把两个模块加入:

bash
go work init
go work use ./service ./shared
go env GOWORK
cat go.work

预期结果

text
<工作区绝对路径>/go.work

随后 go.work 会包含类似下面的内容,具体 go 版本号由当前 Go 工具链决定:

go
go 1.24

use (
	./service
	./shared
)

预期结果

text
go.work 中存在 ./service 和 ./shared 两条 use 路径,Go 命令在该目录及其子目录范围内可以识别这个工作区。

go work use 的基本语法是 go work use [-r] [moddirs]。指定目录后,Go 会为其中的模块增加 use 指令;如果给出的目录已经不存在,对应的 use 项会被移除。-r 则会递归搜索参数目录下的模块。([Go][3])

工作区怎样改变联调方式

进入工作区后,Go 会把 use 指定的模块作为工作区的主模块集合。这样,service 在本地开发时就可以直接使用 shared 的当前源码,不必为了每次修改都去发布一个新版本。Go 官方工作区教程也明确将这一机制作为多模块本地联调的用途。([Go][4])

例如,修改 shared 后,在工作区目录运行构建或测试命令,Go 会在工作区上下文中解析这些本地主模块。可以通过下面的命令确认当前是否真的启用了工作区:

bash
go env GOWORK

预期输出

text
<工作区绝对路径>/go.work

如果输出为空,说明当前 Go 命令没有处于工作区模式。GOWORK 可以决定 Go 使用哪个 go.work 文件;在工作区模式下,其他模块相关命令也会读取这个工作区配置。([Go][2])

与 replace 的边界

go work use 解决的是“本地有哪些模块一起参与开发”,而不是“发布后消费者应该依赖哪个版本”。工作区配置主要服务开发和联调;真正发布模块时,使用方仍应通过版本号从模块仓库解析依赖。官方教程也建议在模块正式发布后,把依赖重新指向一个正式版本,以便脱离本地工作区独立构建。([Go][4])

因此,不要把 go.work 当成生产环境的依赖清单。团队通常应把它用于多模块本地开发,并在提交、构建或发布流程中明确是否启用工作区,避免本地源码被误当成线上版本来源。

目录较多时用 -r

当一个目录下面包含多个模块,可以直接递归加入:

bash
go work use -r ./modules

预期结果

text
./modules 下包含 go.mod 的模块被加入 go.work;不包含 go.mod 的普通目录不会成为工作区模块。

官方 go work use 实现对 -r 的定义就是递归搜索参数目录中的模块,并按发现的模块目录更新 use 指令。([Go][3])

实际联调时,最重要的判断不是“有没有 go.work 文件”,而是“当前命令是否真的在使用它”。先用 go env GOWORK 验证,再检查 go.work 的 use 路径,通常就能快速解释为什么本地修改已经生效,或者为什么 Go 仍然在使用仓库中的旧版本。

按自己的节奏,确认真正理解。

目录与阅读设置

记录一个想法

用 go work use 组合模块

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通