Context：超时、取消与请求域数据

一、学习目标

二、知识讲解

2.1 context 的作用与设计

在 Go 语言中，context 是用于在 API 边界之间、goroutine 之间传递取消信号、截止时间、请求范围的值等数据的机制。

是什么： context.Context 是一个接口，定义如下：

type Context interface {
    Deadline() (deadline time.Time, ok bool)
    Done() <-chan struct{}
    Err() error
    Value(key any) any
}

• Deadline：返回上下文被取消的截止时间。
• Done：返回一个 channel，当上下文被取消时，该 channel 会关闭。
• Err：返回取消的原因。
• Value：返回与 key 关联的值。

为什么这样设计： Go 没有提供全局的“取消所有 goroutine”的全局变量。如果每个 goroutine 都需要感知父任务的取消状态，传统的做法是传递一个 chan struct{} 或 bool 标志。但这会导致参数列表膨胀，且难以管理层级关系。context 通过树状结构（派生上下文）解决了这个问题： 1. 取消信号传播：父上下文取消时，所有子上下文自动取消。 2. 请求域数据：在 HTTP 请求等场景中，可以将请求 ID、用户信息等沿调用链向下传递，无需在每个函数签名中显式添加。

2.2 派生上下文与取消信号传播

context 通常通过工厂函数派生。派生出的子上下文继承父上下文的状态，但可以添加新的约束（如超时）或存储新的值。

取消信号传播： 当父上下文被取消时，取消信号会向下传播到所有子上下文。注意，取消是单向的，子上下文的取消不会影响父上下文。

常用工厂函数： - context.WithCancel(parent): 返回一个派生的子上下文和一个取消函数。调用取消函数后，子上下文及其所有后代将被取消。 - context.WithTimeout(parent, d): 返回一个派生的子上下文，该上下文会在持续时间 d 后自动取消。 - context.WithDeadline(parent, d): 返回一个派生的子上下文，该上下文会在指定时间点 d 后自动取消。

2.3 WithValue 的正确用法与反模式

context.WithValue(parent, key, val) 用于在上下文中存储键值对。

正确用法： - 仅用于请求域数据（Request-scoped data），如 HTTP 请求 ID、认证信息、追踪 ID。 - Key 应该使用自定义类型，避免与第三方库冲突。

反模式（Anti-patterns）： 1. 不要将 context 存到结构体字段里：Context 的生命周期通常短于结构体生命周期，存储会导致上下文被意外延长或泄露。 2. 不要用于传递可选参数：Context 不是参数传递的通用机制，它主要用于控制取消和传递请求级元数据。 3. 不要存储敏感信息：Context 可能被日志记录或调试工具访问，敏感数据（如密码）不应存入。

三、示例代码

示例 1：超时控制与取消传播

本示例演示如何使用 WithTimeout 设置超时，以及如何通过 select 监听取消信号。

package main

import (
    "context"
    "fmt"
    "time"
)

func main() {
    // 创建一个带超时的上下文，超时时间为 2 秒
    ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
    defer cancel() // 确保资源释放

    // 模拟一个长时间运行的任务
    go func() {
        select {
        case <-ctx.Done():
            // 检查错误原因
            if err := ctx.Err(); err != nil {
                fmt.Printf("Task cancelled due to: %v\n", err)
            }
        case <-time.After(1 * time.Second):
            fmt.Println("Task completed successfully before timeout")
        }
    }()

    // 主 goroutine 等待 3 秒，确保子 goroutine 有机会执行或超时
    time.Sleep(3 * time.Second)
}

运行结果（预期输出）：

Task cancelled due to: context deadline exceeded

示例 2：WithValue 传递请求域数据

本示例演示如何使用 WithValue 在 goroutine 之间传递请求 ID，并展示如何安全地获取值。

package main

import (
    "context"
    "fmt"
)

// RequestIDKey 是一个自定义类型，用于避免键冲突
type RequestIDKey struct{}

func main() {
    // 创建一个基础上下文
    ctx := context.Background()

    // 使用 WithValue 添加请求 ID
    ctx = context.WithValue(ctx, RequestIDKey{}, "req-12345")

    // 模拟处理请求的函数
    processRequest(ctx)
}

func processRequest(ctx context.Context) {
    // 从上下文中获取请求 ID
    requestID, ok := ctx.Value(RequestIDKey{}).(string)
    if !ok {
        fmt.Println("Request ID not found")
        return
    }

    fmt.Printf("Processing request with ID: %s\n", requestID)
}

运行结果（预期输出）：

Processing request with ID: req-12345

四、常见错误与避坑指南

五、最佳实践

六、练习题

1. 概念题：解释 context.WithCancel 返回的两个值分别是什么，以及取消信号是如何传播的。
2. 编码题：编写一个函数 fetchData(ctx context.Context, url string) (string, error)，该函数模拟从 URL 获取数据。如果 context 被取消或超时，函数应立即返回错误。
3. 进阶/调试题：以下代码存在什么问题？如何修复？ ```go package main

import ( "context" "fmt" "time" )

func main() { ctx := context.Background() for i := 0; i < 3; i++ { ctx = context.WithValue(ctx, "key", i) go func() { fmt.Println(ctx.Value("key")) }() } time.Sleep(1 * time.Second) } ```

七、练习参考答案

package main

import (
    "context"
    "fmt"
    "time"
)

func fetchData(ctx context.Context, url string) (string, error) {
    // 模拟网络请求耗时
    select {
    case <-ctx.Done():
        return "", ctx.Err()
    case <-time.After(1 * time.Second):
        return fmt.Sprintf("Data from %s", url), nil
    }
}

func main() {
    ctx, cancel := context.WithTimeout(context.Background(), 500*time.Millisecond)
    defer cancel()

    data, err := fetchData(ctx, "http://example.com")
    if err != nil {
        fmt.Printf("Error: %v\n", err)
        return
    }
    fmt.Println(data)
}

package main

import (
    "context"
    "fmt"
    "time"
)

func main() {
    for i := 0; i < 3; i++ {
        // 每次循环创建新的上下文，避免复用
        ctx := context.WithValue(context.Background(), "key", i)
        _ = ctx
        go func(val int) {
            fmt.Println(val)
        }(i)
    }
    time.Sleep(1 * time.Second)
}

八、本课小结