Go项目导入internal包提示不在GOROOT的问题解决

问题描述 #

我用Go语言开发小型项目，将全局变量放在独立的internal/global包中，目录结构如下。在image.go中导入该包时编辑器提示package comento/works/internal/global is not in GOROOT，但包内变量能正常使用。已经创建go.mod并执行过go mod tidy，请问怎么解决？

项目目录树 #

works
.
├── README.md
├── file
├── go.mod
├── go.sum
├── index
│   └── index.html
├── internal
│   └── global.go
├── main.go
└── pkg
    ├── api
    │   └── image.go
    └── router
        └── router.go

相关代码片段 #

image.go中的导入语句

import "comento/works/internal/global"

go.mod内容

module comento/works

go 1.19

require github.com/gin-gonic/gin v1.8.2

解决方案 #

• 检查编辑器Go语言服务配置
  多数编辑器的Go插件（如VS Code的Go插件）可能未正确识别项目的模块根目录：

  1. 打开编辑器设置，确认Go相关配置中，go.gopath未强制指向GOROOT的src目录，确保插件优先使用项目本地的go.mod
  2. 重启Go语言服务，VS Code可通过快捷键Ctrl+Shift+P（Windows/Linux）或Cmd+Shift+P（Mac）调出命令面板，执行Go: Restart Language Server

• 调整项目存放路径
  Go模块模式下无需将项目放在GOROOT/src或GOPATH/src目录中。当前项目放在/usr/local/go/src/comento/works下，可能导致编辑器混淆模块路径与GOROOT路径。将项目移到任意非GOROOT/GOPATH的路径下，重新打开项目即可。

• 清理缓存并重做模块初始化

  1. 删除项目根目录下的go.sum文件
  2. 重新执行go mod tidy，让Go重新生成依赖信息
  3. 清理编辑器的缓存（如VS Code可执行Developer: Reload Window）

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