如何让v2+版本的Go模块避免导入路径前缀的要求？

Question

这是特定于：https://github.com/twitchtv/twirp

这个库目前在v7版本上，我们希望将它移植到go模块中。该库当前是从其他库导入的，如下所示：

// go.mod
require github.com/twitchtv/twirp v7.2.0+incompatible

// .go code
import "github.com/twitchtv/twirp"

如果我们在库中添加一个go.mod文件，现在每个其他库都被强制更改导入路径，如下所示：

// go.mod
require github.com/twitchtv/twirp v7.2.0

// .go code
import "github.com/twitchtv/twirp/v7"

如何在不强制其他库更新其导入路径的情况下迁移Twirp库以使用go模块？

这里的主要问题是，单个服务可能会导入在不同版本上生成的多个Twirp客户端，并使用依赖于特定类型的助手函数。强制导入路径更新将强制所有这些帮助器函数都需要管理新旧类型，并且我们不能为所有类型创建别名(有些类型是函数)。这将创建一个升级锁。这是否意味着Twirp库需要永远保持+incompatible模式？

Answer 1

如何在不强制其他库更新其导入路径的情况下迁移Twirp库以使用go模块？

你不能这么做。

如果您的go.mod将模块声明为github.com/twitchtv/twirp/v7，那么每个客户端库(以及您自己的包)都必须更新导入路径。这就是语义导入路径在Go模块中的工作方式。

如果你使用v1或v0模块路径-没有后缀-你就违反了semver契约，因为你的项目实际上已经有了v7标签。

这里的主要问题是，单个服务可能会导入在不同版本上生成的多个Twirp客户端

迁移到Go模块以一种干净的方式显式地解决了这个问题，即导入项目的多个版本的客户端只需将导入声明为github.com/twitchtv/twirp/vX等，从而在.go文件中立即清楚地知道它们使用的是什么版本。

实际上，您有一个非常简单的方法来处理这个问题。只需迁移到Go模块，声明您的模块具有下一个主要版本后缀github.com/twitchtv/twirp/v8，然后将其标记为v8.x.y。从另一个角度来看，这是正确的，因为您的更改确实正在破坏-您的客户端必须更改导入路径。

这样，想要迁移到您的Go模块版本的客户端将知道预期会发生什么，并处理切换到新的主要版本的影响，包括重写导入路径。而不想迁移的客户端可以继续以+incompatible的形式导入v7.x.y (或更少)。