在 monorepo 中的子目录中设置 Go vanity 导入 URL 的方法

今日不肯埋头，明日何以抬头！每日一句努力自己的话哈哈~哈喽，今天我将给大家带来一篇《在 monorepo 中的子目录中设置 Go vanity 导入 URL 的方法》，主要内容是讲解等等，感兴趣的朋友可以收藏或者有更好的建议在评论提出，我都会认真看的！大家一起进步，一起学习！

我正在使用一个按顶层语言组织的 monorepo，因此所有 go 模块都位于存储库根目录中的 go 目录中。我想设置一个指向 go 目录而不是存储库根目录的虚荣导入 url，以便 go/ 不需要包含在导入路径中。

当前文件结构：

/
  go/
    module1/
    module2/

所需的导入格式：

import (
    "go.example.com/module1"
    "go.example.com/module2"
)

目前可以，但不需要：

import (
    "go.example.com/go/module1"
    "go.example.com/go/module2"
)

根据文档，go.example.com 中的 元素的格式应为以下形式：

<meta name="go-import" content="import-prefix vcs repo-root">

所以在这种情况下我会：

<meta name="go-import" content="go.example.com git github.com/example/repo">

这会将 import-prefix 后面的路径转换为相对于存储库根目录的路径，以便 go.example.com/this/path 在存储库中查找 this/path 目录。我希望路径相对于存储库中的 go 目录而不是存储库根目录。

有什么方法可以告诉go get go.example.com后面的路径应该相对于github.com/example/repo/go，而不仅仅是github.com/example/repo？

正确答案

不是直接的，但有解决方法。

来自 this issue in golang/go：

[...] 目前，https 服务器无法指示该模块由前缀 src/go 偏移，因为它不是 go 包路径的一部分。此布局不适用于 go 命令的内置 git 支持。

借助 go 命令的内置 git 支持，导入规范以存储库的 url 开头，后跟所需包的路径。因此路径必须相对于存储库根目录。使用虚荣导入路径，您可以根据需要使路径更长，但不能更短（例如example.com/pkg）。

因此，以下是没有解决方法的最短可能导入路径：go.example.com/go/。

解决方法

献给真正奉献的人。

这些涉及一些设置和额外的处理，并且仅仅为了导入路径的美观可能不值得。

我已经制定了两种方法（其中一种半解决方案可能不适用于大量模块）。第一个是设置模块代理。第二个是创建另一个从 go 目录复制并从那里导入的存储库。

在 go.mod 中使用 replace

这个非常简单，您可以将基本导入路径设置为您喜欢的任何内容，只需将其 go.mod 文件中的 replace 即可。

缺点是，管理许多相互依赖的模块会变得复杂（如下一节的链接文章中所述）。也感觉不那么特别，负担是在导入项目上设置，而不是导入项目。

go 模块代理

This article(gist) 很好地解释了该方法。

go get 使用 goproxy 环境变量来决定在哪里查找和解析包。基本思想是设置一个代理服务器，该服务器知道如何翻译公共模块名称并从实际存储库获取相关代码，然后将该服务器的 url 放入 goproxy 变量中。

对于私有模块/存储库，需要格外小心，因为您还必须处理身份验证。

复制 git 存储库

最后一种方法是将 go 目录的内容复制到另一个存储库，该存储库可以使用 github actions 或类似工具实现自动化。

要保留版本标记（如果使用）和分支（尽管不提交哈希值），您可以使用 git filter-repo 重写历史记录，以便 go 目录实际上是包根目录（并且始终如此）： git filter-repo --子目录过滤器 go/。

然后只需将虚荣 go-import 标记设置为：

<meta name="go-import" content="go.example.com git github.com/example/repo-go">

（原始存储库为 github.com/example/repo）。

到这里，我们也就讲完了《在 monorepo 中的子目录中设置 Go vanity 导入 URL 的方法》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！