Press "Enter" to skip to content

Go 快速入门篇(三):单元测试、问题定位及代码调试

单元测试

编写单元测试

在 Go 语言中,支持为功能模块编写单元测试代码,继续以上篇教程构建的计算器项目为例,在 simplemath 包中,我们可以为每一个运算模块编写了对应的单元测试代码。

单元测试文件默认以同一目录下文件名后缀 _test 作为标识,比如我们在 simplemath 目录下新建 add_test.gosqrt_test.go 文件,分别为 add.gosqrt.go 编写单元测试,对应的目录结构如下:

-w634

编写 add_test.go 代码如下:

package simplemath

import "testing"

func TestAdd(t *testing.T) {
    r := Add(1, 2)
    if r != 3 {
        t.Errorf("Add(1, 2) failed. Got %d, expected 3.", r)
    }
}

以及 sqrt_test.go 代码如下:

package simplemath

import "testing"

func TestSqrt(t *testing.T) {
    v := Sqrt(9)
    if v != 3 {
        t.Errorf("Sqrt(9) failed. Got %v, expected 3.", v)
    }
}

在编写单元测试时,需要引入 testing 包,你可以将其类比为 PHP 中的 PHPUnit 或 Java 中的 JUnit,我们可以基于该包提供的方法来实现自动化测试,测试方法的格式如下所示:

func TestXXX(t *testing.T) {
    // 测试逻辑
}

运行单元测试

接下来,怎么运行这些单元测试呢?这也非常简单。

在 GoLand 中,你可以选择要执行单元测试的包,比如这里的 simplemath,然后通过右键快捷菜单依次选择 Run->go test simplemath:

GoLand 对指定包执行单元测试

就可以在 GoLand 底部 Run 窗口中看到测试运行结果:

GoLand 单元测试通过

可以看到,运行结果列出了测试的内容、测试结果和测试时间。如果我故意把 add_test.go 的代码改成这样的错误场景:

func TestAdd(t *testing.T) {
    r := Add(1, 2)
    if r != 2 {
        t.Errorf("Add(1, 2) failed. Got %d, expected 3.", r)
    }
}

然后我们再次执行单元测试,这一次,我们可以直接选择对 add_test.go 执行单元测试,在打开的 add_test.go 文件代码编辑区域通过右键快捷菜单选择 Run ‘add_test.go’ 即可:

GoLand 对指定文件执行单元测试

当然,你可以可以具体对某个方法进行单元测试,点击 GoLand 在行号右侧为测试方法渲染的绿色测试小图标,选择 Run ‘TestAdd in calc/simplepath’ 即可:

GoLand 对指定方法执行单元测试

不管以何种方式运行测试,最终都会都到如下的测试失败结果:

GoLand 单元测试失败

打印的错误信息非常简洁,却已经足够让开发者快速定位到问题代码所在的文件和行数,从而在最短的时间内确认是单元测试的问题还是程序的问题。

问题定位与调试

打印变量

当然,对于一些简单的测试,还可以通过打印变量的方式来定位问题,通常我们在 PHP 中就是这么做的,比如通过 var_dumpprintfecho 之类的语句或函数打印返回的结果,在 Laravel 框架中还可以通过 dddump 方法进行简单高效的变量打印调试,在 Go 语言中,对应的打印函数是前面介绍过的 PrintfPrintln 方法,用于对变量进行格式化输出(类比 PHP 中的 printf 函数和 print 函数,PHP 没有提供类似 Println 这样的方法,但是你可以通过在打印字符串结尾加上 \n 来实现换行),这两个方法都位于 fmt 格式化包中,我们可以这样打印变量:

fval := 110.48 
ival := 200 
sval := "This is a string. " 
fmt.Println("The value of fval is", fval) 
fmt.Printf("fval=%f, ival=%d, sval=%s\n", fval, ival, sval) 
fmt.Printf("fval=%v, ival=%v, sval=%v\n", fval, ival, sval)

