1. 内部结构之 - timerCtx 。

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

- 里面有一个 timer,用来触发超时之后的 回调函数,也就是超时之后,帮你 cancel 一下。理论上,你不用在结构体里存一份这个,这里存了这个指针,主要是用来取消这个定时触发,基本上就是因为一个定时器你如果不需要了,就要马上回收这个资源,否则会很耗资源的。例如,假设,你有一个十分钟的超时触发机制,不过由于某些原因,这个context被其他东西cancel了,那么这十分钟内,内部的定时器还要继续工作,这难道不是很浪费么,就像你们几个人玩游戏,让一个人记录分数,这时你们上司来了,这个游戏完不成了,难道那个记录分数的同事还傻乎乎的继续记么,,,,很明显太二了,所以要及时的终止这个计时器。

- 这个deadline就是那个预设的超时的绝对时间。同时,实现了Context的 Deadline接口。

- 关键就是里面的 cancelCtx,首先这是一个结构体,不是接口,也不是指针。可以从这个源码里来思考思考,什么时候在struct里面直接用struct,什么时候在里面埋一个interface,什么时候在里面用一个 *struct。把timerCtx分开成两个单词,一个是timer,一个是Context,那么上面两个字段承载了有关【time】的东西,那么可以猜到,这个cancelCtx就承载了【Context】的功能。所以来看看这个cancelCtx是个什么鬼?

1.1 cancelCtx 的结构分析。

type cancelCtx struct {
Context done chan struct{} // closed by the first cancel call. mu sync.Mutex
children map[canceler]bool // set to nil by the first cancel call
err error // set to non-nil by the first cancel call
}

  

- 先来插一句,代码如何抽象,当然是见仁见智,但是这里把cancelCtx放在 timerCtx里面,而且是以 struct的形式,没有用指针,也没有用interface,我认为,,我认为是因为,这个cancelCtx是属于timerCtx的一部分,正是这一部分体现了,timerCtx 确实是一个Context。

- done字段:作为一个Context,必须要有 Done()方法,这个方法要返回一个 chan struct{}, 那么很明显,这个字段就是来干这个的。

- err字段: 同上,作为一个Context,必须要有 Err()方法,,,返回一个错误,很明显,这个字段就是用来干这个的。

- mu字段: 用来保证并发操作的。

- children字段:golang 的 context 包用一种 【父-子】的关系来管理【一个业务需求】引发的【各个子goroutine】所关联的各个【Context】,很明显,这个children字段用来记录,谁是我的儿子。

- Context字段:这是一个接口,用来存放【父Context】。注意到,要想成为 Context必须实现四个方法。最后一个方法就是Value() 。我们发现,现在为止只有三个被实现了,那就是Deadline,Done,Err。那么谁来实现Value呢。。。就是这个埋进来的Context了。也就是说,你作为一个timerCtx,你仅仅有【时间】的概念,你不应该有【Value】的概念,【Value】的概念,你从你的【父Context】那里直接伸手去要,恩,大概就这个意思。{插:这个Context包还讲解了golang的面向对象风格是啥么样的形态,所以说看源码涨知识啊。。}。

- context包提供了内部cancel的机制,主要就是靠这个cancelCtx结构体,它提供了一个私有的 cancel 方法来处理这个事情。

- 当在外部调用 WithCancel WithTimeout WithDeadline 三个方法时,其实都是新建了一个cancelCtx。

- 看一下 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
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)
}
}

  - 第一个事实,全包只有两个cancel方法,第一个就是这个cancelCtx提供的cancel方法,而第二个,是timerCtx提供的cancel方法,后者也是在前者的基础上多做了一些关于定时器的资源的回收而已。

  - cancel方法接收两个参数,第一个是 是否从【父Context】上删除这个子节点,第二个是写出你为啥要cancel这个Context。

  - context包的作者设计的是,只要Err是空,那么这个Context就还没有被cancel掉,只要Err不为空,就说明Context已经被cancel掉了。所以这个方法里有关于这个的监测部分。

  - cancel方法做了这样几件事情。【一,将传入的错误记录到Context的err中,标志一下,我已经cancel了。】【二,close(c.done)关闭这个通道,这在外部是可知的,通过Done()接口返回的channel就是在这里关闭的。】【三,递归的将{子Context}全部cancel掉,并将自身的children字段清空。】【四,根据removeChile参数的值,从而决定是否将自身从{父Context}那里清除掉。】

  - 顺便看看removeChild这个函数。基本上就是从【父Context】的children字段里,delete自身。

  - 再来顺便看看timerCtx的cancel方法,看看增加了什么功能:

