如何配置VSCode适配golang/go项目的cmd模块开发环境

问题根因 #

Go官方源码库的src/cmd是独立于标准库的单独Go模块，单独打开该目录时，gopls（Go语言服务器）无法自动关联上层标准库模块的依赖和符号信息，因此会出现代码导航、符号搜索、错误提示全部失效的问题。

解决方案 #

方案1：直接在Go源码根目录工作（最简便） #

不要单独打开src/cmd目录，直接打开golang/go仓库的根目录，gopls会默认识别多模块结构，直接访问根目录下src/cmd路径内的代码，所有开发功能都可正常使用，无需额外配置。

方案2：单独打开cmd目录的配置方法 #

如果必须单独打开src/cmd目录，可通过Go工作区功能配置：

• 在src/cmd目录下新建go.work文件，写入以下内容：

go 1.17 // 可替换为你本地使用的Go版本
use .
use ../

• 打开VSCode设置，搜索gopls.experimentalWorkspaceModule，勾选开启该配置项
• 按快捷键Ctrl+Shift+P（Mac系统为Cmd+Shift+P），执行Go: Restart Language Server命令，重启语言服务后即可生效

异常排查 #

如果配置后仍不生效，可依次检查以下配置：

• 确认本地GOROOT环境变量配置正确，指向你使用的golang/go源码根目录
• 执行Go: Install/Update Tools命令，重新安装gopls，确保工具版本与vscode-go插件匹配

验证方式 #

配置完成后打开任意src/cmd下的Go源码文件，使用符号搜索、跳转定义功能，可正常返回结果即为配置成功。

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