Go语言并发编程Context包深度解析与实践引言Context是Go语言中用于传递请求作用域数据、取消信号和截止时间的标准工具。本文将深入探讨Context包的设计原理和实际应用。一、Context基础1.1 什么是Contextfunc main() { ctx : context.Background() ctx context.WithValue(ctx, request-id, 12345) processRequest(ctx) } func processRequest(ctx context.Context) { reqID : ctx.Value(request-id).(string) fmt.Printf(Processing request: %s\n, reqID) }1.2 Context接口type Context interface { Deadline() (deadline time.Time, ok bool) Done() -chan struct{} Err() error Value(key interface{}) interface{} }1.3 四种Context类型类型说明创建方式Background根Context用于主函数、初始化等context.Background()TODO不确定使用哪个Context时使用context.TODO()WithCancel可取消的Contextcontext.WithCancel(parent)WithDeadline带截止时间的Contextcontext.WithDeadline(parent, time)WithTimeout带超时的Contextcontext.WithTimeout(parent, duration)WithValue携带值的Contextcontext.WithValue(parent, key, value)二、Context实现原理2.1 emptyCtxtype emptyCtx int func (*emptyCtx) Deadline() (deadline time.Time, ok bool) { return } func (*emptyCtx) Done() -chan struct{} { return nil } func (*emptyCtx) Err() error { return nil } func (*emptyCtx) Value(key interface{}) interface{} { return nil } var ( background new(emptyCtx) todo new(emptyCtx) ) func Background() Context { return background } func TODO() Context { return todo }2.2 cancelCtxtype cancelCtx struct { Context mu sync.Mutex // 保护以下字段 done chan struct{} // 懒加载首次取消时关闭 children map[canceler]struct{} // 子Context err error // 取消原因 } type canceler interface { cancel(removeFromParent bool, err error) Done() -chan struct{} } func (c *cancelCtx) Done() -chan struct{} { c.mu.Lock() if c.done nil { c.done make(chan struct{}) } d : c.done c.mu.Unlock() return d } func (c *cancelCtx) cancel(removeFromParent bool, err error) { if err nil { panic(context: internal error: missing cancel error) } c.mu.Lock() if c.err ! nil { c.mu.Unlock() return // 已取消 } c.err err if c.done nil { c.done closedchan } else { close(c.done) } // 取消所有子Context for child : range c.children { child.cancel(false, err) } c.children nil c.mu.Unlock() // 从父Context移除 if removeFromParent { removeChild(c.Context, c) } }2.3 timerCtxtype timerCtx struct { *cancelCtx timer *time.Timer // 定时器 deadline time.Time // 截止时间 } func (c *timerCtx) Deadline() (deadline time.Time, ok bool) { return c.deadline, true } func (c *timerCtx) cancel(removeFromParent bool, err error) { c.cancelCtx.cancel(false, err) if removeFromParent { removeChild(c.cancelCtx.Context, c) } } func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc) { return WithDeadline(parent, time.Now().Add(timeout)) } func WithDeadline(parent Context, d time.Time) (Context, CancelFunc) { if cur, ok : parent.Deadline(); ok cur.Before(d) { return WithCancel(parent) } c : timerCtx{ cancelCtx: newCancelCtx(parent), deadline: d, } propagateCancel(parent, c) dur : time.Until(d) if dur 0 { c.cancel(true, DeadlineExceeded) return c, func() { c.cancel(false, Canceled) } } c.mu.Lock() defer c.mu.Unlock() if c.err nil { c.timer time.AfterFunc(dur, func() { c.cancel(true, DeadlineExceeded) }) } return c, func() { c.cancel(true, Canceled) } }2.4 valueCtxtype valueCtx struct { Context key, val interface{} } func (c *valueCtx) Value(key interface{}) interface{} { if c.key key { return c.val } return c.Context.Value(key) } func WithValue(parent Context, key, val interface{}) Context { if key nil { panic(nil key) } if !reflect.TypeOf(key).Comparable() { panic(key is not comparable) } return valueCtx{parent, key, val} }三、Context使用模式3.1 请求超时控制func fetchURL(ctx context.Context, url string) ([]byte, error) { req, err : http.NewRequestWithContext(ctx, GET, url, nil) if err ! nil { return nil, err } client : http.Client{} resp, err : client.Do(req) if err ! nil { return nil, err } defer resp.Body.Close() return io.ReadAll(resp.Body) } func main() { ctx, cancel : context.WithTimeout(context.Background(), 5*time.Second) defer cancel() data, err : fetchURL(ctx, https://example.com) if err ! nil { fmt.Printf(Error: %v\n, err) return } fmt.Printf(Received %d bytes\n, len(data)) }3.2 级联取消func parentChildCancel() { parentCtx, parentCancel : context.WithCancel(context.Background()) defer parentCancel() childCtx, childCancel : context.WithCancel(parentCtx) defer childCancel() go func() { -childCtx.Done() fmt.Println(Child context canceled) }() go func() { -parentCtx.Done() fmt.Println(Parent context canceled) }() // 取消父Context子Context也会被取消 parentCancel() time.Sleep(time.Millisecond * 100) }3.3 请求作用域传递type key int const requestIDKey key 0 func loggingMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { reqID : uuid.New().String() ctx : context.WithValue(r.Context(), requestIDKey, reqID) log.Printf(Request %s started, reqID) next.ServeHTTP(w, r.WithContext(ctx)) log.Printf(Request %s completed, reqID) }) } func handler(w http.ResponseWriter, r *http.Request) { reqID : r.Context().Value(requestIDKey).(string) log.Printf(Processing request %s, reqID) w.Write([]byte(OK)) }3.4 并发任务取消func runMultipleTasks(ctx context.Context) error { var wg sync.WaitGroup errChan : make(chan error, 3) tasks : []func() error{ task1, task2, task3, } for _, task : range tasks { wg.Add(1) go func(t func() error) { defer wg.Done() select { case -ctx.Done(): errChan - ctx.Err() return default: if err : t(); err ! nil { errChan - err } } }(task) } go func() { wg.Wait() close(errChan) }() for err : range errChan { if err ! nil { return err } } return nil }四、Context最佳实践4.1 不要传递nil Context// 错误 func badFunction(ctx context.Context) { // ctx可能为nil if ctx nil { ctx context.Background() } } // 正确文档说明ctx不能为nil func goodFunction(ctx context.Context) error { // 调用者必须传入非nil Context _, _ ctx.Deadline() return nil }4.2 Context应该作为函数的第一个参数func doSomething(ctx context.Context, arg string) error { // ctx作为第一个参数 }4.3 使用context.WithValue传递请求作用域数据// 定义自定义key类型 type requestKey string const RequestIDKey requestKey request-id func main() { ctx : context.WithValue(context.Background(), RequestIDKey, abc123) process(ctx) } func process(ctx context.Context) { reqID : ctx.Value(RequestIDKey).(string) fmt.Println(reqID) }4.4 及时释放资源func processWithCancel(ctx context.Context) { ctx, cancel : context.WithCancel(ctx) defer cancel() // 确保资源释放 // 使用ctx... }五、实战分布式追踪集成func initTracer(ctx context.Context) context.Context { tracer : initOpenTelemetryTracer() ctx trace.ContextWithTracer(ctx, tracer) spanCtx : trace.SpanContext{ TraceID: trace.NewTraceID(), SpanID: trace.NewSpanID(), TraceFlags: trace.FlagsSampled, } return trace.ContextWithSpanContext(ctx, spanCtx) } func handler(ctx context.Context) error { ctx, span : trace.StartSpan(ctx, handler) defer span.End() span.SetAttribute(request.id, ctx.Value(RequestIDKey)) return process(ctx) } func process(ctx context.Context) error { ctx, span : trace.StartSpan(ctx, process) defer span.End() // 处理逻辑 return nil }六、常见错误6.1 错误在循环中创建Context// 错误每次迭代创建新的Context for i : 0; i 10; i { ctx : context.Background() go process(ctx, i) } // 正确共享父Context ctx : context.Background() for i : 0; i 10; i { go process(ctx, i) }6.2 错误保存Context到结构体// 错误Context不应长时间存储 type Service struct { ctx context.Context // 不推荐 } // 正确每次调用时传入 type Service struct{} func (s *Service) Process(ctx context.Context) error { // 使用ctx }结论Context是Go语言并发编程中不可或缺的工具用于传递请求作用域数据、取消信号和截止时间。通过理解Context的实现原理和使用模式可以编写出更健壮、更可维护的并发程序。在实际开发中需要遵循Context的最佳实践避免常见的错误用法。
Go语言并发编程：Context包深度解析与实践
Go语言并发编程Context包深度解析与实践引言Context是Go语言中用于传递请求作用域数据、取消信号和截止时间的标准工具。本文将深入探讨Context包的设计原理和实际应用。一、Context基础1.1 什么是Contextfunc main() { ctx : context.Background() ctx context.WithValue(ctx, request-id, 12345) processRequest(ctx) } func processRequest(ctx context.Context) { reqID : ctx.Value(request-id).(string) fmt.Printf(Processing request: %s\n, reqID) }1.2 Context接口type Context interface { Deadline() (deadline time.Time, ok bool) Done() -chan struct{} Err() error Value(key interface{}) interface{} }1.3 四种Context类型类型说明创建方式Background根Context用于主函数、初始化等context.Background()TODO不确定使用哪个Context时使用context.TODO()WithCancel可取消的Contextcontext.WithCancel(parent)WithDeadline带截止时间的Contextcontext.WithDeadline(parent, time)WithTimeout带超时的Contextcontext.WithTimeout(parent, duration)WithValue携带值的Contextcontext.WithValue(parent, key, value)二、Context实现原理2.1 emptyCtxtype emptyCtx int func (*emptyCtx) Deadline() (deadline time.Time, ok bool) { return } func (*emptyCtx) Done() -chan struct{} { return nil } func (*emptyCtx) Err() error { return nil } func (*emptyCtx) Value(key interface{}) interface{} { return nil } var ( background new(emptyCtx) todo new(emptyCtx) ) func Background() Context { return background } func TODO() Context { return todo }2.2 cancelCtxtype cancelCtx struct { Context mu sync.Mutex // 保护以下字段 done chan struct{} // 懒加载首次取消时关闭 children map[canceler]struct{} // 子Context err error // 取消原因 } type canceler interface { cancel(removeFromParent bool, err error) Done() -chan struct{} } func (c *cancelCtx) Done() -chan struct{} { c.mu.Lock() if c.done nil { c.done make(chan struct{}) } d : c.done c.mu.Unlock() return d } func (c *cancelCtx) cancel(removeFromParent bool, err error) { if err nil { panic(context: internal error: missing cancel error) } c.mu.Lock() if c.err ! nil { c.mu.Unlock() return // 已取消 } c.err err if c.done nil { c.done closedchan } else { close(c.done) } // 取消所有子Context for child : range c.children { child.cancel(false, err) } c.children nil c.mu.Unlock() // 从父Context移除 if removeFromParent { removeChild(c.Context, c) } }2.3 timerCtxtype timerCtx struct { *cancelCtx timer *time.Timer // 定时器 deadline time.Time // 截止时间 } func (c *timerCtx) Deadline() (deadline time.Time, ok bool) { return c.deadline, true } func (c *timerCtx) cancel(removeFromParent bool, err error) { c.cancelCtx.cancel(false, err) if removeFromParent { removeChild(c.cancelCtx.Context, c) } } func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc) { return WithDeadline(parent, time.Now().Add(timeout)) } func WithDeadline(parent Context, d time.Time) (Context, CancelFunc) { if cur, ok : parent.Deadline(); ok cur.Before(d) { return WithCancel(parent) } c : timerCtx{ cancelCtx: newCancelCtx(parent), deadline: d, } propagateCancel(parent, c) dur : time.Until(d) if dur 0 { c.cancel(true, DeadlineExceeded) return c, func() { c.cancel(false, Canceled) } } c.mu.Lock() defer c.mu.Unlock() if c.err nil { c.timer time.AfterFunc(dur, func() { c.cancel(true, DeadlineExceeded) }) } return c, func() { c.cancel(true, Canceled) } }2.4 valueCtxtype valueCtx struct { Context key, val interface{} } func (c *valueCtx) Value(key interface{}) interface{} { if c.key key { return c.val } return c.Context.Value(key) } func WithValue(parent Context, key, val interface{}) Context { if key nil { panic(nil key) } if !reflect.TypeOf(key).Comparable() { panic(key is not comparable) } return valueCtx{parent, key, val} }三、Context使用模式3.1 请求超时控制func fetchURL(ctx context.Context, url string) ([]byte, error) { req, err : http.NewRequestWithContext(ctx, GET, url, nil) if err ! nil { return nil, err } client : http.Client{} resp, err : client.Do(req) if err ! nil { return nil, err } defer resp.Body.Close() return io.ReadAll(resp.Body) } func main() { ctx, cancel : context.WithTimeout(context.Background(), 5*time.Second) defer cancel() data, err : fetchURL(ctx, https://example.com) if err ! nil { fmt.Printf(Error: %v\n, err) return } fmt.Printf(Received %d bytes\n, len(data)) }3.2 级联取消func parentChildCancel() { parentCtx, parentCancel : context.WithCancel(context.Background()) defer parentCancel() childCtx, childCancel : context.WithCancel(parentCtx) defer childCancel() go func() { -childCtx.Done() fmt.Println(Child context canceled) }() go func() { -parentCtx.Done() fmt.Println(Parent context canceled) }() // 取消父Context子Context也会被取消 parentCancel() time.Sleep(time.Millisecond * 100) }3.3 请求作用域传递type key int const requestIDKey key 0 func loggingMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { reqID : uuid.New().String() ctx : context.WithValue(r.Context(), requestIDKey, reqID) log.Printf(Request %s started, reqID) next.ServeHTTP(w, r.WithContext(ctx)) log.Printf(Request %s completed, reqID) }) } func handler(w http.ResponseWriter, r *http.Request) { reqID : r.Context().Value(requestIDKey).(string) log.Printf(Processing request %s, reqID) w.Write([]byte(OK)) }3.4 并发任务取消func runMultipleTasks(ctx context.Context) error { var wg sync.WaitGroup errChan : make(chan error, 3) tasks : []func() error{ task1, task2, task3, } for _, task : range tasks { wg.Add(1) go func(t func() error) { defer wg.Done() select { case -ctx.Done(): errChan - ctx.Err() return default: if err : t(); err ! nil { errChan - err } } }(task) } go func() { wg.Wait() close(errChan) }() for err : range errChan { if err ! nil { return err } } return nil }四、Context最佳实践4.1 不要传递nil Context// 错误 func badFunction(ctx context.Context) { // ctx可能为nil if ctx nil { ctx context.Background() } } // 正确文档说明ctx不能为nil func goodFunction(ctx context.Context) error { // 调用者必须传入非nil Context _, _ ctx.Deadline() return nil }4.2 Context应该作为函数的第一个参数func doSomething(ctx context.Context, arg string) error { // ctx作为第一个参数 }4.3 使用context.WithValue传递请求作用域数据// 定义自定义key类型 type requestKey string const RequestIDKey requestKey request-id func main() { ctx : context.WithValue(context.Background(), RequestIDKey, abc123) process(ctx) } func process(ctx context.Context) { reqID : ctx.Value(RequestIDKey).(string) fmt.Println(reqID) }4.4 及时释放资源func processWithCancel(ctx context.Context) { ctx, cancel : context.WithCancel(ctx) defer cancel() // 确保资源释放 // 使用ctx... }五、实战分布式追踪集成func initTracer(ctx context.Context) context.Context { tracer : initOpenTelemetryTracer() ctx trace.ContextWithTracer(ctx, tracer) spanCtx : trace.SpanContext{ TraceID: trace.NewTraceID(), SpanID: trace.NewSpanID(), TraceFlags: trace.FlagsSampled, } return trace.ContextWithSpanContext(ctx, spanCtx) } func handler(ctx context.Context) error { ctx, span : trace.StartSpan(ctx, handler) defer span.End() span.SetAttribute(request.id, ctx.Value(RequestIDKey)) return process(ctx) } func process(ctx context.Context) error { ctx, span : trace.StartSpan(ctx, process) defer span.End() // 处理逻辑 return nil }六、常见错误6.1 错误在循环中创建Context// 错误每次迭代创建新的Context for i : 0; i 10; i { ctx : context.Background() go process(ctx, i) } // 正确共享父Context ctx : context.Background() for i : 0; i 10; i { go process(ctx, i) }6.2 错误保存Context到结构体// 错误Context不应长时间存储 type Service struct { ctx context.Context // 不推荐 } // 正确每次调用时传入 type Service struct{} func (s *Service) Process(ctx context.Context) error { // 使用ctx }结论Context是Go语言并发编程中不可或缺的工具用于传递请求作用域数据、取消信号和截止时间。通过理解Context的实现原理和使用模式可以编写出更健壮、更可维护的并发程序。在实际开发中需要遵循Context的最佳实践避免常见的错误用法。
