在 Visual Studio Code 中使用 Go
通过使用 Visual Studio Code 的 Go 扩展,您可以获得 IntelliSense、代码导航、符号搜索、测试、调试等许多功能,这些功能将帮助您进行 Go 开发。
您可以从 VS Code Marketplace 安装 Go 扩展。
观看 “VS Code Go 入门”,了解如何使用 VS Code Go 构建您的第一个 Go 应用程序。
本文仅描述了 Go 扩展提供的功能子集。有关支持功能的完整、最新列表,请参阅扩展的文档。
IntelliSense
IntelliSense 功能由 Go 团队维护的 Go 语言服务器 gopls 提供。您可以使用 gopls
设置来配置 gopls
的行为。
语义语法高亮
为了获得比默认基于 TextMate 的语法高亮更好的效果,我们建议通过打开 Gopls 的 ui.semanticTokens
设置来启用语义高亮。
"gopls": { "ui.semanticTokens": true }
自动补全
当您在 Go 文件中键入时,您会看到 IntelliSense 为您提供建议的补全。这甚至适用于当前包、已导入包和尚未导入包中的成员。只需键入任何包名后跟 .
,您就会得到相应包成员的建议。
提示:使用 ⌃Space (Windows、Linux Ctrl+Space) 手动触发建议。
悬停信息
将鼠标悬停在任何变量、函数或结构体上,都会显示该项的信息,如文档、签名等。
签名帮助
当您在调用函数时打开 (
,会弹出一个窗口,提供该函数的签名帮助。当您继续键入参数时,提示(下划线)会移动到下一个参数。
提示:当光标在函数调用的
()
内时,使用 ⇧⌘Space (Windows、Linux Ctrl+Shift+Space) 手动触发签名帮助。
代码导航
代码导航功能可在编辑器的上下文菜单中找到。
- 转到定义 F12 - 跳转到类型定义的源代码。
- 转到类型定义 - 跳转到定义符号的类型。
- 速览定义 ⌥F12 (Windows Alt+F12, Linux Ctrl+Shift+F10) - 弹出一个包含类型定义的速览窗口。
- 转到引用 ⇧F12 (Windows、Linux Shift+F12) - 显示该类型的所有引用。
- 显示调用层级 ⇧⌥H (Windows、Linux Shift+Alt+H) - 显示来自或去往某个函数的所有调用。
- 转到实现 ⌘F12 (Windows、Linux Ctrl+F12) - 弹出一个速览窗口,列出某个接口的所有实现(如果用接口类型符号触发),或某个类型实现的接口(如果用具体类型符号触发)。
- 查找所有实现 - 显示一个接口的所有实现(如果用接口类型符号触发),或一个类型实现的所有接口(如果用具体类型符号触发)。
您可以使用命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中的转到符号命令通过符号搜索进行导航。
- 转到文件中的符号 - ⇧⌘O (Windows、Linux Ctrl+Shift+O)
- 转到工作区中的符号 - ⌘T (Windows、Linux Ctrl+T)
您还可以使用 Go: 切换测试文件命令在 Go 文件及其测试实现之间来回导航。
构建与诊断
Go 语言服务器 (gopls
) 会检测工作区中的构建和审查错误。运行上述任何/所有操作产生的错误和警告将在编辑器中以红色/绿色波浪线显示。这些诊断信息也会显示在问题面板(视图 > 问题)中。
您可以使用 go.lintOnSave
设置添加额外的 lint 检查,并使用 go.lintTool
设置配置您选择的 lint 工具(staticcheck
、golangci-lint
或 revive
)。
格式化
您可以使用 ⇧⌥F (Windows Shift+Alt+F, Linux Ctrl+Shift+I) 或通过命令面板或编辑器中的上下文菜单运行格式化文档命令来格式化您的 Go 文件。
默认情况下,当您保存 Go 文件时会运行格式化。您可以通过为 [go]
语言标识符将 editor.formatOnSave 设置为 false
来禁用此行为。您可以使用您的 JSON 配置文件更改此设置。
"[go]": {
"editor.formatOnSave": false
}
当您为 Go 文件激活了多个格式化程序时,您可以选择 Go 扩展作为默认格式化程序。
"[go]": {
"editor.defaultFormatter": "golang.go"
}
格式化由 gopls
提供。如果您想要 gofumpt
风格的格式化,您可以配置 gopls
使用 gofumpt
。
"gopls": {
"formatting.gofumpt": true
}
测试
VS Code 的测试 UI和编辑器的CodeLens元素允许用户轻松地为给定的函数、文件、包或工作区运行测试、基准测试和性能分析。
此外,相同的功能也可以通过一组命令实现
有许多与测试相关的命令,您可以在命令面板中键入“Go: test”进行探索。
以上前三个命令可用于使用 gotests
为当前包、文件或光标处的函数生成测试骨架。后几个命令可用于使用 go test
在当前包、文件或光标处运行测试。还有一个用于获取测试覆盖率的命令。
您可以配置扩展以运行测试和计算测试覆盖率,使用
go.testOnSave
go.coverOnSave
go.testFlags
导入包
该扩展默认会整理导入并移除未使用的导入。如果需要不同的行为,您可以按照这些说明覆盖特定语言的默认设置。
运行命令 Go: 添加导入以获取可以导入到您的 Go 文件中的包列表。选择一个,它将被添加到您的 Go 文件的导入块中。
重构
选择要重构的区域(例如变量、函数体等)。点击出现在所选区域的代码操作灯泡图标,或从 VS Code 上下文菜单中选择重构... 或重命名符号 (F2)。
调试
Go 扩展允许您利用 Delve 调试器来调试 Go 代码。
请阅读在 VS Code 中调试 Go 程序,了解设置步骤、支持的功能、配置、远程调试信息以及故障排除指南。对于通用的调试功能,如检查变量、设置断点和其他与语言无关的活动,请查阅 VS Code 调试。
一些 Go 独有的功能是
- 本地和远程调试
- 使用 Delve 的表达式语法进行数据检查
- 通过调试控制台的
dlv
命令实现动态配置更改和检查选项 - 能够隐藏/显示系统 goroutine(使用
hideSystemGoroutines
配置) - 反汇编视图支持(右键单击您的源代码并选择打开反汇编视图)
- 实验性的函数调用、核心检查、Mozilla
rr
支持
后续步骤
这是对 VS Code 中 Go 扩展功能的简要概述。更多信息,请参阅 Go 扩展 README 中提供的详细信息。
要了解 Go 扩展的最新功能/错误修复,请参阅 CHANGELOG。
如果您有任何问题或功能请求,请随时在 Go 扩展的 vscode-go 仓库中记录它们。
如果您想了解更多关于 VS Code 的信息,请尝试以下主题: