VS Code golang 断点调试

朱雀 2022-02-20 08:56 455阅读 0赞

# 实现效果 #

![18.gif][]

# 安装 delve #

## windows ##

`go get -u github.com/go-delve/delve/cmd/dlv`

## linux ##

方式一：  
`go get -u github.com/go-delve/delve/cmd/dlv`  
方式二

$ git clone https://github.com/go-delve/delve.git $GOPATH/src/github.com/go-delve/delve
    $ cd $GOPATH/src/github.com/go-delve/delve
    $ make install

> 注意: 若果你go版本为1.5需要设置`GO15VENDOREXPERIMENT=1`

## OSX ##

$ go get -u github.com/go-delve/delve/cmd/dlv

执行上述代码前，确保你电脑上有编译工具

# 设置 launch.json 配置文件 #

`ctrl+shift+p` 输入 `Debug: Open launch.json` 打开 `launch.json` 文件，如果第一次打开,会新建一个配置文件，默认配置内容如下

{
    	"version": "0.2.0",
    	"configurations": [
    		{
    			"name": "Launch",
    			"type": "go",
    			"request": "launch",
    			"mode": "auto",
    			"program": "${fileDirname}",
    			"env": {},
    			"args": []
    		}
    	]
    }

常见属性如下

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>介绍</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td>调试界面下拉选择项的名称</td> 
  </tr> 
  <tr> 
   <td>type</td> 
   <td>设置为go无需改动，是 vs code 用于计算调试代码需要用哪个扩展</td> 
  </tr> 
  <tr> 
   <td>mode</td> 
   <td>可以设置为 <code>auto</code>, <code>debug</code>, <code>remote</code>, <code>test</code>, <code>exec</code> 中的一个</td> 
  </tr> 
  <tr> 
   <td>program</td> 
   <td>调试程序的路径（绝对路径）</td> 
  </tr> 
  <tr> 
   <td>env</td> 
   <td>调试时使用的环境变量。例如:<code>{ "ENVNAME": "ENVVALUE" }</code></td> 
  </tr> 
  <tr> 
   <td>envFile</td> 
   <td>包含环境变量文件的绝对路径，在 <code>env</code> 中设置的属性会覆盖 <code>envFile</code> 中的配置</td> 
  </tr> 
  <tr> 
   <td>args</td> 
   <td>传给正在调试程序命令行参数数组</td> 
  </tr> 
  <tr> 
   <td>showLog</td> 
   <td>布尔值，是否将调试信息输出</td> 
  </tr> 
  <tr> 
   <td>logOutput</td> 
   <td>配置调试输出的组件（<code>debugger</code>, <code>gdbwire</code>, <code>lldbout</code>, <code>debuglineerr</code>, <code>rpc</code>）,使用,分隔， <code>showLog</code> 设置为 <code>true</code> 时，此项配置生效</td> 
  </tr> 
  <tr> 
   <td>buildFlags</td> 
   <td>构建 go 程序时传给 go 编译器的标志</td> 
  </tr> 
  <tr> 
   <td>remotePath</td> 
   <td>远程调试程序的绝对路径，当 <code>mode</code> 设置为 <code>remote</code> 时有效</td> 
  </tr> 
 </tbody> 
</table>

## 在 debug 配置中使用 VS Code 变量 ##

*  $\{workspaceFolder\} 调试 VS Code 打开工作空间的根目录下的所有文件
 *  $\{file\} 调试当前文件
 *  $\{fileDirname\} 调试当前文件所在目录下的所有文件

## 使用构建标记(build tags) ##

如果需要使用构建标记（e.g. go build -tags=whatever\_tag）在参数 `buildFlags` 里写入 `-tags=whatever_tag"` 即可，支持多标签，使用单引号将标签包围,例如： `"-tags='first_tag second_tag third_tag'"`

# debug 配置代码片段 #

可以在 `launch.json` 文件中，使用 `Go` 关键词调出 `debug` 配置项的代码片段。

## 调试当前文件配置片段 ##

{
    	"name": "Launch file",
    	"type": "go",
    	"request": "launch",
    	"mode": "auto",
    	"program": "${file}"
    }

## 调试单个测试用例配置片段 ##

{
    	"name": "Launch test function",
    	"type": "go",
    	"request": "launch",
    	"mode": "test",
    	"program": "${workspaceFolder}",
    	"args": [
    		"-test.run",
    		"MyTestFunction"
    	]
    }

## 调试包中所有的测试用例配置片段 ##

{
    	"name": "Launch test package",
    	"type": "go",
    	"request": "launch",
    	"mode": "test",
    	"program": "${workspaceFolder}"
    }

## 调试构建二进制文件配置片段 ##

{
    	"name": "Launch executable",
    	"type": "go",
    	"request": "launch",
    	"mode": "exec",
    	"program": "absolute-path-to-the-executable"
    }

# 远程调试 #

远程调试需要在服务器上期一个无头的 `Delve` 服务  
例如：

$ dlv debug --headless --listen=:2345 --log --api-version=2

如果需要传给参数到程序中则需要将参数传入到 `Delve` 服务中  
例如：

dlv debug --headless --listen=:2345 --log -- -myArg=123

`launch.json` 配置如下：

{
    	"name": "Launch remote",
    	"type": "go",
    	"request": "launch",
    	"mode": "remote",
    	"remotePath": "服务器调试文件的目录（绝对路径）",
    	"port": 2345,
    	"host": "127.0.0.1",
    	"program": "本地调试文件所在的目录（绝对路径）",
    	"env": {}
    }

*  将上述配置中的 `host` 和 `port` 修改 `Delve` 服务所在的服务器ip和其监听的端口号。
 *  `remotePath` 应该配置为调试文件的绝对路径
 *  `program` 需要配置本地机器文件所在的绝对路径，是 `remotePath` 的一个副本

配置完成后，点击调试按钮，`VS Code` 将会项远程的 `dlv` 服务发出调试指令，而不是使用本机的 `dlv` 实例。

# 参考链接 #

[Debugging Go code using VS Code][]  
[Delve Installation][]

[18.gif]: /images/20220220/738b97d3e9484720b22fa35d50e6e3f1.png
[Debugging Go code using VS Code]: https://github.com/Microsoft/vscode-go/wiki/Debugging-Go-code-using-VS-Code#sample-configuration-to-debug-a-single-test
[Delve Installation]: https://github.com/go-delve/delve/tree/master/Documentation/installation