如何使用Go的context.WithTimeout检测超时并设置错误返回

关于<-ctx.Done()的含义 #

<-ctx.Done()触发（即通道关闭）不只是代表超时，它是context终止的通用信号，触发场景包括：

• context.WithTimeout设置的超时时间到期
• 手动调用了cancel()函数（比如你代码里的defer cancel）
• 父context被外部取消

要判断是不是超时导致的终止，需要检查ctx.Err()的返回值：

• 返回context.DeadlineExceeded时，说明是超时触发
• 返回context.Canceled时，说明是主动取消或父context终止

检测超时的合适位置 #

你想放在函数末尾检测是太晚了——如果GetEvent是耗时操作且没有响应context，超时发生后函数还会继续执行，直到GetEvent完成，完全失去了超时控制的意义。

正确的做法是：

1. 确保被调用的耗时函数（比如你的GetEvent）内部会响应context：比如在循环里检查<-ctx.Done()，或者使用支持context的IO/网络API
2. 在耗时操作完成后立即检查context状态，一旦发现超时/取消，立刻终止后续流程并返回错误

修改后的代码示例 #

import "context"

func MyFunc(ctx context.Context, cfg *Config) (packedevent []byte, err error, publishEvent bool) {
    var cancel context.CancelFunc
    ctx, cancel = context.WithTimeout(ctx, cfg.ScanTimeout)
    defer cancel() // 确保无论如何都释放context资源

    // 调用耗时操作，该函数需内部响应context
    event := GetEvent(ctx, cfg)
    
    // 检查是否超时或context被取消
    if err = ctx.Err(); err != nil {
        // 按需区分超时和取消场景
        if err == context.DeadlineExceeded {
            return nil, err, false
        }
        return nil, err, false
    }

    packedevent, err = PackEvent(event)
    if err != nil {
        return nil, err, false
    }

    publishEvent = shouldSendToIoT(event)

    return
}

// 示例：确保GetEvent内部响应context
func GetEvent(ctx context.Context, cfg *Config) Event {
    // 模拟耗时操作，比如数据库查询/网络请求
    select {
    case <-ctx.Done():
        // context终止时提前返回
        return Event{}
    case <-time.After(cfg.ScanDuration): // 模拟耗时逻辑
        return Event{/* 构造事件数据 */}
    }
}

特殊场景处理（无法修改的第三方耗时函数） #

如果GetEvent是同步阻塞且无法修改的第三方函数，context超时无法直接中断它——此时你需要把它放到goroutine里，用select监听ctx.Done()和函数完成信号，实现超时控制：

func MyFunc(ctx context.Context, cfg *Config) (packedevent []byte, err error, publishEvent bool) {
    var cancel context.CancelFunc
    ctx, cancel = context.WithTimeout(ctx, cfg.ScanTimeout)
    defer cancel()

    // 用goroutine执行无法响应context的耗时函数
    eventChan := make(chan Event, 1)
    go func() {
        eventChan <- GetEvent(ctx, cfg) // 此处ctx仅做参数传递，函数内部不响应
    }()

    select {
    case event := <-eventChan:
        // 函数正常完成
        packedevent, err = PackEvent(event)
        if err != nil {
            return nil, err, false
        }
        publishEvent = shouldSendToIoT(event)
    case <-ctx.Done():
        // 超时或取消
        err = ctx.Err()
        publishEvent = false
    }

    return
}

内容的提问来源于stack exchange，提问作者Shane Bishop