func (c *timerCtx) cancel(removeFromParent bool, err error) {
c.cancelCtx.cancel(false, err)//为啥这里要传false?
if removeFromParent {//为啥一定在这里去处理removeChild这个事情?
// Remove this timerCtx from its parent cancelCtx's children.
removeChild(c.cancelCtx.Context, c)
}
c.mu.Lock()
if c.timer != nil {
c.timer.Stop()
c.timer = nil
}
c.mu.Unlock()
}

  - 可以看到很蹊跷的一点,为什么 removeFromParent 这个过程一定要在这里做,而不能这样【c.cancelCtx.cancel(removeFromParent,err)】?好,答案就是removeChild函数接受两个参数,一个是【父Context】,一个是【自身】,这就是语义。当一个timerCtx想要从【父Context】那里清除自己的时候,【自身】这个语义代表的就是这个timerCtx,而不是timerCtx内部的cancelCtx。另外,从removeChild的代码来看,其实就是从一个map里delete一个key,当时在timerCtx初始化的时候,存入的key就是timerCtx,所以在removeChild的出后,当然要delete自身这个timerCtx。

  - 除了上述,timerCtx的cancel方法仅仅是多了个对于定时器的资源的回收而已,无他耳。

1.2 图形化这整个结构

  - 方块表示timerCtx,圆形表示cancelCtx(除了backgroundctx之外)。

  - 实线箭头表示 【父Context的指向】。

  - 虚线箭头表示 【子Context的指向】。

  - 箭头的起点都是从圆形的cancelCtx出发,表示无论是 【父Context】还是【子Context】,这两者信息都存在 cancelCtx这个内部结构中。

  - 箭头的终点都是方块,表示【父Context】和【子Context】都是指最外部的结构,上图中也就是这个timerCtx。

  - 这个图不包括 WithCancel 和 WithValue 函数得到的Context。

1.3 propagateCancel函数的分析

// propagateCancel arranges for child to be canceled when parent is.
func propagateCancel(parent Context, child canceler) {
if parent.Done() == nil {
return // parent is never canceled
}
if p, ok := parentCancelCtx(parent); ok {
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]bool)
}
p.children[child] = true
}
p.mu.Unlock()
} else {
go func() {
select {
case <-parent.Done():
child.cancel(false, parent.Err())
case <-child.Done():
}
}()
}
}

  - 第一,这个函数在整个包里被两个函数所调用到,两个函数里都是在初始化新的Context的时候用到这个函数。

  - 第二,函数的注释说明了,这个函数用来负责这样一个事情,当 【父Context】被cancel的时候,【子Context】也必须被cancel,这个机制。

  - 所以,第一句很明显,如果【父Context】不会被cancel的话,那么也就不需要这个propagate的过程了,就直接return。更进一步发现,如果一个Context的Done()返回的是nil,在这个包的设计思想里面,也就是相当于这个Context不会被cancel。这两者就是同义的。{Done()==nil} 同义于{Context不会被cancel}。

  - 接下来的事情应该是这样,应该把新生成的这个Context放到【父Context】的【children】字段里,只有这样,才能让【父Context】来管理各【子Context】。

  - 而上文和上图中都已经说过了,cancelCtx里的children字段就是来管理【子Context】的。

  - 所以,我先得获得 【父Context】内部的【cancelCtx】,恩,这就是 parentCancelCtx 函数的作用,,就是获得一个【父Context】内部的【cancelCtx】。

  - 由于 valueCtx的存在(后文说明),导致【父Context】并不一定内部就有一个cancelCtx,所以,要一直往上找,注意看上面的图,一直沿着这棵树往上找,直到找到一个【Context】内部具有【cancelCtx】。好了,我新建的这个Context,和我找到的这个【父Context】就在这一步产生了【父子】的关系。

  - 假设一直找,一直找,都找不到一个内部拥有【cancelCtx】的家伙当【父】,那么看这段代码的最后:

go func() {
select {
case <-parent.Done():
child.cancel(false, parent.Err())
case <-child.Done():
}
}()

  - (??? ) 新开一个goroutine,监听两个channel,一个就是看看【父Context】的Done是否已经关了,如果关了,这个【子】也就直接cancel得了,并且不用告诉【父】了,因为你根本就没有在【父】的【children】里存在过,,,,,,属于年三十的兔子,有你过年,没你也过年。

  - (???) 第二个监听的是新建的这个【子Context】的Done(),如果这个已经关闭了,那么就直接退出。

  - (???) 感觉整个程序根本走不到这个go func里来,因为一开头已经判断了,如果parent.Done()==nil,则直接退出。如果parent.Done!=nil,那么,整个Context的树,肯定有一个节点是内部支持cancelCtx的,那么也依然不会走到这个go func()  里,,,。。我哪里有疏忽的地方,请各位看官指正,这一块。。。。。。  

