Go服务单体仓库(Monorepo)中跨服务导包的正确配置方法

问题背景 #

拥有路径为github.com/myself/monorepo的单体仓库，包含service-one和service-two两个服务，各服务独立维护go.mod文件。

service-one代码定义 #

package service-one // 非法包名

type StructOne { // 缺少struct关键字

}

service-two导入尝试 #

package service-two // 非法包名

import pack "github.com/myself/monorepo/service-one"

func MyFunc() {
    var v pack.StructOne
}

失败的引用方式及错误 #

在service-two的go.mod中尝试两种引用均报错：

1. 引用临时提交：

require github.com/myself/monorepo/service-one 38e00c33c01a9ac17c177ba25e9764c4d1c1310f

2. 引用标签版本：

require github.com/myself/monorepo/service-one v0.0.0

错误信息：

not found: github.com/myself/monorepo/service-one@v0.0.0 invalid version: git ls-remote -q origin in /tmp/gopath/pkg/mod/cache/vcs/...
   fatal: could not read Username for 'https://github.com': terminal prompts disabled

核心问题与修复步骤 #

1. 修正基础语法错误 #

• Go包名禁止包含连字符，将service-one和service-two的包名改为合法标识符（如serviceone、servicetwo）
• 补全结构体定义的struct关键字：type StructOne struct {}

2. 调整Monorepo的Go模块结构 #

Monorepo下应维护单一根Go模块，而非子服务独立模块，操作如下：

• 删除service-one和service-two目录下的go.mod文件
• 在monorepo根目录执行初始化命令：

go mod init github.com/myself/monorepo

3. 正确导入子服务包 #

在service-two中使用根模块路径导入service-one：

package servicetwo

import pack "github.com/myself/monorepo/service-one"

func MyFunc() {
    var v pack.StructOne
}

4. 版本引用规则 #

若需引用特定版本，直接在monorepo根仓库打标签（如v1.0.0），然后在依赖项目的go.mod中引用整个根模块：

require github.com/myself/monorepo v1.0.0

5. 解决GitHub身份验证问题 #

错误中的身份验证失败是私有仓库下载依赖的常见问题，两种解决方式：

• HTTPS凭证配置：保存GitHub个人访问令牌（PAT）到git凭证：

git config --global credential.helper store
# 执行git pull，输入GitHub用户名和PAT，凭证将永久保存

• 切换SSH协议：修改仓库远程地址为SSH格式：

git remote set-url origin git@github.com:myself/monorepo.git

内容的提问来源于stack exchange，提问作者Yura