我正在参加「掘金·启航计划」

为什么需要context

在go服务器中，对于每个请求的request都是在单独的goroutine中进行的，处理一个request也可能设计多个goroutine之间的交互，使用context可以使开发者方便的在这些goroutine里传递request相关的数据、取消goroutine的signal或截止日期。

什么是context

在 Go 1.7 版本中正式引入新标准库 context。context 也叫作“上下文”，一般理解为程序单元的一个运行状态、现场、快照，其中上下是指存在上下层的传递，上会把内容传递给下，程序单元则是指goroutine；其主要的作用是在 goroutine 中进行上下文的传递，而在传递信息中又包含了 goroutine 的运行控制、上下文信息传递等功能。专门用来处理单个请求的多个goroutine之间与请求域的数据、取消信号、截止时间等相关操作。

Context 接口

Context 包的核心就是 Context 接口，其定义如下：

type Context interface {
    //deadline返回ctx完成工作应该被取消的时间，当deadline没有被设置返回ok==false
    Deadline() (deadline time.Time, ok bool)
    //返回一个代表context完成的管道，若是context无法关闭，done返回nil
    //WithCancel 安排 Done 在调用 cancel 时关闭；
    //WithDeadline 安排 Done 在截止日期到期时关闭； WithTimeout 安排 Done 在超时过后关闭。
    Done() <-chan struct{}
    //若done没有关闭，err返回nil
    //若doneclosed。err返回非空解释，如canceled如果context被cancel，DeadlineExceeded如果context
    //的deadline超时
    Err() error
    //用于存储与此上下文关联的key值
    Value(key interface{}) interface{}
}

其中：

Deadline 方法需要返回当前 Context 被取消的时间，也就是完成工作的截止时间（deadline）；
Done 方法需要返回一个 Channel，这个 Channel 会在当前工作完成或者上下文被取消之后关闭，多次调用 Done 方法会返回同一个Channel；
Err 方法会返回当前 Context 结束的原因，它只会在 Done 返回的 Channel 被关闭时才会返回非空的值：
- 如果当前 Context 被取消就会返回 Canceled 错误；
- 如果当前 Context 超时就会返回 DeadlineExceeded 错误；
Value 方法会从 Context 中返回键对应的值，对于同一个上下文来说，多次调用 Value 并传入相同的 Key 会返回相同的结果，该方法仅用于传递跨 API 和进程间跟请求域的数据。

Background()和TODO()

Go 内置两个函数Background()和TODO(),这两个函数分别返回一个实现了Context接口的background和todo。

Background()主要用于main函数、初始化以及测试代码中，作为Context这个树结构的最顶层的Context，也就是根Context。
TODO()目前还不知道具体的使用场景，如果我们不知道该使用什么Context的时候，可以使用这个。具体实现如下：

type emptyCtx int

var (
   background = new(emptyCtx)
   todo       = new(emptyCtx)
)
//它通常由主函数、初始化和测试使用，并作为传入请求的顶级context。
func Background() Context {
   return background
}
//当不清楚用什么context或者周围的函数还没有拓展到接收context参数的时候使用
func TODO() Context {
   return todo
}

background和todo本质上都是emptyCtx结构体类型，是一个不可取消，没有设置截止时间，没有携带任何值的Context。

With 系列函数

WithCancel

func WithCancel(parent Context) (ctx Context, cancel CancelFunc)

WithCancel返回带有新Done通道的父节点的副本。当调用返回的cancel函数或当关闭父上下文的Done通道时，将关闭返回上下文的Done通道，无论先发生什么情况。

取消此上下文将释放与其关联的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel。

示例:

    ctx, cancel := context.WithCancel(context.Background())
    defer cancel() // 当我们取完需要的整数后调用cancel

WithDeadline

func WithDeadline(parent Context, d time.Time) (Context, CancelFunc)

返回父上下文的副本，并将deadline调整为不迟于d。如果父上下文的deadline已经早于d，则WithDeadline(parent, d)在语义上等同于父上下文。当截止日过期时，当调用返回的cancel函数时，或者当父上下文的Done通道关闭时，返回上下文的Done通道将被关闭，以最先发生的情况为准。

取消此上下文将释放与其关联的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel。示例:

    d := time.Now().Add(50 * time.Millisecond)
    ctx, cancel := context.WithDeadline(context.Background(), d)

    // 尽管ctx会过期，但在任何情况下调用它的cancel函数都是很好的实践。
    // 如果不这样做，可能会使上下文及其父类存活的时间超过必要的时间。
    defer cancel()

WithTimeout

func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)

取消此上下文将释放与其相关的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel，通常用于数据库或者网络连接的超时控制。示例:

    // 设置一个50毫秒的超时
    ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
    ....
    cancel() // 通知子goroutine结束

WithValue

func WithValue(parent Context, key, val interface{}) Context

WithValue返回父节点的副本，其中与key关联的值为val。示例:

func main() {
    type favContextKey string // 定义一个key类型
    // f:一个从上下文中根据key取value的函数
    f := func(ctx context.Context, k favContextKey) {
        if v := ctx.Value(k); v != nil {
            fmt.Println("found value:", v)
            return
        }
        fmt.Println("key not found:", k)
    }
    k := favContextKey("key")
    // 创建一个携带key为k，value为"123"的上下文
    ctx := context.WithValue(context.Background(), k, "123")
    f(ctx, k)
    f(ctx, favContextKey("k2"))
}

使用Context的注意事项

推荐以参数的方式显示传递Context,不要把 Context 放在结构体中
以Context作为参数的函数方法，应该把Context作为第一个参数。
给一个函数方法传递Context的时候，不要传递nil，如果不知道传递什么，就使用context.TODO()
Context的Value相关方法应该传递请求域的必要数据，不应该用于传递可选参数
Context是线程安全的，可以放心的在多个goroutine中传递

总结

Go语言中的 Context 的主要作用还是在多个 Goroutine 或者模块之间同步取消信号或者截止日期，用于减少对资源的消耗和长时间占用，避免资源浪费，虽然传值也是它的功能之一，但是这个功能我们还是很少用到。

在真正使用传值的功能时我们也应该非常谨慎，不能将请求的所有参数都使用 Context 进行传递，这是一种非常差的设计，比较常见的使用场景是传递请求对应用户的认证令牌以及用于进行分布式追踪的请求 ID。

Go Context详解