17370845950

如何用 Golang 测试接口超时处理_Golang context 超时控制测试示例
答案:通过设置短于操作耗时的 context 超时时间,测试可验证 FetchData 在超时时正确返回 context.DeadlineExceeded 错误且数据为空;同时用足够超时测试成功场景,确保超时与正常路径均被覆盖。

在 Go 语言中,使用 context 控制接口调用的超时是非常常见的做法。特别是在网络请求、数据库查询或外部服务调用中,必须防止程序因长时间等待而阻塞。为了确保超时逻辑正确工作,编写相应的测试用例至关重要。下面通过一个具体示例展示如何测试基于 context 的超时处理。

模拟一个带超时的接口调用

假设我们有一个服务方法 FetchData,它依赖外部 API 调用,并使用 context 控制超时:

package main

import ( "context" "errors" "time" )

func FetchData(ctx context.Context) (string, error) { select { case <-time.After(2 * time.Second): // 模拟耗时操作 return "real data", nil case <-ctx.Done(): return "", ctx.Err() } }

这个函数会在 2 秒后返回数据,但如果 context 被取消(比如超时),则提前退出并返回错误。

编写超时测试用例

我们需要验证:当 context 设置的超时时间小于实际处理时间时,函数应返回 context 超时错误(context.DeadlineExceeded)。

package main

import ( "context" "testing" "time" )

func TestFetchData_Timeout(t testing.T) { ctx, cancel := context.WithTimeout(context.Background(), 100time.Millisecond) defer cancel()

data, err := FetchData(ctx)

if err == nil {
    t.Fatal("expected error due to timeout, but got nil")
}

if !errors.Is(err, context.DeadlineExceeded) {
    t.Fatalf("expected context.DeadlineExceeded, got %v", err)
}

if data != "" {
    t.Fatalf("expected empty data on timeout, got %s", data)
}

}

这个测试设置了 100 毫秒的超时,远小于 FetchData 所需的 2 秒,因此预期会触发超时。我们检查了三点:
- 是否返回错误
- 错误是否为 context.DeadlineExceeded
- 返回的数据是否为空

测试正常情况(无超时)

除了测试超时,我们也应验证在充足时间内能成功获取结果:

func TestFetchData_Success(t *testing.T) {
    ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
    defer cancel()
data, err := FetchData(ctx)

if err != nil {
    t.Fatalf("unexpected error: %v", err)
}

if data != "real data" {
    t.Fatalf("expected 'real data', got '%s'", data)
}

}

这里设置 3 秒超时,足够完成 2 秒的操作,因此应正常返回数据。

使用 testify/require 简化断言(可选)

如果你使用 testify 库,可以简化错误判断:

import (
    "github.com/stretchr/testify/require"
)

func TestFetchData_Timeout(t testing.T) { ctx, cancel := context.WithTimeout(context.Background(), 100time.Millisecond) defer cancel()

data, err := FetchData(ctx)
require.Error(t, err)
require.True(t, errors.Is(err, context.DeadlineExceeded))
require.Empty(t, data)

}

这样代码更简洁,逻辑更清晰。

基本上就这些。通过合理设置 context 超时时间,结合 select 和 channel 模拟耗时操作,就能完整测试接口的超时控制行为。关键是确保超时路径和成功路径都被覆盖。