golang context 剖析 1.7.4 版本的更多相关文章

  1. 带小伙伴手写 golang context

    前言 - context 源码 可以先了解官方 context.go 轮廓. 这里捎带保存一份当前 context 版本备份. // Copyright 2014 The Go Authors. Al ...

  2. Golang Context 的原理与实战

    本文让我们一起来学习 golang Context 的使用和标准库中的Context的实现. golang context 包 一开始只是 Google 内部使用的一个 Golang 包,在 Gola ...

  3. golang context包

    go context标准库 context包在Go1.7版本时加入到标准库中.其设计目标是给Golang提供一个标准接口来给其他任务发送取消信号和传递数据.其具体作用为: 可以通过context发送取 ...

  4. Golang Context 详细介绍

    Golang context 本文包含对context实现上的分析和使用方式,分析部分源码讲解比价多,可能会比较枯燥,读者可以直接跳过去阅读使用部分. ps: 作者本着开源分享的精神撰写本篇文章,如果 ...

  5. Golang Context 包详解

    Golang Context 包详解 0. 引言 在 Go 语言编写的服务器程序中,服务器通常要为每个 HTTP 请求创建一个 goroutine 以并发地处理业务.同时,这个 goroutine 也 ...

  6. golang context学习记录1

    1.前言 一个请求,可能涉及多个API调用,多个goroutine,如何在多个API 之间,以及多个goroutine之间协作和传递信息,就是一个问题. 比如一个网络请求Request,需要开启一些g ...

  7. 【GoLang】golang context channel 详解

    代码示例: package main import ( "fmt" "time" "golang.org/x/net/context" ) ...

  8. Golang context包解读

    Context 通常被译作 上下文 ,一般理解为程序单元的一个运行状态.现场.快照,而翻译中 上下 又很好地诠释了其本质,上下上下则是存在上下层的传递, 上 会把内容传递给 下 . 在Go语言中,程序 ...

  9. golang 性能剖析pprof

    作为一个golang coder,使用golang编写代码是基本的要求. 能够写出代码,并能够熟悉程序执行过程中各方面的性能指标,则是更上一层楼. 如果在程序出现性能问题的时候,可以快速定位和解决问题 ...

随机推荐

  1. Java 集合工具类---------- Collections类

  2. <%@ include > 与< jsp:include >

    include指令表示在JSP编译时插入一个包含文本或者代码的文件,把文件中的文本静态地包含过去.也就是说,会把被包含的页面拷贝到包含的页面中指令所在的位置. 语法格式:<%@ include ...

  3. DPF.Android.Native.Components.v2.8.1 for delphi xe6 使用DPFJAlertDialog遇到的问题

    使用DPFJAlertDialog控件时发现DPFJAlertDialog1Click不能捕获到对话框到底按了那个按键,上网搜索后找到了解决方法: 打开DPF.Android.JAlertDialog ...

  4. Java集合类总结 (一)

    集合类中的基本接口 集合类中最基础的接口是Collection: public interface Collection<E> { boolean add(E element); Iter ...

  5. 转:[web]javascript 增加表單的input

    利用javascript增加form的input 這是js的部份 //用來區分不同input的name var element_count = 0; function add_element(obj) ...

  6. Transaction And Lock--快照事务隔离级别

    --================================================--准备数据GOCREATE DATABASE DB5GOUSE DB5GOCREATE TABLE ...

  7. Nexus 私有仓库

    Nexus3.6和Nexus2.x安装不同,2.x版本需要安装服务,再启动.而3.6版本则更加简单. 步骤如下: jdk环境:1.8 Nexus3.6解压(注意,路径不要带空格及中文),解压后有两个文 ...

  8. React + Python 七月小说网 功能设计(二)

    概述 在通过对世面上的各种小说网站简单了解之后(PS:好多盗版网站真的好丑哦.),去除花里胡哨的功能,保留实用功能. 初步制定了以下几个功能需求,当然,所有需求功能都是我自己设计.自己评审,大不了到时 ...

  9. NSStream文件流

    1.文件流的使用 NSString *filePath = @"/Users/JHQ0228/Desktop/test.txt"; NSData *data = [@"h ...

  10. Kubernetes -- Server 部署

    1.  Node 节点配置文件 1.1 下载相关的软件 wget https://dl.k8s.io/v1.13.1/kubernetes-server-linux-amd64.tar.gz wget ...