引言

此文是系列文章的第 4 部分。

• 第 1 部分 — 使用 Go 模块
• 第二部分 — 迁移到 Go 模块
• 第三部分 — 发布 Go 模块
• 第 4 部分 — Go 模块：v2 及更高版本 (本文)
• 第五部分 — 保持模块兼容

注意： 有关开发模块的文档，请参阅 开发和发布模块。

随着一个成功的项目日趋成熟并增加新需求，过去的功能和设计决策可能会变得不再合理。开发人员可能希望通过删除已弃用的函数、重命名类型或将复杂的包拆分为可管理的部分来整合他们所学到的经验。这些类型的更改需要下游用户努力将其代码迁移到新的 API，因此不应在未仔细考虑收益是否大于成本的情况下进行。

对于仍处于实验阶段（主要版本 v0）的项目，用户会预期偶尔会出现破坏性更改。对于声明为稳定版本（主要版本 v1 或更高版本）的项目，破坏性更改必须在新版本中进行。本文探讨了主要版本语义、如何创建和发布新主要版本以及如何维护模块的多个主要版本。

主要版本和模块路径

模块正式确定了 Go 中的一个重要原则，即导入兼容性规则

If an old package and a new package have the same import path,
the new package must be backwards compatible with the old package.

根据定义，包的新主要版本与前一个版本不向后兼容。这意味着模块的新主要版本必须与前一个版本具有不同的模块路径。从 v2 开始，主要版本必须出现在模块路径的末尾（在 go.mod 文件中的 module 语句中声明）。例如，当模块 github.com/googleapis/gax-go 的作者开发 v2 时，他们使用了新的模块路径 github.com/googleapis/gax-go/v2。想要使用 v2 的用户必须将其包导入和模块要求更改为 github.com/googleapis/gax-go/v2。

需要主要版本后缀是 Go 模块与大多数其他依赖管理系统不同之处之一。后缀是解决菱形依赖问题所必需的。在 Go 模块之前，gopkg.in 允许包维护者遵循我们现在称为导入兼容性规则的原则。使用 gopkg.in，如果您依赖于导入 gopkg.in/yaml.v1 的包和导入 gopkg.in/yaml.v2 的另一个包，则不会发生冲突，因为这两个 yaml 包具有不同的导入路径——它们使用版本后缀，就像 Go 模块一样。由于 gopkg.in 与 Go 模块共享相同的版本后缀方法，Go 命令将 gopkg.in/yaml.v2 中的 .v2 视为有效的主要版本后缀。这是与 gopkg.in 兼容的特殊情况：托管在其他域的模块需要像 /v2 这样的斜杠后缀。

主要版本策略

推荐的策略是在以主要版本后缀命名的目录中开发 v2+ 模块。

github.com/googleapis/gax-go @ master branch
/go.mod    → module github.com/googleapis/gax-go
/v2/go.mod → module github.com/googleapis/gax-go/v2

这种方法与不了解模块的工具兼容：仓库中的文件路径与 GOPATH 模式下 go get 预期的路径匹配。这种策略还允许所有主要版本在不同目录中一起开发。

其他策略可能会将主要版本保留在不同的分支上。但是，如果 v2+ 源代码位于仓库的默认分支（通常是 master）上，则不了解版本的工具（包括 GOPATH 模式下的 go 命令）可能无法区分主要版本。

本文中的示例将遵循主要版本子目录策略，因为它提供了最大的兼容性。我们建议模块作者只要有用户在 GOPATH 模式下开发，就遵循此策略。

发布 v2 及更高版本

本文以 github.com/googleapis/gax-go 为例

$ pwd
/tmp/gax-go
$ ls
CODE_OF_CONDUCT.md  call_option.go  internal
CONTRIBUTING.md     gax.go          invoke.go
LICENSE             go.mod          tools.go
README.md           go.sum          RELEASING.md
header.go
$ cat go.mod
module github.com/googleapis/gax-go

go 1.9

require (
    github.com/golang/protobuf v1.3.1
    golang.org/x/exp v0.0.0-20190221220918-438050ddec5e
    golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3
    golang.org/x/tools v0.0.0-20190114222345-bf090417da8b
    google.golang.org/grpc v1.19.0
    honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099
)
$

要开始开发 github.com/googleapis/gax-go 的 v2 版本，我们将创建一个新的 v2/ 目录并将我们的包复制到其中。

$ mkdir v2
$ cp -v *.go v2
'call_option.go' -> 'v2/call_option.go'
'gax.go' -> 'v2/gax.go'
'header.go' -> 'v2/header.go'
'invoke.go' -> 'v2/invoke.go'
$

现在，我们通过复制当前的 go.mod 文件并向模块路径添加 /v2 后缀来创建 v2 go.mod 文件

$ cp go.mod v2/go.mod
$ go mod edit -module github.com/googleapis/gax-go/v2 v2/go.mod
$

请注意，v2 版本被视为与 v0 / v1 版本不同的模块：两者可以共存于同一个构建中。因此，如果您的 v2+ 模块有多个包，您应该更新它们以使用新的 /v2 导入路径：否则，您的 v2+ 模块将依赖于您的 v0 / v1 模块。例如，要将所有 github.com/my/project 引用更新为 github.com/my/project/v2，您可以使用 find 和 sed

$ find . -type f \
    -name '*.go' \
    -exec sed -i -e 's,github.com/my/project,github.com/my/project/v2,g' {} \;
$

现在我们有了 v2 模块，但我们想在发布版本之前进行实验和更改。在我们发布 v2.0.0（或任何没有预发布后缀的版本）之前，我们可以根据新 API 的决定进行开发和进行破坏性更改。如果我们希望用户能够在我们正式使其稳定之前试验新 API，我们可以发布 v2 预发布版本

$ git tag v2.0.0-alpha.1
$ git push origin v2.0.0-alpha.1
$

一旦我们对 v2 API 满意并确定不再需要任何其他破坏性更改，我们就可以标记 v2.0.0

$ git tag v2.0.0
$ git push origin v2.0.0
$

此时，现在有两个主要版本需要维护。向后兼容的更改和错误修复将导致新的次要版本和补丁版本（例如，v1.1.0、v2.0.1 等）。

结论

主要版本更改会导致开发和维护开销，并需要下游用户投入以进行迁移。项目越大，这些开销往往越大。只有在确定了令人信服的理由之后，才应进行主要版本更改。一旦确定了进行破坏性更改的令人信服的理由，我们建议在主分支中开发多个主要版本，因为它与更广泛的现有工具兼容。

对 v1+ 模块的破坏性更改应始终发生在新的 vN+1 模块中。当发布新模块时，这意味着维护者以及需要迁移到新包的用户会增加额外的工作。因此，维护者应在发布稳定版本之前验证其 API，并仔细考虑 v1 之后是否确实有必要进行破坏性更改。