golang从context源码领悟接口的设计
注:写帖子时go的版本是1.12.7
go
语言中实现一个interface
不用像其他语言一样需要显示的声明实现接口。go
语言只要实现了某interface
的方法就可以做类型转换。go
语言没有继承的概念,只有Embedding
的概念。想深入学习这些用法,阅读源码是最好的方式.Context
的源码非常推荐阅读,从中可以领悟出go
语言接口设计的精髓。
对外暴露Context
接口
Context
源码中只对外显露出一个Context
接口
type Context interface { Deadline() (deadline time.Time, ok bool) Done() <-chan struct{} Err() error Value(key interface{}) interface{} }
对于Context
的实现源码里有一个最基本的实现,就是私有的emptyCtx
,他也就是我们经常使用的context.Background()
底层的实现,他是一个int
类型,实现了Context
接口的所有方法,但都是没有做任何处理,都是返回的默认空值。只有String()
方法,里有几行代码,去判断emptyCtx
的类型来进行相应的字符串输出,String()
方法其实是实现了接口Stringer
。emptyCtx
是整个Context
的灵魂
,为什么这么说,因为你对context
的所有的操作都是基于他去做的再次封装。
注意一下Value(key interface{}) interface{}
,因为还没有泛型
,所以能用的做法就是传递或者返回interface{}
。不知道Go2
会不会加入泛型
,说是会加入,但是还没有出最终版,一切都是未知的,因为前一段时间还说会加入try
,后来又宣布放弃。
type emptyCtx int func (*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 } func (e *emptyCtx) String() string { switch e { case background: return "context.Background" case todo: return "context.TODO" } return "unknown empty Context" } var ( background = new(emptyCtx) todo = new(emptyCtx) )
在使用Context
时我们能直接得到就是background
和todo
func Background() Context { return background } func TODO() Context { return todo }
其他所有对外公开的方法都必须传入一个Context
做为parent
,这里设计的很巧妙,为什么要有parent
后面我会详细说。
可以cancel掉的Context
可以cancel掉的context有三个公开的方法,也就是,是否带过期时间的Context
func WithCancel(parent Context) (ctx Context, cancel CancelFunc) func WithDeadline(parent Context, d time.Time) (Context, CancelFunc) func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
Context
只用关心自己是否Done()
,具体这个是怎么完成的他并不关心,是否可以cancel
掉也不是他的业务,所以源码中把这部分功能分开来。Context
最常用的功能就是去监控他的Done()
是否已完成,然后判断完成的原因,根据自己的业务展开相应的操作。要提一下Context
是线程安全的,他在必要的地方都加了锁处理。Done()
的原理:其实是close
掉了channel
所以所有监控Done()
方法都能知道这个Context
执行完了。
ctx, cancel := context.WithTimeout(ctx, 100*time.Millisecond) defer cancel() v, err := DoSomething(ctx) if err != nil { return err } select { case <-ctx.Done(): return ctx.Err() case out <- v: }
我这里不缀述Context
是如何使用的。这篇帖子主要分析的是源码。Context
可以被cancel
掉需要考虑几个问题:
- 如何处理父或子
Context
的cancel
。 -
cancel
后Context
是否也应该删除掉。
我们从源码中来找到答案。
看一下canceler
的接口,这是一个独立的私有接口,和Context
接口独立开来,Context
只做自己的事,并不用关心自己有啥附加的功能,比如现在说的cancel
功能,这也是一个很好的例子,如果有需要对Context
进行扩展,可以参考他们的代码。
type canceler interface { cancel(removeFromParent bool, err error) Done() <-chan struct{} }
和两个错误
var Canceled = errors.New("context canceled") var DeadlineExceeded error = deadlineExceededError{}
是个是被主动Cancel
的错误和一个超时
的错误,这两个错误是对外显露的,我们也是根据这两个Error
判断Done()
是如何完成的。
实现canceler
接口的是结构体cancelCtx
// that implement canceler. type cancelCtx struct { Context mu sync.Mutex // protects following fields done 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 }
注意:
cancelCtx
把Context
接口Embedding
进去了,也就是说cancelCtx
多重实现接口,不但是个canceler
类型也是一个Context
类型。
源码中cancelCtx
并没有实现Context
接口中的所有的方法,这就是Embedding
的强大之处,Context
接口的具体实现都是外部传进来的具体Context
实现类型来实现的eg:cancelCtx{Context: xxxx}
。
还要注意一点就是这两个接口都有各自的Done()
方法,cancelCtx
有实现自己的Done()
方法,也就是说无论转换成canceler
接口类型还是Context
类型调用Done()
方法时,都是他自己的实现
以cancelCtx
为基础还有一个是带过期时间的实现timerCtx
type timerCtx struct { cancelCtx timer *time.Timer // Under cancelCtx.mu. deadline time.Time }
timerCtx
是WithDeadline
和WithTimeout
方法的基础。
func WithDeadline(parent Context, d time.Time) (Context, CancelFunc) func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
WithCancel
需要调用者主动去调用cancel
,其他的两个,就是有过期时间,如果不主动去调用cancel
到了过期时间系统会自动调用。
上面我有说过
context
包中Background()
和TODO()
方法,是其他所有公开方法的基础,因为其他所有的公开方法都需要传递进来一个Context
接口做为parent
。这样我们所有创建的新的Context
都是以parent
为基础来进行封装和操作
看一下cancelCtx
的是如何初始化的
func newCancelCtx(parent Context) cancelCtx { return cancelCtx{Context: parent} } func WithCancel(parent Context) (ctx Context, cancel CancelFunc) { c := newCancelCtx(parent) propagateCancel(parent, &c) return &c, func() { c.cancel(true, Canceled) } }
propagateCancel
回答了我们第一个问题
如何处理父或子
Context
的cancel
。
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]struct{}) } p.children[child] = struct{}{} } p.mu.Unlock() } else { go func() { select { case <-parent.Done(): child.cancel(false, parent.Err()) case <-child.Done(): } }() } }
propagateCancel
做了以下几件事
- 检查
parent
是否可以cancel
- 检查
parent
是否是cancelCtx
类型
2.1. 如果是,再检查是否已经cancel
掉,是则cancel掉child
,否则加入child
2.2. 如果不是,则监控parent
和child 的Done()
我们看一下timerCtx
的具体实现
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) } }
我们去查看所有对cancel
的调用会发现
func WithCancel(parent Context) (ctx Context, cancel CancelFunc) { c := newCancelCtx(parent) propagateCancel(parent, &c) return &c, func() { c.cancel(true, Canceled) } } func WithDeadline(parent Context, d time.Time) (Context, CancelFunc) { if cur, ok := parent.Deadline(); ok && cur.Before(d) { // The current deadline is already sooner than the new one. return WithCancel(parent) } c := &timerCtx{ cancelCtx: newCancelCtx(parent), deadline: d, } propagateCancel(parent, c) dur := time.Until(d) if dur <= 0 { c.cancel(true, DeadlineExceeded) // deadline has already passed return c, func() { c.cancel(false, Canceled) } } c.mu.Lock() defer c.mu.Unlock() if c.err == nil { c.timer = time.AfterFunc(dur, func() { c.cancel(true, DeadlineExceeded) }) } return c, func() { c.cancel(true, Canceled) } }
返回的cancel
方法都是func() { c.cancel(true, Canceled) }
回答了我们的第二个问题
cancel
后Context
是否也应该删除掉。
所有创建的可以cancel
掉的方法都会被从parent
上删除掉
保存key/value
信息的Context
Context
还有一个功能就是保存key/value
的信息,从源码中我们可以看出一个Context
只能保存一对,但是我们可以调用多次WithValue
创建多个Context
func WithValue(parent Context, key, val interface{}) Context { if key == nil { panic("nil key") } if !reflect.TypeOf(key).Comparable() { panic("key is not comparable") } return &valueCtx{parent, key, val} }
在查询key
的时候,是一个向上递归的过程:
func (c *valueCtx) Value(key interface{}) interface{} { if c.key == key { return c.val } return c.Context.Value(key) }
总结一下
- 接口要有边界,要简洁。
- 对外公开的部分要简单明了。
- 提炼边界方法和辅助实现部分,隐藏细节。
低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。
持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。
转载内容版权归作者及来源网站所有,本站原创内容转载请注明来源。
- 上一篇
如何在Windows上使用Python进行开发
如何在Windows上使用Python进行开发本文由葡萄城技术团队于原创并首发 转载请注明出处:葡萄城官网,葡萄城为开发者提供专业的开发工具、解决方案和服务,赋能开发者。 一直以来C#都是微软在编程语言方面最为显著的Tag,但时至今日Python已经从一个小众语言,变成了世界编程语言排行榜排名前列的语言了。 Python也在Web开发、网络爬虫、数据分析、大数据处理、机器学习、科学计算及绘图等领域有着不错的天然优势和不俗的表现。微软再从收购了Github后,在开源社区投入的力度越来越大,所以对于Python的支持,和为Python社区提供更多的贡献,微软本身也承担起了更多的责任。 所以近日,微软上线了一套Python教程《Develp with Python on Windows》,文档内容包括设置Python开发环境、在Windows与WSL子系统中安装相应开发工具,以及如何集成VS Code与Git工具并进行开发等。下来也让我们先来看看如何配置Python开发环境以及Hello World教程。 设置开发环境对于不熟悉 Python 的新手, 我们建议从 Microsoft Sto...
- 下一篇
({} + {}).length的答案结果分析详解
JavaScript的({} + {}).length结果是什么?码笔记告诉你答案是30,那么,为什么是30呢?详解如下: ({} + {}).length答案详解 ({} + {}).length等价于({}.toString() + {}.toString()).length ({}).length结果为undefined,这是因为对象{}没有length属性,所以是undefined 由于javascript是弱类型语言,加法运算间接调用了对象的toString()方法,其结果是字符串的相加,于是{}.toString()的值为[object Object] 码笔记来数一下[object Object],为15,如下所示: [ o b j e c t O b j e c t ] 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 所以,最终15+15=30 懂了吗?码笔记梳理一下: ({} + {}).length ->> ({}.toString() + {}.toString()).length {}.toString() ->> ...
相关文章
文章评论
共有0条评论来说两句吧...
文章二维码
点击排行
推荐阅读
最新文章
- CentOS8安装MyCat,轻松搞定数据库的读写分离、垂直分库、水平分库
- SpringBoot2全家桶,快速入门学习开发网站教程
- SpringBoot2整合MyBatis,连接MySql数据库做增删改查操作
- CentOS7,CentOS8安装Elasticsearch6.8.6
- CentOS关闭SELinux安全模块
- CentOS8,CentOS7,CentOS6编译安装Redis5.0.7
- SpringBoot2更换Tomcat为Jetty,小型站点的福音
- Eclipse初始化配置,告别卡顿、闪退、编译时间过长
- Docker安装Oracle12C,快速搭建Oracle学习环境
- CentOS8编译安装MySQL8.0.19