多程序GOPATH仓库转Go Modules及VSCode调试问题排查

现有仓库结构 #

当前为旧式GOPATH结构的Git仓库，包含多个带独立入口的工具程序与公共共享代码，目录结构如下：

progOne\main.go (含其他业务代码，部分存放在子目录)
progTwo\main.go (含其他业务代码，部分存放在子目录)
progThree\main.go (含其他业务代码，部分存放在子目录)
common\net\ (存放Go共享代码，无main入口)
common\colors\ (存放Go共享代码，无main入口)
common\resources\ (存放Go共享代码，无main入口)

单仓多可执行文件的go.mod配置规则 #

• 完全可以将所有代码保留在同一个Git仓库中，构建生成多个独立可执行文件，这是Go Modules原生支持的单仓多二进制开发模式。
• 常规使用场景下仅需在仓库根目录创建1个go.mod文件即可，所有程序目录、common下的共享包目录都归属于根go.mod声明的模块，不需要在子目录额外创建go.mod文件。
• 仅当需要为某个子目录的包/程序单独打版本、独立发布、允许其他仓库脱离当前根模块单独引用时，才需要在对应子目录创建独立go.mod作为子模块，当前迁移场景不需要该配置。

同仓包导入调试报错修复 #

根目录创建go.mod后，VSCode调试progOne时出现no required module provides package git.acme.com/myRepo/common/colors报错，执行go mod tidy、go get均无效，可按以下步骤修复：

1. 校验根目录go.mod的模块声明
   根目录go.mod第一行声明的模块路径，必须和代码中导入本地包使用的路径前缀完全匹配。如果代码中导入common包的路径为git.acme.com/myRepo/common/colors，则go.mod第一行必须严格写为：

   module git.acme.com/myRepo
   
   go 1.xx // 替换为本地实际使用的Go版本
   

   模块路径写错（比如简写为module myRepo、写错仓库域名）是导致本地包被识别为外部远程包的最常见原因。
2. 修正VSCode调试启动配置
   原配置中program字段指向单个main.go文件，在依赖同仓其他包时会触发构建路径识别错误，需要将该字段改为progOne所在的目录路径，修正后的配置如下：

   {
      "name": "Launch Package",
      "type": "go",
      "request": "launch",
      "mode": "debug",
      "program": "${workspaceFolder}/progOne",
      "buildFlags": ""
   }
   

3. 校验VSCode工作区打开路径
   必须将go.mod所在的仓库根目录作为VSCode工作区根目录打开，不要单独打开progOne或common等子目录作为工作区，否则Go工具链无法识别到根目录的go.mod文件，会误将本地包判定为外部依赖。
4. 以上配置校验完成后，在仓库根目录重新执行go mod tidy即可自动整理本地依赖，无需手动执行go get拉取本地包。如果仍有缓存类报错，可执行go clean -modcache清理模块缓存后重试。

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