[TOC]
注意:本文档默认已经安装好go语言环境且已经设置好相应环境变量
1. 安装vscode
根据自身系统下载相应环境的vscode并安装
下载地址:点击此处前往下载
2. 安装go扩展插件
在vscode的插件商店里可以直接下载go语言的相关插件,可采用以下几种方式
- 新建一个后缀为.go 的后缀文件,此时vscode会自动弹出提示问是否需要安装扩展,点击安装即可
- 点击左侧第五个菜单栏,即可进入vscode插件商店,输入
go
后搜索,选搜索结果第一个安装即可
- 输入
Ctrl+Shift+X
或Cmd+Shift+X
打开vscode扩展商店,同上一种方法输入go
后搜索,选搜索结果第一个安装即可
3. 安装go tools工具
当vscode go语言扩展插件装好后,打开go文件会弹出如下提示
点击上边的安装全部即可,如果没有弹出该提示,也可点击右下角的Analysis Tools Missing
,然后同意安装即可。这几个工具的主要作用如下:
- go-outline
go get -u -v github.com/ramya-rao-a/go-outline
解析go文件中的函数定义,结构体定义,依赖的包等信息并以json格式的数据输出,用于生成符号表
- go-symbols
go get -u -v github.com/acroca/go-symbols
搜索指定目录的符号表中指定的符号
- gocode
go get -u -v github.com/nsf/gocode
自动填充提示
- godef
go get -u -v github.com/rogpeppe/godef
寻找指定符号在go文件中的位置
- godoc
go get -u -v golang.org/x/tools/cmd/godoc
根据源码注释生成文档
- gogetdoc
go get -u -v github.com/zmb3/gogetdoc
解析go源码,收集注释的位置,类似于go-outline,从而到达在文件中直接定位注释位置的目的
- golint
go get -u -v github.com/golang/lint/golint
类似pylint,用以检查代码规范
- gomodifytags
go get -u -v github.com/fatih/gomodifytags
提供tags管理,可以对struct的tag增删改
- gopkgs
go get -u -v github.com/uudashr/gopkgs/cmd/gopkgs
列出可导入的包列表,主要用于包导入时的提示功能
- gorename
go get -u -v golang.org/x/tools/cmd/gorename
用于安全的修改名称(对引用到的地方也同步修改)
- gotests
go get -u -v github.com/cweill/gotests/...
用于用例测试
- goreturns
go get -u -v sourcegraph.com/sqs/goreturns
当函数定义有返回值但返回值未设置时,自动添加返回对应类型的默认值
- guru
go get -u -v golang.org/x/tools/cmd/guru
代码编辑器集成工具,用于智能显示一些提示
- impl
go get -u -v github.com/josharian/impl
自动生成接口实现代码框架的工具,比如impl ‘f *File’ io.ReadWriteCloser 会自动出现io.ReadWriteCloser需要实现的接口
- go play
go get -u -v github.com/haya14busa/goplay/cmd/goplay
可以理解为https://play.golang.org/ 的一个客户端,可以将代码发送到https://play.golang.org/执行
以上工具都已经被golang扩展插件集成进去了,不需要自己手动去使用,只需要通过配置控制即可,具体的配置项可参考后面的 配置项目工程
有些工具第一次安装可能会失败,后面会给出详细的原因,大都是因为依赖库被墙的原因,如图所示:
从错误原因可以看出,无法下载的库都是golang.org/x/tools
, 这是因为golang.org被墙的原因,此时最好的方案是翻墙,如果没有翻墙条件,由于go语言开发者将这些库在github上做了镜像,我们也可直接去github上手动下载这些库,具体操作如下:
1. 前往go语言的github官方仓库,选择所需要的库手动下载或通过,此处我们缺的是tools库,因此下载tools即可](https://github.com/golang,选择所需要的库下载,此处我们缺的是tools库,因此下载tools即可)
2. 在GOPATH的src目录下,新建golang.org/x/tools的目录,可将tools软链接到下载的tools目录,也可直接将下载的tools目录放到golang.org/x目录下
3. 再次安装go tools工具,此时如无意外剩下的几个包已经可以成功安装
4. 安装delve调试工具
golang官方推荐的调试例子默认为gdb,但是gdb调试go程序会遇到goroutine的各类问题,因此现在一般推荐用delve,安装方法如下:
- 对于windows系统,直接使用
go get
即可
$ go get github.com/derekparker/delve/cmd/dlv
- 对于linux系统也类似,只不过get安装后可再将二进制文件拷贝到系统bin目录
$ go get github.com/derekparker/delve/cmd/dlv
$ cd github.com/derekparker/delve
$ make install
- mac系统有两种方式,第一种是直接通过brew安装
$ brew install go-delve/delve/delve
但是这种方式目前不支持mac最新的macOS 10.13,第二种方式同上,直接通过go get
方式安装,只不过安装前需要先安装xcode的develop tools
$ xcode-select --install
$ go get -u github.com/derekparker/delve/cmd/dlv
$ cd github.com/derekparker/delve
$ make install
5. 配置项目工程
go语言扩展插件有许多个性化配置,可以通过首选项设置-->设置
看到所有支持的设置项,如下图
当需要修改配置项时,只需要在右边的用户设置或工作区设置中填入即可覆盖默认配置,用户设置和工作区设置的区别在于,如果想要配置项针对所有的包括未来新建的工程都生效,那么配置在用户设置,如果仅仅需要针对当前工程进行设置,那么写入工作区设置。这里简单介绍几个配置项。
{
"go.buildOnSave": "workspace",
"go.lintOnSave": "workspace",
"go.vetOnSave": "workspace",
"go.buildFlags": [],
"go.lintFlags": [],
"go.vetFlags": [],
"go.coverOnSave": false,
"go.useCodeSnippetsOnFunctionSuggest": false,
"go.formatOnSave": true,
"go.formatTool": "goreturns",
"go.goroot": "C:/Go",
"go.gopath": "C:/gopath"
}
- go.buildOnSave: 当保存时自动编译,可选项为 ‘workspace’、‘package’、‘off',分别表示自动编译工作区,自动编译包和关闭
- go.lintOnSave: 当保存时静态检查,可选项为'workspace'、'package'、‘off’,含义同上
- go.vetOnSave
- go.buildFlags: 编译选项
- go.lintFlags: 代码静态检查选项
- go.coverOnSave: 若为true,将自动使用
go test -coverprofile
执行用例测试 - go.useCodeSnippetsOnFunctionSuggest 是否自动填充函数参数以及括号等
- go.formatOnSave: 保存时自动格式化代码
- go.formatTool: 格式化代码时使用的插件工具,可选项为
gofmt
,goimport
,goreturns
- go.goroot: 设置GOROOT环境变量,当环境变量已经设置时可不配置
- go.gopath: 本配置项将覆盖环境变量中的GOPATH,需要格外注意