【Vscode】调试go语言程序的最佳实践

2022-06-23 17:50:01 浏览数 (1)

使用vscode可以很容易调试go语言程序,本篇就介绍一下博主个人的使用心得。

1.写在前面—delve

Delve是Go语言调试工具。vscode调试,实质是集成了Delvevscode可以一键安装所有go开发的相关工具,本篇不赘述。

1.1 调试main.go

代码语言:javascript复制
#启动调试
dlv debug .main.go

#打断点
b main.go:75 #main.go的75行打断点

#执行至断点
c

#退出
q

debug命令会先编译go源文件,同时执行attach命令进入调试模式,该命令会在当前目录下生成一个名为debug的可执行二进制文件__debug_bin,退出调试模式会自动被删除。

  • bbreak-打断点
  • ccontinue-继续运行,直到断点处停止
  • nnext-单步运行
  • locals打印local varables
  • pprint打印一个变量或者表达式
  • rrestart 重启进程

还有其他一些命令,比如clear清除单个断点,请自行探索,因为这不是本篇的重点。

1.2 调试*_test.go

单元测试的重要性就不赘述。go语言里面 _test.go 结尾的文件会被认为是测试文件,go语言作为现代化的语言,语言工具层面就支持单元测试。

利用 go test 命令,会直接编译测试文件为二进制文件后,再运行。

但是,有时候我们需要知道执行单元测试的细节,无论是验证也好,还是去寻找单元测试没有PASS的原因。那么调试测试代码就成了刚需。

代码语言:javascript复制
#启动调试
dlv test .main_test.go

#打断点
b main_test.go:10

#或者具体测试方法
b TestSum

#执行至断点
c

#退出
q

2.vscode调试的最佳实践

2.1 添加调试配置文件

代码语言:javascript复制
{
  // 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 Package",
      "type": "go",
      "request": "launch",
      // "mode": "auto",
      "mode": "debug",
      "program": "${workspaceFolder}",
      "showGlobalVariables": false
    }
  ]
}

mode请更改为debug,如果为auto时,F5启动调试时:

  • 如果当前文件是单元测试,便会执行当前包中所有的单元测试文件,即mode切换至test
  • 如果当前文件*.go,才会执行main.go,即mode切换至debug

由于第一个特点,博主在工作中冲掉了一些数据,虽然原则上测试应该只是测试,但是项目中很多数据都需要靠test写入,所以test测试的方法也可能有破坏性。考虑到这种情况,领导增加了一个不成文的规则:这种有破坏性的test方法,测试完后要么删掉,要么注释掉写入数据库的部分。所以博主再次重申:mode请更改为debug,这样就算不小心启动了调试,也不会启动测试方法。

vscode的launch.json还可以固化多个调试运行的配置,只需开发者切换即可,如下图

2.2 单元测试

不启动测试方法,那总要有启动测试的方法?

vscode为开发者提供了4个一键操作。

  • run package tests
    • 运行整个包中的测试,等价于执行go test -cover请谨慎使用
  • run file tests
    • 运行本文件的测试方法,等价于执行go test *_test.go请谨慎使用
  • run test
    • 只运行单个测试方法,等价于执行go test -v main_test.go --test.run 测试方法名称
  • debug test
    • 只调试单个测试方法,这个博主还真没找到等价命令,主要是只调试这个方法,然后就可以终止,不知道是什么奇技淫巧,到底是dlv还是dlv-dap的功劳,还是微软注入了新的能力,有知道的童鞋可以留言。

3.结论

vscode调试go语言程序最佳实践:

  1. F5或者快捷调试,默认都是启动应用,且只保留一个配置,配置中的 mode 设为debug
  2. 所有的单元测试,请只在测试函数上方单点运行:
    • run test
    • debug test
  3. vscode很好用

0 人点赞