Go 语言 context 包:超时、取消与传值的正确姿势
在 Go 里,几乎所有跨 goroutine、跨 API 边界的调用都应该带上 context.Context。它解决了三个问题:取消信号、截止时间和请求范围内的值。
#超时控制
go
package main
import (
"context"
"fmt"
"time"
)
func slowWork(ctx context.Context) error {
select {
case <-time.After(3 * time.Second):
return nil
case <-ctx.Done():
return ctx.Err() // context.DeadlineExceeded
}
}
func main() {
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel() // 务必调用,释放计时器资源
if err := slowWork(ctx); err != nil {
fmt.Println("失败:", err)
}
}
defer cancel()不是可选项。即使任务提前完成,也要调用 cancel,否则内部的 timer 会一直存活到超时为止。
#主动取消:多个 worker 中一个出错,全部停止
go
func run(ctx context.Context) error {
ctx, cancel := context.WithCancel(ctx)
defer cancel()
errCh := make(chan error, 3)
for i := 0; i < 3; i++ {
go func(id int) { errCh <- worker(ctx, id) }(i)
}
for i := 0; i < 3; i++ {
if err := <-errCh; err != nil {
cancel() // 通知其他 worker 退出
return err
}
}
return nil
}实际项目中更推荐直接使用 golang.org/x/sync/errgroup,它把上面的模式封装好了:
go
g, ctx := errgroup.WithContext(ctx)
for _, url := range urls {
g.Go(func() error { return fetch(ctx, url) })
}
return g.Wait()#在 HTTP 服务中传递
http.Request 自带 context,客户端断开连接时它会被自动取消:
go
func handler(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()
rows, err := db.QueryContext(ctx, "SELECT id, name FROM users")
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
defer rows.Close()
// ...
}这样用户关掉页面后,正在执行的慢查询也会被取消,节省数据库资源。
#使用规范
- context 作为函数的第一个参数,命名为
ctx。 - 不要把 context 存到结构体字段里。
- 不要传
nil,不确定时用context.TODO()。 WithValue只放请求范围的元数据(trace id、用户身份),不要用来传可选参数。WithValue的 key 使用自定义的未导出类型,避免冲突:
go
type ctxKey struct{}
func WithTraceID(ctx context.Context, id string) context.Context {
return context.WithValue(ctx, ctxKey{}, id)
}