关于后端:快速掌握-Go-工作区模式

大家好，我是煎鱼。

在 Go 我的项目的模块治理中，先是 GOPATH，而后到废除。再到强推 Go modules，从被社区抗拒到 rsc 硬上弓。当初最新要理解的，就是工作区模式（workspace mode）。这是一个在 Go1.18 引入的重要个性。

之前始终没提过，明天补全这块的知识点。

在 Go1.11 起有了 Go modules 后，看起来 Go 模块治理逐渐按序有了束缚、标准了起来。但也带来了一些应用上的问题。

事实开发时，当咱们须要对多个关联模块进行开发（批改）时，这个事件就麻烦了起来。我见过两种形式。

1、第一种：间接在 go.mod 文件上配置 replace，配置到本地的开发目录。这是最常见的形式。

// go.mod

replace example.com/golang/text => "../eddycjy/golang/text"

这种做法常常会有人不小心提交到 Git 仓库上。还挺折腾人的，一个不小心就为此 debug 了半天，或者公布部署始终卡着过不去。

2、第二种：间接在依赖模块上编码，编码到肯定的水平。才上传 GitHub/GitLab。再去公布版本标签再援用。这种用法比拟少，只有模块比较简单且对程序比拟自信的会这么干。（不举荐）

总的来讲，就是有了 Go modules 后，多模块间的依赖开发还是挺麻烦的。要常常 replace，有时候又会忘了删。

在大家苦楚了许久后，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/hello
go: creating new go.mod: module example.com/hello

写入代码 hello.go：

package main

import (
    "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-world

go.work 文件内会变成：

$ cat go.work 
go 1.20

use ./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/hello

go.work 文件会变成：

go 1.20

use (
    ./example/hello
    ./hello-world
)

这里须要留神，go work 以 go.mod 为单位。如果你间接引入 ./example。是无奈对 ./example/hello 的 module 起成果的。

在引入胜利后，咱们回到 ./example/hello 目录下的 reverse.go 文件，新增一个用于 Demo 的办法：

...
func Hello() string {return "煎鱼，你好！"}

再到 hello 我的项目中，新增调用：

package main

import (
    "fmt"

    "golang.org/x/example/hello/reverse"
)

func main() {fmt.Println(reverse.String("Hello, 煎鱼"))
    fmt.Println(reverse.Hello())
}

输入后果：

 鱼煎 ,olleH
煎鱼，你好

一切正常。满足不增加 replace 的要求，也应用了 go.work，不必放心把 replace 不小心提交到 Git 仓库中。

另外 Go 工作区中的我的项目在进行编译时，也是援用所配置好的工作区内的模块。而不是单单只针对开发阶段的 go run，也能够在产线下来应用，编译成二进制去利用和部署。

咱们曾经对 Go 的工作区模式有了肯定的理解，其应用场景聚焦在如下：

开发较大的产品，其我的项目存在着多个相互依赖的模块。能够间接设置成一个工作区。
开发第三方库（相似 SDK 库），须要对上游的模块新增新个性。势必要在本地模块先援用做开发、测试、验证。也能够间接应用工作区。

明天咱们疾速理解了 Go 工作区模式（workspace mode）的背景、应用、场景。这对于解决我的项目中多模块依赖有着肯定的作用，能够不再须要去 go.mod 里 replace，算是给了一个规范化的解决方案。

但在理论利用中，咱们会发现工作区模式的便当度，其实不太高。可能依赖模块数量少时，还不如 replace 一把梭来得快。

另外目前阶段的应用宣传还是做得比拟弱的，前两天问了一圈，还真有一些同学不晓得，也没有用过的。

文章继续更新，能够微信搜【脑子进煎鱼了】浏览，本文 GitHub github.com/eddycjy/blog 已收录，学习 Go 语言能够看 Go 学习地图和路线，欢送 Star 催更。

Go 语言入门系列：初探 Go 我的项目实战
Go 语言编程之旅：深刻用 Go 做我的项目
Go 语言设计哲学：理解 Go 的为什么和设计思考
Go 语言进阶之旅：进一步深刻 Go 源码

Go 常量为什么只反对根本数据类型？
互联网公司裁员的预兆和伎俩
Go1.21 那些事：泛型库、for 语义变更、对立 log/slog、WASI 等新个性，你晓得多少？

关于后端:快速掌握-Go-工作区模式

背景

go work 指令集

疾速应用

创立工作区

创立演示模块

创立需批改的模块

场景汇总

总结

Go 图书系列

举荐浏览