Go 函数单元测试的陷阱和注意事项

单元测试 Go 函数时需注意以下陷阱：避免依赖外部资源，使用桩和模拟来隔离依赖项。检查错误，不要忽略它们。使用反射或重命名来测试私有方法。使用同步原语避免并发下的竞态条件。

Go 函数单元测试的陷阱和注意事项

单元测试是保证代码质量的关键实践。在 Go 中，测试使用 testing 包。虽然单元测试相对简单，但有一些陷阱和注意事项需要注意。

1. 依赖外部资源

单元测试应该隔离待测代码，不依赖外部资源（例如数据库或网络调用）。为此，可以使用桩（stub）、模拟（mock）或测试双（test double）来隔离外部依赖项。

示例（桩）：

type DatabaseClient interface {
    GetUser(id int) (*User, error)
}

// DbClientStub 是 DatabaseClient 的桩
type DbClientStub struct {
    GetResult *User
    GetError  error
}

func (s *DbClientStub) GetUser(id int) (*User, error) {
    return s.GetResult, s.GetError
}

2. 忽略错误

在测试中忽略错误很诱人，尤其是在测试正常代码路径时。然而，这会导致难以调试问题，并且可能导致代码因未处理的错误而失败。在可能的情况下，应始终检查错误并相应地处理它们。

示例：

func GetUser(id int) (*User, error) {
    // ... 从数据库中获取用户

    // **不要忽略错误！**
    if err != nil {
        return nil, err
    }

    return user, nil
}

3. 测试私有方法

Go 语言的私有方法（小写名称）通常用于实现接口方法或隐藏实现细节。然而，它们不能直接从外部测试。有几种方法可以测试私有方法：

• 使用反射： 从测试包中使用 reflect 包来访问私有方法。
• 重命名私有方法： 将私有方法重命名为首字母大写的包级别方法。

示例（反射）：

func TestPrivateMethod(t *testing.T) {
    // 使用反射访问私有方法
    value := reflect.ValueOf(myPackage.myPrivateMethod)
    result := value.Call([]reflect.Value{reflect.ValueOf(123)})

    // 检查结果
    if result[0].Int() != 456 {
        t.Errorf("Expected 456, got %d", result[0].Int())
    }
}

4. 竞态条件

Go 的并发性使得竞态条件成为可能。单元测试应注意避免竞态条件，例如通过在并发Goroutine上使用同步原语（例如sync.Mutex）。

示例（使用 sync.Mutex）：

var userMap sync.Map

func TestConcurrentUserMap(t *testing.T) {
    // 创建 goroutine 并发访问 userMap
    for i := 0; i < 1000; i++ {
        go func(i int) {
            userMap.LoadOrStore(i, "User"+strconv.Itoa(i))
        }(i)
    }

    // 等待所有 goroutine 完成
    time.Sleep(time.Millisecond)

    // 验证 userMap 是否包含所有预期的键
    for i := 0; i < 1000; i++ {
        if _, ok := userMap.Load(i); !ok {
            t.Errorf("userMap doesn't contain key %d", i)
        }
    }
}