Go1.18 新特性之多模块Multi-Module工作区模式

目录

• 背景
• 举例：未发布的 module
• Go1.18 新特性：多模块（Multi-Module）工作区模式
• Go1.18 工作区模式
• 初始化一个新的工作区
• go.work 文件结构
• go.work 文件优先级高于 go.mod 中定义在
• 如何禁用工作区

背景

在 go 中使用多个模块可能真的是一件苦差事。特别是当您的一个模块依赖于另一个模块时，您需要同时编辑这两个模块！

您编辑父模块，但是然后您需要将其推送到repo。然后在依赖模块中运行 update 以下载新版本。最终使用2行修复您需要的。至少可以说是一种痛苦。

在 Go 1.18之前，建议使用依赖模块中的 replace 指令来处理这个问题。

这个方法是有效的，但也有自己的问题，比如需要手动编辑 go.mod，确保你提交代码时候，不commit 这个 replace等等。

最后，从 Go 1.18开始，引入了一种同时处理多个模块的新方法，这种方法消除了这些问题: go.work。

Multi-Module, Single Workspace
https://medium.com/@michael_epps/multi-module-single-workspace-3493528555ad

举例：未发布的 module

在做本地的 Go 项目开发时，可能会在本地同时开发多个库（项目库、工具库、第三方库）等。

如下代码：

package main

import (
    "github.com/eddycjy/pkgutil"
)

func main() {
    pkgutil.PrintFish()
}

我们看到：该代码对外唯一的依赖是module path为"github.com/eddycjy/pkgutil"的module，但后者是一个尚在本地进行开发，还未发布到http://github.com上的module。

如果这个时候运行 go run 或是 go mod tidy，都不行，会运行失败。
报如下类似错误：

fatal: repository 'https://github.com/eddycjy/pkgutil/' not found

这个问题报错是因为 github.com/eddycjy/pkgutil 这个库，在 GitHub 是没有的，自然也就拉取不到。

因此，许多同学会发出灵魂质疑：Go 的依赖都必须要上传到 GitHub 吗，强绑定？

解决方法：在 Go1.18 以前，我们会通过 replace，又或是直接上传到 Github 上，自然也就能被 Go 工具链拉取到依赖了。

用replace指示符将该版本指向本地的module的开发目录。

Go1.18 新特性：多模块（Multi-Module）工作区模式

2022 年 3 月 15 日 go 1.18 正式发布，新版本除了对性能的提升之外，还引入了很多新功能，其中就有 go 期盼已久的功能泛型(Generics)，同时还引入的多模块工作区(Workspaces)和模糊测试(Fuzzing)。

弥补了当前go module构建模式的一些不足，堪称是go module构建模式的最后一块拼图。

Go 多模块工作区能够使开发者能够更容易地同时处理多个模块的工作，如:

• 方便进行依赖的代码调试(打断点、修改代码)、排查依赖代码 bug
• 方便同时进行多个仓库/模块并行开发调试

go 使用的是多模块工作区，可以让开发者更容易同时处理多个模块的开发。在 Go 1.17 之前，只能使用 go.mod replace 指令来实现，如果你正巧是同时进行多个模块的开发，使用它可能是很痛苦的。每次当你想要提交代码的时候，都不得不删除掉 go.mod 中的 replace 才能使模块稳定的发布版本。

Go1.18 工作区模式

在社区的多轮反馈下，Michael Matloob 提出了提案《Proposal: Multi-Module Workspaces in cmd/go[1]》进行了大量的讨论和实施，在 Go1.18 正式落地。

新提案的一个核心概念，就是增加了 go work 工作区的概念，针对的是 Go Module 的依赖管理模式。

这个提案引入一个go.work文件用于开启Go工作区模式。go.work通过directory指示符设置一些本地路径，这些路径下的go module构成一个工作区(workspace)，Go命令可以操作这些路径下的go module，也会优先使用工作区中的go module。

