一共有几种context_Context之源码分析

源码面前，了无秘密。本文将对 context 进行源码分析，分析如何实现所特有的功能及特性。主要从以下四个角度阐述: context中的接口、context有哪些类型、context的传递实现、context的层级取消触发实现。

context中的接口

可以看到context包本身包含了数个导出函数，包括WithValue、WithTimeout等，无论是最初构造 context 还是传导context，最核心的接口类型都是context.Context，任何一种context也都实现了该接口，包括value context。

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

context的类型

既然context都需要实现Context，那么包括不直接可见(非导出)的结构体，一共有几种context呢？答案是4种。

• 类型一: emptyCtx，context之源头

emptyCtx定义如下：

type emptyCtx int

为了减轻gc压力，emptyCtx其实是一个int，并且以do nothing的方式实现了Context接口，还记得context包里面有两个初始化context的函数：

func Background() Contextfunc TODO() Context

这两个函数返回的实现类型即为emptyCtx，而在contex包中实现了两个emptyCtx类型的全局变量: background、todo，其定义如下：

var (  background = new(emptyCtx)  todo       = new(emptyCtx))

上述两个函数依次对应这两个全局变量。到这里我们可以很确定地说context的根节点就是一个int全局变量，并且Background()和TODO()是一样的。所以千万不要用nil作为context，并且从易于理解的角度出发，未考虑清楚是否传递、如何传递context时用TODO，其他情况都用Background()，如请求入口初始化context。

• 类型二: cancelCtx，cancel机制之灵魂

cancelCtx的cancel机制是手工取消、超时取消的内部实现，其定义如下：

type cancelCtx struct {  Context  mu       sync.Mutex  done     chan struct{}  children map[canceler]struct{}  err      error }

这里的mu是context并发安全的关键、done是通知的关键、children存储结构是内部最常用传导context的方式。

• 类型三: timerCtx，cancel机制的场景补充

timerCtx内部包含了cancelCtx，然后通过定时器，实现了到时取消的功能，定义如下：

type timerCtx struct {  cancelCtx  timer *time.Timer // Under cancelCtx.mu.  deadline time.Time}

• 类型四: valueCtx，传值

valueCtx是四个类型的最后一个，只用来传值，当然也可以传递，所有context都可以传递，定义如下:

type valueCtx struct {  Context  key, val interface{}}

由于有的人认为context应该只用来传值、有的人认为context的cancel机制才是核心，所以对于valueCtx也在下面做了一个单独的介绍，大家可以通过把握内部实现后按照自己的业务场景做一个取舍(传值可以用一个全局结构体、map之类)。

context的底层结构

在上面valueCtx的定义中，我们可以看出其实value context底层不是一个map，而是每一个单独的kv映射都对应一个valueCtx，当传递多个值时就要构造多个ctx。同时，这要是value contex不能自低向上传递值的原因。

valueCtx的key、val都是接口类型，在调用WithValue的时候，内部会首先通过反射确定key是否可比较类型(同map中的key)，然后赋值key

在调用Value的时候，内部会首先在本context查找对应的key，如果没有找到会在parent context中递归寻找，这也是value可以自顶向下传值的原因。

context的传递方式

首先可以明确，任何一种context都具有传递性，而传递性的内在机制可以理解为: 在调用WithCancel、WithTimeout、WithValue时如何处理父子context。从传递性的角度来说，几种With*函数内部都是通过propagateCancel这个函数来实现的，下面以WithCancel函数为例：

func WithCancel(parent Context) (ctx Context, cancel CancelFunc) {  c := newCancelCtx(parent)  propagateCancel(parent, &c)  return &c, func() { c.cancel(true, Canceled) }}

newCancelCtx是cancelCtx赋值父context的过程，而propagateCancel建立父子context之间的联系。

propagateCance定义如下:

func propagateCancel(parent Context, child canceler) {  if parent.Done() == nil {    return // parent is never canceled  }  if p, ok := parentCancelCtx(parent); ok {// context包内部可以直接识别、处理的类型    p.mu.Lock()    if p.err != nil {      // parent has already been canceled      child.cancel(false, p.err)    } else {      if p.children == nil {        p.children = make(map[canceler]struct{})      }      p.children[child] = struct{}{}    }    p.mu.Unlock()  } else {// context包内部不能直接处理的类型，比如type A struct{context.Context},这种静默包含的方式    go func() {      select {      case         child.cancel(false, parent.Err())      case       }    }()  }}

那么context是如何触发取消的呢？

上文在阐述传递性时的实现时，也包含了一部分取消机制的代码，这里不会再列出源码，但是会依据上述源码进行说明。对于几种context，传递过程大同小异，但是取消机制有所不同，针对每种类型，我会一一解释。不同类型的context可以在一条链路进行取消，但是每一个context的取消只会被一种条件触发，所以下面会单独介绍下每一种context的取消机制(组合取消的场景，按照先到先得的原则，无论那种条件触发的，都会传递调用cancel)。这里有两个设计很关键:

1. cancel函数是幂等的，可以被多次调用。

2. context中包含done channel可以用来确认是否取消、通知取消。

• cancelCtx类型

cancelCtx会主动进行取消，在自顶向下取消的过程中，会遍历children context，然后依次主动取消。cancel函数定义如下：

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 // already canceled  }  c.err = err  if c.done == nil {    c.done = closedchan  } else {    close(c.done)  }  for child := range c.children {    // NOTE: acquiring the child's lock while holding parent's lock.    child.cancel(false, err)  }  c.children = nil  c.mu.Unlock()  if removeFromParent {    removeChild(c.Context, c)  }}

• 静默包含context

这里暂时只想到了静默包含即type A struct{context.Context}的情况。通过parentCancelCtx和propagateCancel我们知道这种context不会建立父子context的直接联系，但是会通过单独的goroutine去检测done channel，来确定是否需要触发链路上的cancel函数，实现见propagateCancel的else部分。

结尾

context的实现并不复杂，但是在实际开发中确能带来不小的便利性。大家可以按场景对号入座熟练地使用context，希望大家能够从源码层面了解到context的实现，在一些极端场景下，如静默包含context，也能从容权衡利弊，做到知其然知其所以然。

本次有关Go语言 Context 的介绍就到这里，感谢您的阅读，如有疑问或意见请及时反馈给我们。

---

上一篇文章：

Golang之接口