看点:[Golang]正确使用Context
01 为什么要引入Context
context.Context是Go中定义的一个接口类型,从1.7版本中开始引入。其主要作用是在一次请求经过的所有协程或函数间传递取消信号及共享数据,以达到父协程对子协程的管理和控制的目的。
需要注意的是context.Context的作用范围是一次请求的生命周期,即随着请求的产生而产生,随着本次请求的结束而结束。如图所示:
02 什么是context.Context
在context包中,我们看到context.Context的定义实际上是一个接口类型,该接口定义了获取上下文的Deadline的函数,根据key获取value值的函数、还有获取done通道的函数。如下:
(资料图片)
typeContextinterface{Deadline()(deadlinetime.Time,okbool)Done()<-chanstruct{}Err()error Value(key interface{}) interface{}}
由定义的接口函数可知,对于传递取消信号的行为我们可以描述为:当协程运行时间达到Deadline时,就会调用取消函数,关闭done通道,往done通道中输入一个空结构体消息struct{}{},这时所有监听done通道的子协程都会收到该消息,便知道父协程已经关闭,需要自己也结束运行。
下面是一个使用Context的简易示例,我们通过该示例来说明父子协程之间是如何传递取消信号的。
func main() { ctx, cancel := context.WithTimeout(context.Background(), 5 * time.Second) defer cancel() go doSomethingCool(ctx) select { case <-ctx.Done(): fmt.Println("oh no, I"ve exceeded the deadline") }}func doSomethingCool(ctx context.Context) { for { select { case <-ctx.Done(): fmt.Println("timed out") return default: fmt.Println("doing something cool") } time.Sleep(500 * time.Millisecond) }}
由示例可知,main协程和doSomething函数之间的唯一关联就是ctx.Done()。当子协程从ctx.Done()通道中接收到输出时(因为超时自动取消或主动调用了cancel函数),即认为是父协程不再需要子协程返回的结果了,子协程就会直接返回,不再执行其他的逻辑。
03 Context的作用一:协程间传递信号
3.1 如何创建带可以传递信号的Context
在开头处我们得知Context本质是一个接口类型。接口类型是需要具体的结构体起来实现的。那我们需要自定义结构体类型来实现这些接口吗?答案是不需要。因为在context包中已经定义好了所需场景的结构体,这些结构体已经帮我们实现了Context接口的方法,在项目中就已经够用了。
在context包中定义有emptyCtx、cancelCtx、timerCtx、valueCtx
四种结构体。其中cancelCtx、timerCtx实现了给子协程传递取消信号。valueCtx结构体实现了父协程和子协程传递共享数据相关。本节我们重点来看跟传递信号相关的Context。
在上面示例中,我们通过context.WithTimeout函数创建了一个带定时取消功能的Context实例,该示例本质上是创建了一个timerCtx结构体的实例。在context包中还有WithCancel、WithDeadline函数也可以创建对应的结构体,其定义如下:
//创建带有取消功能的Contextfunc WithCancel(parent Context) (ctx Context, cancel CancelFunc) //创建带有定时自动取消功能的Contextfunc WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)//创建带有定时自动取消功能的Contextfunc WithDeadline(parent Context, d time.Time) (Context, CancelFunc)
对应的函数创建的结构体及该实例所实现的功能的主要特点如下图所示:
在图中我们看到结构体依次是继承关系。因为在cancelCtx结构体内嵌套了Context(实际上是emptyCtx)、timerCtx结构体内嵌套了cancelCtx结构体,可以认为他们之间存在继承关系。
通过WithTimeout和WithDealine函数创建的Context实际上都是timerCtx结构体,唯一的区别就是WithDeadline函数的第二个参数指定的是最后的时间点,而WithTimeout函数的第二个参数是一段时间。但WithDealine在内部实现中本质上也是将时间点转换成距离当前的时间段。
3.2 为什么Done函数返回值是通道
在Context接口的定义中我们看到Done函数的定义,其返回值是一个输出通道:
Done() <-chan struct{}
在上面的示例中我们看到的子协程是通过监听Context的Done()函数返回的通道来判断父协程是否发送了取消信号的。当父协程调用取消函数时,该取消函数将该通道关闭。关闭通道相当于是一个广播信息,当监听该通道的接收者从通道到中接收完最后一个元素后,接收者都会解除阻塞,并从通道中接收到通道元素类型的零值。
既然父子协程是通过通道传到信号的。下面我们介绍父协程是如何将信号通过通道传递给子协程的。
3.3 父协程是如何取消子协程的
我们发现在Context接口中并没有定义Cancel方法。实际上通过WithCancel函数创建的一个具有可取消功能的Context实例来实现的:
// WithCancel returns a copy of parent whose Done channel is closed as soon as// parent.Done is closed or cancel is called.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) }}
WithCancel函数的返回值有两个,一个是ctx,一个是取消函数cancel。当父协程调用cancel函数时,就相当于触发了关闭的动作,在cancel的执行逻辑中会将ctx的done通道关闭,然后所有监听该通道的子协程就会收到一个struct{}类型的零值,子协程根据此便执行了返回操作。下面是cancel函数实现:
// cancel closes c.done, cancels each of c"s children, and, if// removeFromParent is true, removes c from its parent"s children.func (c *cancelCtx) cancel(removeFromParent bool, err error) { //... d, _ := c.done.Load().(chan struct{})//获取通道 if d == nil { c.done.Store(closedchan) } else { close(d) //关闭通道done } //...}
由源码可知,cancelCtx的cancel函数执行时会关闭通道close(d)。
通过WithCancel函数构造的Context,需要开发者自己设定调用取消函数的条件。而在某些场景下需要设定超时时间,比如调用grpc服务时设置超时时间,那么实际上就是在构造Context的同时,启动一个定时任务,当达到设定的定时时间时,就自动调用cancel函数即可。这就是context包中提供的WithDeadline和WithTimeout函数来构造的上下文。如下是WithDeadline函数的关键实现部分:
func WithDeadline(parent Context, d time.Time) (Context, CancelFunc) { //... c := &timerCtx{ cancelCtx: newCancelCtx(parent), deadline: d, } propagateCancel(parent, c) dur := time.Until(d) //... if c.err == nil { //这里实现定时器,即dur时间后执行cancel函数 c.timer = time.AfterFunc(dur, func() { c.cancel(true, DeadlineExceeded) }) } return c, func() { c.cancel(true, Canceled) }}
WithTimeout函数也是将相对时间timeout转换成绝对的时间点deadline之后,调用的WithDeadline函数。
3.4为什么要通过WithXXX函数构造一个树形结构
很多文章都说,通过WithXXX函数基于Context会衍生出一个Context树,树的每个节点都可以有任意多个子节点Context。如下图表示:
那为什么要构造一个树形结构呢?我们从处理一个请求时经过的多个协程来角度来理解会更容易一些。当一个请求到来时,该请求会经过很多个协程的处理,而这些协程之间的关系实际上就组成了一个树形结构。如下图:
Context的目的就是为了在关联的协程间传递信号和共享数据的,而每个协程又只能管理自己的子节点,而不能管理父节点。所以,在整个处理过程中,Context自然就衍生成了树形结构。
3.5为什么WithXXX函数返回的是一个新的Context对象
通过WithXXX的源码可以看到,每个衍生函数返回来的都是一个新的Context对象,并且都是基于parent Context的。以WithDeadline为例,就是返回的一个timerCtx新的结构体实例。这是因为,在Context的传递过程中,每个协程都能根据自己的需要来定制Context(例如,在上图中,main协程调用goroutine2时要求是600毫秒完成操作,但goroutine2调用goroutine2.1时,要求是500毫秒内完成操作),而这些修改又不能影响之前已经调用的函数,只能对向下传递。所以,通过一个新的Context值来进行传递。
04 Context的作用二:协程间共享数据
Context的另外一个功能就是在协程间共享数据。该功能是通过WithValue函数构造的Context来实现的。我们看下WithValue的实现:
func WithValue(parent Context, key, val interface{}) Context { if parent == nil { panic("cannot create context from nil parent") } if key == nil { panic("nil key") } if !reflectlite.TypeOf(key).Comparable() { panic("key is not comparable") } return &valueCtx{parent, key, val}}
实现代码很简短,我们看到最终返回的是一个valueCtx结构体实例。其中有两点:一是key的类型必须是可比较的。二是value是不能修改的,即具有不可变性。如果需要添加新的值,只能通过WithValue基于原有的Context再生成一个新的valueCtx来携带新的key-value。这也是Context的值在传递过程中是并发安全的原因。从另外一个角度来说,在获取一个key的值的时候,也是递归的一层一层的从下往上查找,如下:
func (c *valueCtx) Value(key interface{}) interface{} { if c.key == key { return c.val } return c.Context.Value(key)}
上面简单介绍了下在协程间调用的时候是如何通过Context共享数据的。
但这里讨论的重点是什么样的数据需要通过Context来共享,而不是通过传参的方式。总结下来有以下两点:
携带的数据作用域必须是在请求范围内有效的。即该数据随着请求的产生而产生,随着请求的结束而结束,不会永久的保存。携带的数据不建议是关键参数,关键参数应显式的通过参数来传递。例如像trace_id之类的,用于维护作用,就适合用在Context中传递。4.1 什么是请求范围(request-scoped)内的数据
这个没有一个明显的划定标准。一般的请求范围的数据就是用来表示该请求的元数据。比如该请求是由谁发出(即user id),该请求是在哪儿发出的(即user ip,请求是从该用户的ip位置发出的)。
例如,如果一个日志对象logger是一个单例那么它也不是一个请求范围内的数据。但如果该logger包含了发送请求的来源信息,以及该请求是否启动了调试功能的开关信息,那么该logger也可以被认为是一个请求范围内的数据。
4.2 使用Context.Value的缺点
使用Context.Value会对降低函数的可读性和表达性。例如,下面是使用Context.Value来携带token验证角色的示例:
func IsAdminUser(ctx context.Context) bool { x := token.GetToken(ctx) userObject := auth.AuthenticateToken(x) return userObject.IsAdmin() || userObject.IsRoot()}
当用户调用该函数的时候,仅仅知道该函数带有一个Context类型的参数。但如果要判断一个用户是否是Admin必须要两部分要说明:一个是验证过的token,一个是认证服务。
我们将该函数的Context移除,然后使用参数的方式来重构,如下:
func IsAdminUser(token string, authService AuthService) bool { x := token.GetToken(ctx) userObject := auth.AuthenticateToken(x) return userObject.IsAdmin() || userObject.IsRoot()}
那么这个函数的可读性和表达性就比重构前提高了很多。调用者通过函数签名就很容易知道要判断一个用户是否是AdminUser,只需要传入token和认证的服务authService即可。
4.3 context.Value的使用场景
一般复杂的项目都会有中间件层以及大量的抽象层。如果将类似token或userid这样简单的参数以参数的方式从第一个函数层层传递,那对调用者来说将会是一种噩梦。如果将这样的元数据通过Context来携带进行传递,将会是比较好的方式。在实际项目中,最常用的就是在中间件中。我们以iris为web框架,来看下在中间件中的应用:
package mainimport ( "context" "github.com/google/uuid" "github.com/kataras/iris/v12")func main() { app := iris.New() app.Use(RequestIDMiddleware) app.Get("/hello", mainHandler) app.Listen("localhost:8080", iris.WithOptimizations)}func RequestIDMiddleware(c iris.Context) { reqID := uuid.New() ctx := context.WithValue(c.Request().Context(), "req_id", reqID) req := c.Request().Clone(ctx) c.ResetRequest(req) c.Next()}func mainHandler(ctx iris.Context) { req_id := ctx.Request().Context().Value("req_id") ctx.Writef("Hello request id:%s", req_id) return}
05 总结
context包是go语言中的一个重要的特性。要想正确的在项目中使用context,理解其背后的工作机制以及设计意图是非常重要的。context包定义了一个API,它提供对截止日期、取消信号和请求范围值的支持,这些值可以跨API以及在Goroutine之间传递。
标签:
推荐
- 看点:[Golang]正确使用Context
- 天天热消息:渝攀两地签订住房公积金协同发展合作协议
- 世界动态:吉娜郎朗被点名批评是怎么回事_吉娜郎朗被点名批评具体内容
- 实时焦点:2023云南怒江州教育体育局直属学校有哪些岗位招聘?
- 每日看点!福鼎税务:“项目管家”助力重点项目跑出加速度
- 当前滚动:2023长春餐饮消费券最新消息(1000万元)
- 环球今头条!坦克世界m48a5技能
- 焦点资讯:莫拉塔谈绝杀:在后点包抄受到责备,没进球的话只能骑自行车回家
- 当前视讯!十堰职业技术学院代码查询_十堰职业技术学院
- 当前热议!广西希麓文化发展有限公司
- 世界看热讯:盒装内酯豆腐
- 天天日报丨薇诺娜护肤品怎么样效果好吗祛斑怎么样_薇诺娜护肤品怎么样
- 当前资讯!汇丰控股以1英镑收购硅谷银行英国子公司
- 【天天新要闻】心脏神经官能症表现症状和焦虑症(心脏神经官能症表现症状)
- 当前快看:国家能源集团新朔铁路连续两月完成外购煤发运任务
- 重点聚焦!现代风格英文怎么写_风格英文怎么写
- 【天天聚看点】英国御前会议_关于英国御前会议的简介
- 【世界报资讯】四只大熊猫凑一桌像在打麻将,动物园回应:它们喜欢坐一起
- 快资讯丨福岛渔民反对核污水排海,渔业将倒退5年!专家:放射性物质不应释放到环境中
- 实时焦点:今日时讯:本泽马我将不得不向人们解释自己 队报揭秘本泽马离开退役事件法国队医称MRI成像没有问题
- 天天微速讯:格式工厂怎样合并视频_格式工厂怎么剪辑视频
- 天天报道:古港遗址_古港
- 世界动态:《狂飙》“高启盛”苏小玎被偶遇 与美女合影有些害羞
- 天天关注:数字电视知多少_关于数字电视知多少简介
- 【热闻】环保验收技术规范_环保验收
- 天天关注:一起同过窗3开演时间2019_一起同过窗3开播时间
- 每日关注!银手镯的钢印是什么 银手镯是按克买还是一口价
- 环球即时:thinfilm
- 全球热推荐:没胃口怎么办快速开胃_没胃口怎么办
- 每日快讯!为什么贾玲宁可长胖也不减肥?当她说出真实原因后,粉丝:心疼!
- 每日视点!什么是所得税收入审计_所得税收入审计是什么意思
- 天天资讯:苹果手机无法连接APPStore_苹果手机无法连接appstore
- 今日热议:iphone7P和iphone8P哪个性能更强?结果却让人出人意料
- 天天快看点丨晨光新材:公司2.3万吨特种有机硅材料项目中的2000吨气凝胶目前正在按计划有序推进
- 全球最新:matlab积分运算_matlab积分
- 世界今日讯!数字家谱_关于数字家谱简介
- 快播:河北一情侣饭店用餐喝光两瓶茅台,服务员捡走酒瓶,行家:赚大了
- 环球报道:财税筹划
- 热点聚焦:苏州一楼盘可“0首付”购房置业顾问:通过申请装修贷抵首付
- 世界微速讯:萧涛涛已在秘鲁国内的秘鲁体育大学完成注册
- 观焦点:微电离光降解
- 环球最新:高中毕业证编号是什么意思_高中毕业证编号是什么
- 焦点热门:价格前线|3月10日新疆棉现货异动提示
- 天天热推荐:东乌珠穆沁旗气象台发布大风蓝色预警【IV级/一般】
- 【环球新要闻】win10更改文件夹图标的方法_win10系统修改文件夹图标的操作方法
- 环球今日讯!业绩下滑投诉处罚频现,这家植发企业靠什么二闯港交所?| IPO棱镜
- 环球今日讯!银杏教育(01851.HK)3月9日收盘跌5.19%
- 讯息:气温“满20减10”,本周末北京猛降温
- 焦点报道:有关兵马俑的故事100字_有关兵马俑的故事
- 微速讯:科协进社区推动科普服务创新发展
- 今日精选:中山港船票提前多久开售?
- 今日最新!连江:挖掘投资潜力 打造产业集群
- 滚动:吴亦凡演过电影有哪些剧_吴亦凡演过电影有哪些
- 世界今日报丨书籍折页怎么双面打印_书籍折页怎么设置
- 全球新动态:lol隐藏分1360_lol隐藏分多少算正常
- 全球新动态:经常吃醋有什么好处_吃醋有什么好处
- 天天速看:Berenberg:上涨空间变小 下调特斯拉(TSLA.US)评级至“持有”
- 【报资讯】伊拉克首都是哪里
- 每日时讯!河南能监办:积极推进电力现货市场交易 强化电力中长期交易监管
- 【世界快播报】刘亚仁已经成为韩国毒王了
- 即时:单宁
- 每日速讯:揉腹功效_腹部按摩的好处
- 【天天报资讯】独立悬架与非独立悬架的区别
- 世界快报:银川金凤区碧水蓝天社区医院就诊通知
- 精选!港股异动|五矿资源(1208.HK)跌超4%2022年归母净利润下滑74%
- 天天热头条丨玩脱了是什么意思
- 当前速读:圣诞礼物什么时候给_圣诞节什么时候送礼物
- 全球速看:采购管理制度
- 焦点热文:歧天路
- 焦点滚动:沈烈烈
- 快看:重拳整治 焦作交警严查“炸街飙车”、非法改装、涉牌涉证等交通违法
- 世界观焦点:藏格矿业:藏青基金拟40.8亿元购买国能矿业34%股权 投资开发盐湖项目
- 观察:千壹理财
- 全球热推荐:重庆去机场可以坐几号线?
- 环球微速讯:如何查找附近圆通快递电话号码
- 即时:3月7日Mysteel硅锰收盘评述
- 天天关注:同居期间流产,男方应该给予补偿吗
- 快消息!烧饼歌
- 实时:日立中央空调&香港设计师张广坚:让别墅生活成为舒适生活的桃花坞
- 当前信息:电脑键盘打不出字怎么办
- 今日关注:当日快讯:众合科技:目前部分客户已经对海纳半导体的产能进行预定
- 全球今日报丨林小娘结局怎么死的
- 世界观焦点:全微分视频讲解_全微分
- 全球速递!打离婚官司,当事人都需要主动申报全部夫妻共同财产
- 天天看热讯:肾穿对身体有影响吗
- 每日热议!达闼科技被曝筹备上市:拟募资5亿美元 曾赴美上市失败
- 每日动态!海上明月共潮生的意思
- 视点!直发膏哪个牌子好知乎_直发膏哪个牌子好
- 天天新动态:23河北银行CD043今日发布发行公告
- 短讯!迷失太空
- 世界最新:韩国政府强征劳工赔偿方案未纳入被告日企引争议,韩外长回应:期待日方今后的诚意行动
- 【全球快播报】上古卷轴5怎么卖东西
- 观焦点:单位解散职工赔偿方案
- 世界快资讯丨电科数字3月6日盘中涨幅达5%
- 天天讯息:北京座机区号开头_北京座机区号
- 世界快看点丨云南发现极度濒危物种!
- 最新消息:大学的毕业设计怎么做
- 环球观焦点:win10系统常见故障_Windows的五大罕见故障
- 全球微头条丨桌面图片_桌面图
- 环球新动态:陆鸿,感动中国!