使用 VS Code 快速搭建你的 Golang 开发 IDE

发表于 | 更新于:

说到 IDE 我们想到的都是 Intellij 和 Eclipse系列这样的几百兆的桌面应用程序，它让我们编程效率得以很大提升，在日常工作中变得离不开这些软件。我们最喜欢用的 IDE 功能主要有：

  • 代码自动补全
  • 代码重构
  • 代码格式化
  • 代码调试
  • 代码高亮
  • 代码错误检查
  • 代码引用查询与跳转

但往往 IDE 也有占用内存多，时不时反应卡顿等问题。因此很多程序员在开发一些动态语言、脚本语言的时候更倾向于选择轻量级的文本编辑器软件。如：Sublime Text、Atom 、vscode（Visual Studio Code 简称 vscode）。其实不仅仅是动态语言或者脚本语言，现在的文本编辑器已经基本包含了上述 IDE 配置的功能了，除开在代码重构方面还落后甚远之外，其他功能点已经差别不大了。
纵观前两年最流行文本编辑器的还是 Sublime Text，而当下最新，最火热，最好用的我认为还得属于 vscode。为什么 vscode 能够在Sublime Text 和 Atom 两位前辈面前打下一片天地？如果用一个最大的优势来描述的话：

  • 对于 Sublime Text， vscode 最大的优势是 UI 美观、功能全面，比如集成了代码调试、Git 代码变更查和更友好的插件安装功能
  • 而相较于 Atom 而言，vscode 比它的同门师兄最大的优势则是快。

就我自己日常开发而言，除开 Java 以外，平时编写 Ruby、JavaScript、HTML、Vue.js、Golang、Markdown、Dockerfile 等语言都在使用 vscode。

在这篇文章中我不会再对为什么要用 VS Code 做过多解释。而是将介绍使用 vscode 快速搭建一个优秀的 Go (Golang) 的开发环境。

安装 vscode

说了 vscode 这么多好，如果你还不知道 vscode 是何物的话，这里简单介绍下。vscode 是微软基于 Electron 框架开发的跨平台的开源的文本编辑器。也许你曾用过它的兄弟 Visual Studio，被它的庞大和臃肿吓到，在这里却不用担心。vscode 是一个全新的项目，旨在打造一个轻量级、面向 Web 开发、稳定高效的开发平台。

你可以通过 https://code.visualstudio.com 官网下载安装 vscode软件

安装 Go 插件

安装

vscode 之所以强大，其中很大一点便是因为它拥有庞大的插件对各个语言提供相关的功能。而对于 Go,官方提供了强大的插件 Go。你可以直接通过在插件页面，输入搜索 Go 进行安装相关插件，安装之后对 vscode 进行重启。该插件对 Golang 支持非常丰富的功能：

  • 代码格式化
  • 保存时代码自动格式化
  • 自动添加 Imports
  • 代码错误提示
  • 引用查询与跳转到定义位置
  • Go 代码元素搜索
  • 文档查看
  • 支持代码调试等等功能。

这些可以功能可以很好的满足我们日常开发所需。

配置

Go 插件提供丰富的配置项，让我们对插件的默认行为进行调整，以便最大限度的适合每个人。
依次键入F1 -> Open User Settings 即可打开vscode 用户配置文件，在文件末尾可以添加类似如下属性。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
"go.buildOnSave": true, //在保存代码时自动编译代码
"go.lintOnSave": true, //在保存代码时自动检查代码可以优化的地方，并给出建议
"go.vetOnSave": true, //在保存代码时自动检查潜在的错误
"go.buildTags": "",
"go.buildFlags": [],
"go.lintTool": "golint", //使用 golint 库来执行 lint操作，你也可以选择使用gometalinter
"go.lintFlags": [],
"go.vetFlags": [],
"go.coverOnSave": false, //在保存代码时执行测试，并显示测试覆盖率
"go.useCodeSnippetsOnFunctionSuggest": true, //使用代码片段作为提示
"go.formatOnSave": true, //在保存代码时自动格式化代码
"go.formatTool": "goimports", //使用 goimports 工具进行代码格式化，或者使用 goreturns和gofmt
"go.formatFlags": [],
"go.gocodeAutoBuild": true, //代码自动编译构建
"go.goroot": "/usr/local/Cellar/go/1.8.3/libexec", //设置 goroot，正常编译 go 代码。
"go.gopath": "/Users/junv/gocode:/Users/junv/mygocode", // 设置 gopath，有利于自动导入库

使用

使用

调试 Go程序

打开 go 源码，在你期望调试的行号左侧，点击即可添加断点。
当你第一次进行调试时，vscode 则要求你添加调试程序的相关配置。可以输入类似下图的配置即可。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "monitor-api", //程序名字
            "type": "go",
            "request": "launch",
            "mode": "debug",
            "remotePath": "",
            "port": 1234,
            "host": "127.0.0.1",
            "program": "${workspaceRoot}",
            "env": {
                "QUICKPAY_ENV": "testing" //注入你需要的环境变量
            },
            "args": []
        }
    ]
}

点击开始按钮，即可进行Go 程序调试了。

debug

快速的搜索

当项目源代码越来越多，依赖的第三方库也越来越多的时候，你会发现 vscode的搜索功能 变慢了，而且很多时候我们并不希望搜索结果中包含 vendor （第三方依赖源代码）目录下的代码。
那么你可以尝试在User Settings 中添加如下的配置：

1
2
3
4
5
"search.exclude": {
  "**/node_modules": true,
  "**/bower_components": true,
  "**/vendor": true  //排除 vendor 目录
},

这样 vscode 在执行搜索的时候就会跳过 vendor 目录下的文件，让搜索保持高效。

如虎添翼的其他插件

IntelliJ IDEA Keybindings

如果你和我一样也是从 Intellij 系列 IDE 迁移过来，想必你也遇到快捷键不习惯的问题。推荐你安装IntelliJ IDEA Keybindings 插件。来映射快捷键，让你在 vscode 可以使用使用 Intellij 的快捷键。
如：

  • alt + F7 查看方法引用
  • ctrl + shift + ↑ 或者 ctrl + shift + ↓ 移动行
  • cmd + F4 关闭当前窗口
  • alt + cmd+ → 或者 alt + cmd+ ← 切换到前/后一次操作的鼠标位置了

更多的快捷键映射，可以查看该插件主页。

Code Runner

Code Runner 插件，让你可以快速你运行各种语言的代码片段。

在可运行的 go 文件页面，点击界面右上角的➤ 即可快速运行该文件。

code runner

概括

通过本篇文章可以看出，依赖于vscode 强大的插件我们可以快速搭建完善的 Go 语言开发环境。而它相较于 IDE 的最大优势则是性能良好、扩展性强、免费和轻量级。