context 底层原理介绍

1. context 介绍
很多时候,我们会遇到这样的情况,上层与下层的goroutine需要同时取消,这样就涉及到了goroutine间的通信。在go中,推荐我们以通信的方式共享内存,而不是以共享内存的方式通信。
所以,就需要用到channl,但是,在上述场景中,如果需要自己去处理channl的业务逻辑,就会有很多费时费力的重复工作,因此,context出现了。
context是go中用来进程通信的一种方式,其底层是借助channl与snyc.mutex实现的。
2. 基本介绍
context的底层设计,我们可以概括为1个接口,4种实现与6个方法。
1 个接口
context 规定了context的四个基本方法
4 种实现
emptyctx 实现了一个空的context,可以用作根节点
cancelctx 实现一个带cancel功能的context,可以主动取消
timerctx 实现一个通过定时器timer和截止时间deadline定时取消的context
valuectx 实现一个可以通过 key、val 两个字段来存数据的context
6 个方法
background 返回一个emptyctx作为根节点
todo 返回一个emptyctx作为未知节点
withcancel 返回一个cancelctx
withdeadline 返回一个timerctx
withtimeout 返回一个timerctx
withvalue 返回一个valuectx
3. 源码分析
3.1 context 接口
type context interface { deadline() (deadline time.time, ok bool) done() <-chan struct{} err() error value(key interface{}) interface{}}  
deadline() :返回一个time.time,表示当前context应该结束的时间,ok则表示有结束时间
done():返回一个只读chan,如果可以从该 chan 中读取到数据,则说明 ctx 被取消了
err():返回 context 被取消的原因
value(key):返回key对应的value,是协程安全的
3.2 emptyctx
type emptyctx intfunc (*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}  
emptyctx实现了空的context接口,其主要作用是为background和todo这两个方法都会返回预先初始化好的私有变量 background 和 todo,它们会在同一个 go 程序中被复用:
var ( background = new(emptyctx) todo = new(emptyctx) )func background() context { return background}func todo() context { return todo}  
background和todo在实现上没有区别,只是在使用语义上有所差异:
background是上下文的根节点;
todo应该仅在不确定应该使用哪种上下文时使用;
3.3 cancelctx
cancelctx实现了canceler接口与context接口:type canceler interface { cancel(removefromparent bool, err error) done() <-chan struct{}}  
其结构体如下:
type cancelctx struct { // 直接嵌入了一个 context,那么可以把 cancelctx 看做是一个 context context mu sync.mutex // protects following fields done atomic.value // of chan struct{}, created lazily, closed by first cancel call children map[canceler]struct{} // set to nil by the first cancel call err error // set to non-nil by the first cancel call}  
我们可以使用withcancel的方法来创建一个cancelctx:
func withcancel(parent context) (ctx context, cancel cancelfunc) { if parent == nil { panic(cannot create context from nil parent) } c := newcancelctx(parent) propagatecancel(parent, &c) return &c, func() { c.cancel(true, canceled) }}func newcancelctx(parent context) cancelctx { return cancelctx{context: parent}}  
上面的方法,我们传入一个父 context(这通常是一个 background,作为根节点),返回新建的 context,并通过闭包的形式,返回了一个 cancel 方法。
newcancelctx将传入的上下文包装成私有结构体context.cancelctx。
propagatecancel则会构建父子上下文之间的关联,形成树结构,当父上下文被取消时,子上下文也会被取消:
func propagatecancel(parent context, child canceler) { // 1.如果 parent ctx 是不可取消的 ctx,则直接返回 不进行关联 done := parent.done() if done == nil { return // parent is never canceled } // 2.接着判断一下 父ctx 是否已经被取消 select { case <-done: // 2.1 如果 父ctx 已经被取消了,那就没必要关联了 // 然后这里也要顺便把子ctx给取消了,因为父ctx取消了 子ctx就应该被取消 // 这里是因为还没有关联上,所以需要手动触发取消 // parent is already canceled child.cancel(false, parent.err()) return default: } // 3. 从父 ctx 中提取出 cancelctx 并将子ctx加入到父ctx 的 children 里面 if p, ok := parentcancelctx(parent); ok { p.mu.lock() // double check 一下,确认父 ctx 是否被取消 if p.err != nil { // 取消了就直接把当前这个子ctx给取消了 // parent has already been canceled child.cancel(false, p.err) } else { // 否则就添加到 children 里面 if p.children == nil { p.children = make(map[canceler]struct{}) } p.children[child] = struct{}{} } p.mu.unlock() } else { // 如果没有找到可取消的父 context。新启动一个协程监控父节点或子节点取消信号 atomic.addint32(&goroutines, +1) go func() { select { case <-parent.done(): child.cancel(false, parent.err()) case <-child.done(): } }() }}  
上面的方法可能遇到以下几种情况:
当 parent.done() == nil,也就是 parent 不会触发取消事件时,当前函数会直接返回;
当 child 的继承链包含可以取消的上下文时,会判断 parent 是否已经触发了取消信号;
如果已经被取消,child 会立刻被取消;
如果没有被取消,child 会被加入 parent 的 children 列表中,等待 parent 释放取消信号;
当父上下文是开发者自定义的类型、实现了 context.context 接口并在 done() 方法中返回了非空的管道时;
运行一个新的 goroutine 同时监听 parent.done() 和 child.done() 两个 channel;
在 parent.done() 关闭时调用 child.cancel 取消子上下文;
propagatecancel 的作用是在 parent 和 child 之间同步取消和结束的信号,保证在 parent 被取消时,child 也会收到对应的信号,不会出现状态不一致的情况。
func parentcancelctx(parent context) (*cancelctx, bool) { done := parent.done() // 如果 done 为 nil 说明这个ctx是不可取消的 // 如果 done == closedchan 说明这个ctx不是标准的 cancelctx,可能是自定义的 if done == closedchan || done == nil { return nil, false } // 然后调用 value 方法从ctx中提取出 cancelctx p, ok := parent.value(&cancelctxkey).(*cancelctx) if !ok { return nil, false } // 最后再判断一下cancelctx 里存的 done 和 父ctx里的done是否一致 // 如果不一致说明parent不是一个 cancelctx pdone, _ := p.done.load().(chan struct{}) if pdone != done { return nil, false } return p, true}ancelctx 的 done 方法会返回一个 chan struct{}:func (c *cancelctx) done() <-chan struct{} { d := c.done.load() if d != nil { return d.(chan struct{}) } c.mu.lock() defer c.mu.unlock() d = c.done.load() if d == nil { d = make(chan struct{}) c.done.store(d) } return d.(chan struct{})}var closedchan = make(chan struct{})  
parentcancelctx 其实就是判断 parent context 里面有没有一个 cancelctx,有就返回,让子context可以“挂靠”到parent context 上,如果不是就返回false,不进行挂靠,自己新开一个 goroutine 来监听。
3.4 timerctx
timerctx 内部不仅通过嵌入 cancelctx 的方式承了相关的变量和方法,还通过持有的定时器 timer 和截止时间 deadline 实现了定时取消的功能:
type timerctx struct { cancelctx timer *time.timer // under cancelctx.mu. 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) } c.mu.lock() if c.timer != nil { c.timer.stop() c.timer = nil } c.mu.unlock()}  
3.5 valuectx
valuectx 是多了 key、val 两个字段来存数据:
type 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)}  
如果 key 和当前 ctx 中存的 value 一致就直接返回,没有就去 parent 中找。最终找到根节点(一般是 emptyctx),直接返回一个 nil。所以用 value 方法的时候要判断结果是否为 nil,类似于一个链表,效率是很低的,不建议用来传参数。
4. 使用建议
在官方博客里,对于使用 context 提出了几点建议:
不要将 context 塞到结构体里。直接将 context 类型作为函数的第一参数,而且一般都命名为 ctx
不要向函数传入一个 nil 的 context,如果你实在不知道传什么,标准库给你准备好了一个 context:todo。
不要把本应该作为函数参数的类型塞到 context 中,context 存储的应该是一些共同的数据。例如:登陆的 session、cookie 等。
同一个 context 可能会被传递到多个 goroutine,别担心,context 是并发安全的。

100V GaN功率器件的特性挑战
工程监测仪器振弦模拟信号采集仪VTN的ADC接口与DAC 接口
提高DS1620的温度分辨率
随着连接器应用越来越广泛,微型化是连接器产品的大势所趋
守护人类听力健康,南卡骨传导耳机新品上市
context 底层原理介绍
补偿式有效值大功率交流稳压电源
华为P20 Pro口碑爆棚,成为春季出游最抢眼拍照神器
5G数据机芯片将用于苹果的新iPhone中
LGD从6月开始向三星供WOLED
不被海外巨头牵鼻子,朗科DDR4台式机内存评测:国产开始雄起
如何判断晶闸管的好坏
智能充电桩应用解决方案
linux无法启动的原因及解决方法
LG电子与恩智浦半导体及Hella Aglaia签订协议 合力研发ADAS综合解决方案
友达观点:LED和3D引领2010电视发展
物联网应用案例——资产管理与追踪
工地扬尘污染监测系统的功能介绍
中国移动A4手机评测:高颜值、长续航,“简单易用”的设计理念
英特尔生命科学可扩展系统框架