其能够在本地项目的 go.work 文件中，通过设置一系列依赖的模块本地路径，再将路径下的模块组成一个当前 Go 工程的工作区，也就是 N 个 Go Module 组成 1 个 Go Work， 工作区的读取优先级是最高的。

总结： 当你的本地有很多module，且这些module存在相互依赖，那么我们可以在这些module的外面建立一个Go工作区，基于这个Go工作区开发与调试这些module就变得十分方便。

初始化一个新的工作区

只要执行 go work init 就可以初始化一个新的工作区，后面跟的参数就是要生成的具体子模块 mod。

命令如下：

go work init ./mod ./tools

项目目录如下：

awesomeProject
├── mod
│   ├── go.mod      // 子模块
│   └── main.go
├── go.work         // 工作区
└── tools
    ├── fish.go
    └── go.mod      // 子模块

go work 支持命令

• 通常情况下，建议不要提交 go.work 文件到 git 上，因为它主要用于本地代码开发。
• 推荐在: $GOPATH 路径下执行，生成 go.work 文件
• go work init 初始化工作区文件，用于生成 go.work 工作区文件

初始化并写入一个新的 go.work 到当前路径下，可以指定需要添加的代码模块
示例: go work init ./hello 将本地仓库 hello 添加到工作区
hello 仓库必须是 go mod 依赖管理的仓库(./hello/go.mod 文件必须存在)

go work use 添加新的模块到工作区

use 指定使用的模块目录

命令示例:

go work use ./example 添加一个模块到工作区

命令示例:

go work use ./example 添加一个模块到工作区
go work use ./example ./example1 添加多个模块到工作区
go work use -r ./example 递归 ./example 目录到当前工作区
删除命令使用 go work edit -dropuse=./example 功能

可以使用 go work use hello 添加模块，也可以手动修改 go.work 工作区添加新的模块
在工作区中添加了模块路径，编译的时候会自动使用 use 中的本地代码进行代码编译，和 replaces 功能类似。

# 单模块结构
use ./hello
# 多模块结构
use (
    ./hello
    ./example
)

go work edit 用于编辑 go.work 文件

go work edit 用于编辑 go.work 文件
可以使用 edit 命令编辑和手动编辑 go.work 文件效果是相同的
示例:

go work edit -fmt go.work 重新格式化 go.work 文件
go work edit -replace=github.com/link1st/example=./example go.work 替换代码模块
go work edit -dropreplace=github.com/link1st/example 删除替换代码模块
go work edit -use=./example go.work 添加新的模块到工作区
go work edit -dropuse=./example go.work 从工作区中删除模块

go work sync 将工作区的构建列表同步到工作区的模块

go env GOWORK

查看环境变量，查看当前工作区文件路径
可以排查工作区文件是否设置正确，go.work 路径找不到可以使用 GOWORK 指定

go.work 文件结构

文件结构和 go.mod 文件结构类似，支持 Go 版本号、指定工作区和需要替换的仓库
文件结构示例:

go 1.18

use (
    ./hello
    ./example
)

replace (
    github.com/link1st/example => ./example1
)

replaces 替换依赖仓库地址
replaces 命令与 go.mod 指令相同，用于替换项目中依赖的仓库地址
需要注意的是 replaces 和 use 不能同时指定相同的本地路径

错误示例
同时在 use 和 replace 指定相同的本地路径

go 1.18

use (
    ./hello
    ./example
)

replace (
    github.com/link1st/example => ./example
)

go.work 文件优先级高于 go.mod 中定义在

同时使用 go.work 和 go.mod replace 功能的的时候分别指定不同的代码仓库路径，go.work 优先级高于 go.mod 中定义

如何禁用工作区

Go 全局变量 GOWORK 设置 off 则可以禁用工作区功能

export GOWORK=off

到此这篇关于Go1.18 新特性之多模块Multi-Module工作区模式的文章就介绍到这了,更多相关Go多模块工作区模式内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！