对应的输出结果是:

The value of fval is 110.48
fval=110.480000, ival=200, sval=This is a string. 
fval=110.48, ival=200, sval=This is a string.

输出日志

如果代码是在线上生产环境执行,打印变量这种定位问题的方式就不合适了,这个时候我们可以通过 log 包提供的方法打印关键信息或错误信息日志,方便对线上问题进行追踪,关于日志功能后面我们在进阶版的工程管理中会详细介绍,这里先了解下即可。

IDE 调试

如果你是通过 GoLand 进行开发的话,直接在代码中设置断点(单击对应代码行即可),然后选中要调试的源码文件,在右键下拉菜单中点击「Debug」对应的选项即可开始对指定文件代码进行断点调试:

GoLand 代码调试

进入调试模式后,代码执行流程会暂停在断点处。在 GoLand 界面下方控制台的 Debug 窗口中,可以看到当前程序的堆栈信息,你可以通过手动控制(跳入、跳出、进入下一行、终止调试等)对代码进行调试,具体操作模式和 PhpStorm、ItelliJ IDEA 差不多:

-w1093

GoLand 官方博客也有一篇介绍教程:https://blog.jetbrains.com/go/2019/02/06/debugging-with-goland-getting-started/,感兴趣的可以看下。

GDB 调试

日常开发使用 GoLand 自带的代码调试功能就够了,如果你想要通过更加 Hacker 的方式调试代码,可以选择 GDB。

GDB 是一个由 GNU 开源组织发布的、Unix/Linux 操作系统下的、基于命令行的、功能强大的程序调试工具,Go 语言编译后的二进制文件支持通过 GDB 进行调试,比如上篇教程通过 go build calc 编译出来的可执行文件 calc,就可以直接用以下命令以调试模式运行:

gdb calc
GDB 代码调试

注:Windows 系统不支持该工具,Mac 下可以通过 brew install gdb 命令安装。

然后,你就可以通过 GDB 支持的指令以命令行的方式对 Go 代码进行调试了,你可以通过 l 指令查看代码:

GDB 代码调试

要跳到某一行查看通过 l <line> 传入行数即可:

GDB 代码调试

要为某一行设置断点可以通过 b <line> 来实现:

GDB 代码调试

然后通过 run 命令来运行程序,如果是在 Mac 系统上,可能会报下面这个错:

GDB 代码调试

这是因为 Darwin 内核在你没有特殊权限的情况下,不允许调试其它进程。调试某个进程,意味着你对这个进程有完全的控制权限,所以为了防止被恶意利用,它是默认禁止的。允许 gdb 控制其它进程最好的方法就是用系统信任的证书对它进行签名,对应的解决方法参考这里:https://opensource.apple.com/source/lldb/lldb-69/docs/code-signing.txt中文对应的解决方式)。

进入下一行可以用 n 指令,打印变量可以用 p <var> 指令传入变量名。。。更多指令使用我就不深入展开了,因为对于新手来说,不推荐使用 GDB 进行代码调试,直接使用 GoLand 更友好,不是吗?如果你想探究 GDB 调试的更多用法,请查看对应的官方文档

小结

至此,Go 语言零基础入门三步曲已经完结,分别是第一个 Go 程序、简单的工程管理、单元测试及代码调试,下一篇起,我们将正式开始介绍 Go 语言的语言特性、面向对象编程、并发编程、网络编程等高级使用指南,你可以通过微信公众号关注此系列教程的更新动态,学习过程中有任何问题,可以通过教程下方的评论或加入「Go 语言研习社」与学院君讨论。

太烂了有点差凑活看还不错太棒了 (9 人打了分, 平均分: 5.00)
Loading...

2 条评论

  1. Laragh
    Laragh 2021年1月30日

    我还是老老实实用阿里云的 linux 跑 GDB 吧。用 Mac 跑 gdb 有风险

发表评论