快速掌握 Go 工作区模式

在 Go 项目的模块管理中,先是 GOPATH , 然后到废弃 。再到强推 Go modules,从被社区抗拒到 rsc 硬上弓 。现在最新要了解的 , 就是工作区模式(workspace mode) 。这是一个在 Go1.18 引入的重要特性 。
之前一直没提过,今天补全这块的知识点 。
背景在 Go1.11 起有了 Go modules 后,看起来 Go 模块管理逐步按序有了约束、规范了起来 。但也带来了一些使用上的问题 。
现实开发时,当我们需要对多个关联模块进行开发(修改)时 , 这个事情就麻烦了起来 。我见过两种方式 。
1、第一种:直接在 go.mod 文件上配置 replace,配置到本地的开发目录 。这是最常见的方式 。
// go.modreplace example.com/golang/text => "../eddycjy/golang/text"这种做法经常会有人不小心提交到 Git 仓库上 。还挺折腾人的,一个不小心就为此 debug 了半天,或者发布部署一直卡着过不去 。
2、第二种:直接在依赖模块上编码,编码到一定的程度 。才上传 Github/GitLab 。再去发布版本标签再引用 。这种用法比较少,只有模块比较简单且对程序比较自信的会这么干 。(不推荐)
总的来讲,就是有了 Go modules 后 , 多模块间的依赖开发还是挺麻烦的 。要经常 replace,有时候又会忘了删 。
go work 指令集在大家痛苦了许久后 , Go1.18 时终于发布了工作区模式的方式 , 来优化这个用法和问题 。
以下是 go work 的指令集:
go work <command> [arguments]

  • edit:从工具或脚本中编辑 go.work 。
  • init:初始化工作区文件(go.work) 。
  • sync:将工作区构建列表同步到模块 。
  • use:将模块添加到工作区文件 。
快速使用接下来我们快速应用 Go 工作区模式,让大家有个直观的了解 。
需要注意,该特性需要确保 Go 版本 >= 1.18 。
创建工作区首先我们创建一个工作区,执行如下命令:
$ mkdir workspace-mAIn && cd workspace-main $ go work init执行完毕后会在该目录下创建一个 go.work 文件,文件内容包含:
go 1.20仅包含版本信息,因为当前是空白的工作区,只有初始化行为 。
创建演示模块$ mkdir hello-world && cd hello-world$ go mod init example.com/hellogo: creating new go.mod: module example.com/hello写入代码 hello.go:
package mainimport ( "fmt" "golang.org/x/example/hello/reverse")func main() { fmt.Println(reverse.String("Hello, 煎鱼"))}如果你这时候直接 go run 。可能会出现如下报错:
hello.go:6:5: no required module provides package golang.org/x/example/hello/reverse: go.mod file not found in current directory or any parent directory; see 'go help modules'看着非常迷惑人,很多同学以为是环境变量 GO111MODULE 没有设置为 on 。其实是没有将本模块加入工作区中,导致运行错误 。
所以可以看出来,在设计上是先有项目,再有工作区的路径 。也是相对符合的 。
这时候需要回到工作区目录 workspace-main 。执行如下命令:
go work use ./hello-worldgo.work 文件内会变成:
$ cat go.work go 1.20use ./hello-world再运行程序:
$ go run hello-world/hello.go 鱼煎 ,olleH一切正常 。
创建需修改的模块这时候我们有了一个实际的诉求,我们希望 golang.org/x/example/hello 改一下这个 SDK 库 。
如果是以前的话 , 我们需要写 replace 来解决 。现在的话可以用工作区模式来完成这个诉求 。
我们先需要回到工作区根目录 workspace-main 下,拉取这个 SDK 库到工作区中:
git clone https://go.googlesource.com/example再将其引入项目的工作区中:
go work use ./example/hellogo.work 文件会变成:
go 1.20use ( ./example/hello ./hello-world)这里需要注意,go work 以 go.mod 为单位 。如果你直接引入 ./example 。是无法对 ./example/hello 的 module 起效果的 。


推荐阅读