如何为context canceled错误增加可见性，以定位取消操作的来源？

1. Go 1.20+ 推荐：使用context.WithCancelCause #

Go 1.20新增的WithCancelCause原生支持在取消Context时附带自定义错误原因，下游通过context.Cause()即可获取。

示例代码：

package main

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

func main() {
    ctx, cancel := context.WithCancelCause(context.Background())
    
    // 模拟优雅停机触发取消
    go func() {
        time.Sleep(time.Second)
        cancel(fmt.Errorf("graceful shutdown"))
    }()
    
    <-ctx.Done()
    // 组合取消错误和自定义原因
    fmt.Printf("%v: %v\n", ctx.Err(), context.Cause(ctx))
    // 输出: context canceled: graceful shutdown
}

下游只需判断ctx.Err()为context.Canceled后，调用context.Cause(ctx)就能拿到源头设置的取消原因，直接拼接成目标格式的错误信息。

2. 兼容旧版Go：自定义包装Context #

如果项目基于Go 1.20之前的版本，可以自行实现带取消原因的Context包装：

package main

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

// 自定义Context类型，存储取消原因
type cancelCauseCtx struct {
    context.Context
    cause error
}

// 实现Cause方法，供下游获取原因
func (c *cancelCauseCtx) Cause() error {
    return c.cause
}

// 自定义WithCancelCause，返回带原因存储的Context和带参数的cancel函数
func WithCancelCause(parent context.Context) (context.Context, func(error)) {
    baseCtx, baseCancel := context.WithCancel(parent)
    ctx := &cancelCauseCtx{Context: baseCtx}
    return ctx, func(cause error) {
        ctx.cause = cause
        baseCancel()
    }
}

func main() {
    ctx, cancel := WithCancelCause(context.Background())
    
    // 模拟gRPC请求被客户端取消
    go func() {
        time.Sleep(time.Second)
        cancel(fmt.Errorf("grpc request canceled"))
    }()
    
    <-ctx.Done()
    if err := ctx.Err(); err != nil {
        // 通过类型断言获取自定义原因
        if cc, ok := ctx.(interface{ Cause() error }); ok {
            fmt.Printf("%v: %v\n", err, cc.Cause())
        } else {
            fmt.Println(err)
        }
    }
}

这种方式需要下游通过类型断言调用Cause()方法，实现逻辑简单且兼容旧版本。

3. 轻量方案：错误链与Context Value传递 #

如果不想修改Context结构，也可以通过Context的Value存储取消原因，下游取出后拼接错误信息：

// 定义key，避免冲突
var cancelCauseKey = struct{}{}

// 上游取消时设置原因
func main() {
    ctx := context.WithValue(context.Background(), cancelCauseKey, "grpc request canceled")
    ctx, cancel := context.WithCancel(ctx)
    
    go func() {
        time.Sleep(time.Second)
        cancel()
    }()
    
    <-ctx.Done()
    fmt.Printf("%v: %v\n", ctx.Err(), ctx.Value(cancelCauseKey))
}

这种方式无需额外封装，但需要上游提前在Context中注入原因，灵活性稍弱，适合简单场景。

注意点 #

• 所有方案中，都要确保下游统一处理逻辑：先判断ctx.Err()是否为context.Canceled，再获取自定义原因，避免非取消场景下的错误输出。
• 使用原生WithCancelCause时，若Context因超时触发取消，Cause()会返回context.DeadlineExceeded，而非自定义原因，需注意区分。

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