探究vscode debug流程,解决无法运行go程序的问题

问题描述

vscode 无法以 run 模式运行 go 项目(只能以 debug 模式调试),并且有如下报错。

图中被遮盖的部分是项目内的 package,并非第三方 package,也就是说在以 run 模式运行 go 项目时无法找到其他的 go 文件,只能找到入口文件。

初步排查

找不到其他文件,首先想到的是 GO_PATH 的问题,但是项目使用了 go mod,允许在 GO_PATH 之外的路径创建项目,所以这个怀疑点排除。接下来怀疑 vscode 的配置有问题,每个 vscode 项目中都有 .launch.json 文件,配置运行代码时的环境,下面是项目中的 .launch.json。

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch",
            "type": "go",
            "request": "launch",
            "mode": "auto",
            "program": "${workspaceRoot}/src/main.go",
            "env": {},
            "args": []
        }
    ]
}

可以看到 .launch.json 里没有指定程序的工作目录,debug 模式和 run 模式会不会默认的工作路径不同呢?于是在 main 函数里使用 os.Getwd() 打印一下当前的路径,结果如下:

  • debug 模式:项目所在目录
  • run 模式:用户目录

基本可以确认,run 模式下的工作路径设置不正确,导致找不到路径。在 .launch.json 中加入 cwd 参数,手动填入项目路径。

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch",
            "type": "go",
            "request": "launch",
            "mode": "auto",
            "program": "${workspaceRoot}/src/main.go",
            "cwd": "${workspaceRoot}",
            "env": {},
            "args": []
        }
    ]
}

但是修改 .launch.json 后运行程序,输出的工作目录仍然是用户目录,cwd 参数并没有生效。

探究 vscode 的 debug 流程

至此,bug 的气息越来越浓厚,cwd 参数没有生效,肯定有问题!

一不做二不休,索性看看 vscode 的调试流程吧,用一个很暴力的方式,看看点击运行按钮后,vscode 到底是如何运行 go 程序的。

package main
import "time"
func main() {
    time.Sleep(10000000000)
}

运行程序后,使用 ps -ef|grep go 查看进程。

截图中三个进程从上到下均是父子关系,也就是说在 vscode 中即便使用 run 模式运行,也不是直接执行 go run xxxx.go,这与 Goland 等其他 IDE 的行为是不同的。vscode 首先调用了 language server 中的 node,执行了 go extention(vscode 的 go 扩展,安装后才支持 go 语言项目)中的一个 goDebug.js,而后 goDebug.js 中调用了 go run xxxx.go。(图中 /tmp 路径下的 main 文件是 go run 执行过程中生成的二进制文件)

接下来查看 goDebug.js 的逻辑,找到了调用 go run 的代码。

this.debugProcess = spawn(getBinPathWithPreferredGopath('go', []), runArgs, { env });

查看代码上面几行的逻辑,根据参数的命名,可以猜测出来,.launch.json 中的配置在这里是可以获取到的。接下来直接修改 js 文件,进行调试,证实上述的猜测,由于我们无法直接看到 node goDebug.js 的输出,所以通过写入文件的方式进行调试。

fs.writeFile('test.log', this.debugProcess.cwd(), function (err) {}

加入这句后再次运行,我们可以看到 test.log 文件中已经打印出了这个进程的工作路径,也就是 go run 的工作路径,是用户目录。至此,可以将问题缩小到:在 node 调用 go run 时没有将 .launch.json 文件中的 cwd 传给子进程(go run)。

spawn 是 nodejs 中的函数,看一下 spawn 的文档可以发现,spawn 有三个参数 child_process.spawn(command[, args][, options]) 第三个参数 options 中可以指定 cwd 工作路径。而 goDebug.js 这段启动子进程的代码并没有设置 cwd,只设置了env 参数,这就是 run 模式无法运行 go 程序的原因。

解决方案

在发现这个问题时,vscode go extention的最新版本是0.13,这个问题暂时只能通过修改 goDebug.js 的源码解决,如下图所示加入注释中的代码,将 cwd 参数传入子进程,就可以解决问题。

同时,这个 bug 已经被解决,可以参考 ISSUE #3096,程序员在解决另一个问题这个 ISSUE 的问题时,“顺手”把 cwd 的问题修复了。在 vscode go extention 0.14版发布后(已发布),将 go extension 更新到最新版就可以正常运行和调试 go 项目了。

参考资料

Debugging in Visual Studio Code

Node.js v13.13.0 Documentation

Debug: add "go run ." support #3096

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

推荐阅读更多精彩内容