VsCode Go插件配置最佳实践指南

VsCode Go插件配置最佳实践指南

VsCode Go插件工作原理

VsCode Go的正确安装方式

VsCode Go插件依赖的工具

go tools

go path配置

go mod相关

VsCode Go插件在Go项目中的正确配置

如何运行

如何Debug

VsCode Go插件的那些常用快捷

写在最后

求关注

VsCode Go插件工作原理

原理

VsCode Go插件的工作原理与其它的ide是不一样的,比如idea(goland),它是通过一系列go的小工具来完成ide的相关功能。比如智能提示,代码导航(查看引用,查看源码,查看接口),符号搜索,括号匹配,代码段之类的语言功能等。

但是如果是启用了go language server,那就是用的vscode的lsp来工作的,不是用go的小工具,推荐大家用go language server.

为什么你的VsCode Go插件不能正常工作

那些插件所依赖小工具如果不能正确工作(比如没有正确安装,比如版本不对,go path不对,没有下载成功),你的VsCode Go插件不能工作。

VsCode Go的正确安装方式

先从扩展管理中安装Go插件

VsCode Go插件依赖的工具

安装Go插件所依赖的go tools

按ctrl+shift+p 调出命令面板,输入go install tools 选Go: Install/Update Tools

go tools


这个阶段可能会失败。

很多人就卡在这一步就进行不下去了。这个得自己想一下办法。网上现在的办法都是让你去下载下来放到某个目录,心智负担太大还容易搞错。

我介绍2个方法

方法1:开国外vpn或者代理,让它安装成功。

方法2:设置go proxy.

go env -w GOPROXY=https://goproxy.cn清空缓存 go clean --modcache

go path配置

gopath直接在环境变量中设置就可以了,不用单独在vscode中设置。

关于go path的设置,还有一个问题,就是要不要设置2个的问题。

设置2个的目的是为了将工程放在第二个gopath下面,第一个是放go get的

在设置2个的时候,执行go get的会默认下载到一个gopath,但这个对于vscode来说可能会有点问题。

vscode中可以为在vscode中安装的go tools设置一个单独的目录具体设置项为 Tools Gopath,使用ctrl+, 然后输入tools gopath ,在下方填你想独立存放刚才第二步安装的工具的存放的地方了。

Go: Tools GopathLocation to install the Go tools that the extension depends on if you don't want them in your GOPATH.

go mod相关

如果你现在使用了go mod模式,就不用纠结配置几个gopath的问题,只配置一个就好了。vscode的go mod支持需要启用language server按ctrl+, (注意是ctrl + 英文状态的逗号)调出配置界面,输入go.lang

把 Use Language Server设置选中状态即开启了gopls了,这时vscode就会很好的支持go mod类型的项目了。

VsCode Go插件在Go项目中的正确配置

如何运行

如果是一个单独的main.go这种,现在你的vscode应该可以工作了,但是在工程里面可能不行。

工程一般有2种 结构

一种是有src目录,就是go 代码放在工程目录下面的src目录下面,这就可能会导致一些项目不能正确加载,比如非go mod项目。

这时候在工程目录下面建一个.vscode目录,然后在.vscode目录下面创建.settings.json文件

在里面设置gopath

如果你的main包不在src目录下面,则需要设置cwd,也就是工作时切换到的目录

这时候可以选中你的main.go,按ctrl+F5,start Without Debuging,开始运行了.

说一点,如果是go mod的工程,这个gopath就不需要配置了.

如何Debug和运行

vscode里面正常的工程项目main包一般在cmd下面,不同的项目可能不同,但一定有一个main包。

选中你的main.go,按F5,这时就会弹出一个需要创建launch.json,点create a launch.json,直接默认的选中go,就会在.vscode目录下生成一个launch.json文件

生成的launch.json如下

这时候一般的程序都可以开始调试了,但是如果你的main.go启动是需要一些配置文件话,需要配置一个cwd的属性.

cwd - current working directory for finding dependencies and other files

加上cwd的属性如下


到此,设置好断点,选中入口文件,按F5就可以进入debug了,然后f10单步之类的快捷键,可以看界面上的提示,自己点几下就知道好玩了.

VsCode Go插件的那些常用快捷

ctrl+p 文件搜索快捷键

ctrl+shift+p 命令快捷键

ctrl+shift+k 删除一行

alt+左方向键 回到上一次编辑的地方

ctrl+鼠标左键,跳到方法定义的地方

写在最后

要不要切换到vscode,这个不重要,重要的是你选择一个ide并灵活熟练使用它.还有,最后,尽量不要使用破解版本的idea(goland).

求关注

做服务端开发已经有十多年了,熟悉java,golang,Python,对大数据和机器学习,也有一些钻研,欢迎关注和交流。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容