表驱动测试是Golang单元测试中非常实用的一种编写模式，它的核心思路是将测试用例的输入、预期输出以及用例描述整理成结构体切片，通过循环遍历切片执行所有测试用例，避免重复编写相似的测试逻辑，让测试代码更简洁、更易维护。
表驱动测试的基础结构
表驱动测试通常由三个部分组成：定义测试用例结构体、准备测试用例集合、循环执行测试用例。下面通过一个简单的加法函数测试来展示基础写法。
首先是要测试的目标函数：
package main
// Add 实现两个整数相加
func Add(a, b int) int {
return a + b
}
对应的表驱动测试代码如下：
package main
import (
"testing"
)
// TestAdd 测试Add函数的表驱动测试
func TestAdd(t *testing.T) {
// 定义测试用例结构体
type testCase struct {
name string // 测试用例名称
a int // 输入参数a
b int // 输入参数b
expected int // 预期输出结果
}
// 准备测试用例集合
testCases := []testCase{
{name: "两个正数相加", a: 1, b: 2, expected: 3},
{name: "正数加负数", a: 5, b: -3, expected: 2},
{name: "两个负数相加", a: -1, b: -2, expected: -3},
{name: "加零", a: 10, b: 0, expected: 10},
}
// 循环执行所有测试用例
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
result := Add(tc.a, tc.b)
if result != tc.expected {
t.Errorf("Add(%d, %d) = %d, expected %d", tc.a, tc.b, result, tc.expected)
}
})
}
}
表驱动测试的进阶用法
处理错误场景的测试
如果测试的函数会返回错误，可以在测试用例结构体中增加wantErr字段，用来标记当前用例是否预期返回错误。
先定义一个可能返回错误的函数：
package main
import "errors"
// Divide 实现两个整数相除，除数为0时返回错误
func Divide(a, b int) (int, error) {
if b == 0 {
return 0, errors.New("除数不能为0")
}
return a / b, nil
}
对应的表驱动测试代码如下：
package main
import (
"testing"
)
// TestDivide 测试Divide函数的表驱动测试
func TestDivide(t *testing.T) {
type testCase struct {
name string
a int
b int
expected int
wantErr bool
}
testCases := []testCase{
{name: "正常除法", a: 6, b: 2, expected: 3, wantErr: false},
{name: "除数为0", a: 5, b: 0, expected: 0, wantErr: true},
{name: "被除数为0", a: 0, b: 5, expected: 0, wantErr: false},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
result, err := Divide(tc.a, tc.b)
// 检查错误是否符合预期
if (err != nil) != tc.wantErr {
t.Errorf("Divide() error = %v, wantErr %v", err, tc.wantErr)
return
}
// 如果没有预期错误，检查返回结果是否正确
if !tc.wantErr && result != tc.expected {
t.Errorf("Divide() = %d, expected %d", result, tc.expected)
}
})
}
}
复用测试用例集合
如果多个测试函数需要使用相同的测试用例集合，可以将测试用例定义为包级变量，实现复用。
package main
import "testing"
// 定义包级测试用例集合
var addTestCases = []struct {
name string
a int
b int
expected int
}{
{name: "两个正数相加", a: 1, b: 2, expected: 3},
{name: "正数加负数", a: 5, b: -3, expected: 2},
}
// TestAddV2 复用测试用例的测试函数
func TestAddV2(t *testing.T) {
for _, tc := range addTestCases {
t.Run(tc.name, func(t *testing.T) {
result := Add(tc.a, tc.b)
if result != tc.expected {
t.Errorf("Add(%d, %d) = %d, expected %d", tc.a, tc.b, result, tc.expected)
}
})
}
}
表驱动测试的注意事项
- 测试用例结构体的字段命名要清晰，方便后续维护时理解每个字段的含义。
- 每个测试用例最好设置独立的
name字段，这样测试失败时能快速定位是哪个用例出了问题。 - 如果测试用例数量较多，可以将测试用例集合拆分到单独的测试数据文件中，避免测试函数过于冗长。
- 不要在循环中使用
t.Parallel()时直接引用循环变量，避免闭包捕获问题，上面的写法中通过tc := tc的方式可以避免这个问题，不过使用t.Run时传入的tc是循环内的局部变量，通常不会有这个问题。
表驱动测试的优势
相比为每个场景单独编写测试函数，表驱动测试的优势非常明显：新增测试用例只需要往切片中添加一个结构体元素即可，不需要重复编写测试逻辑；所有测试用例集中管理，修改测试逻辑时只需要改一处代码；测试代码结构清晰，可读性更强，后续维护成本更低。