亲宝软件园·资讯

展开

Context到go设计理念

陈雪锋 人气:0

引言

context包比较小,是阅读源码比较理想的一个入手,并且里面也涵盖了许多go设计理念可以学习。
go的Context作为go并发方式的一种,无论是在源码net/http中,开源框架例如gin中,还是内部框架trpc-go中都是一个比较重要的存在,而整个 context 的实现也就不到600行,所以也想借着这次机会来学习学习,本文基于go 1.18.4。

话不多说,例:

为了使可能对context不太熟悉的同学有个熟悉,先来个example ,摘自源码:

我们利用WithCancel创建一个可取消的Context,并且遍历频道输出,当 n==5时,主动调用cancel来取消。
而在gen func中有个协程来监听ctx当监听到ctx.Done()即被取消后就退出协程。

func main(){
gen := func(ctx context.Context) <-chan int {
dst := make(chan int)
n := 1
go func() {
for {
select {
case <-ctx.Done():
                                        close(dst)
return // returning not to leak the goroutine
case dst <- n:
n++
}
}
}()
return dst
}
 
ctx, cancel := context.WithCancel(context.Background())
// defer cancel() // 实际使用中应该在这里调用 cancel
 
for n := range gen(ctx) {
fmt.Println(n)
if n == 5 {
                       cancel() // 这里为了使不熟悉 go 的更能明白在这里调用了 cancel()
break
}
}
// Output:
// 1
// 2
// 3
// 4
// 5
}

这是最基本的使用方法。

概览

对于context包先上一张图,便于大家有个初步了解(内部函数并未全列举,后续会逐一讲解):

最重要的就是右边的接口部分,可以看到有几个比较重要的接口,下面逐一来说下:

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

首先就是Context接口,这是整个context包的核心接口,就包含了四个 method,分别是:

Deadline() (deadline time.Time, ok bool) // 获取 deadline 时间,如果没有的话 ok 会返回 false
Done() <-chan struct{} // 返回的是一个 channel ,用来应用监听任务是否已经完成
Err() error // 返回取消原因 例如:Canceled\DeadlineExceeded
Value(key any) any // 根据指定的 key 获取是否存在其 value 有则返回

可以看到这个接口非常清晰简单明了,并且没有过多的Method,这也是go 设计理念,接口尽量简单、小巧,通过组合来实现丰富的功能,后面会看到如何组合的。

再来看另一个接口canceler,这是一个取消接口,其中一个非导出 method cancel,接收一个bool和一个error,bool用来决定是否将其从父Context中移除,err用来标明被取消的原因。还有个Done()和Context接口一样,这个接口为何这么设计,后面再揭晓。

type canceler interface{  
cancel(removeFromParent bool, err error)  
Done() <-chan struct{}
}

接下来看这两个接口的实现者都有谁,首先Context直接实现者有 valueCtx(比较简单放最后讲)和emptyCtx

而canceler直接实现者有cancelCtx和timerCtx ,并且这两个同时也实现了Context接口(记住我前面说得另外两个是直接实现,这俩是嵌套接口实现松耦合,后面再说具体好处),下面逐一讲解每个实现。

空的

见名知义,这是一个空实现,事实也的确如此,可以看到啥啥都没有,就是个空实现,为何要写呢?

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 any) any {  return nil}
func (e *emptyCtx) String() string {  switch e {  case background:    return "context.Background"  case todo:    
return "context.TODO"  }  return "unknown empty Context"}

再往下读源码会发现两个有意思的变量,底层一模一样,一个取名叫 background,一个取名叫todo,为何呢?耐心的可以看看解释,其实是为了方便大家区分使用,背景 是在入口处来传递最初始的context,而todo 则是当你不知道用啥,或者你的函数虽然接收ctontext参数,但是并没有做任何实现时,那么就使用todo即可。后续如果有具体实现再传入具体的上下文。所以上面才定义了一个空实现,就为了给这俩使用呢,这俩也是我们最常在入口处使用的。

var (
  background = new(emptyCtx)
  todo       = new(emptyCtx)
)
 
// Background returns a non-nil, empty Context. It is never canceled, has no
// values, and has no deadline. It is typically used by the main function,
// initialization, and tests, and as the top-level Context for incoming
// requests.
func Background() Context {
  return background
}
 
// TODO returns a non-nil, empty Context. Code should use context.TODO when
// it's unclear which Context to use or it is not yet available (because the
// surrounding function has not yet been extended to accept a Context
// parameter).
func TODO() Context {
  return todo
}

下面再看看具体的定义吧。

cancelCtx与timerCtx、valueCtx

type cancelCtx struct{
  Context
  mu       sync.Mutex  // 锁住下面字段的操作
  // 存放的是 chan struct{}, 懒创建,
  //  只有第一次被 cancel 时才会关闭
  done     atomic.Value  
  // children 存放的是子 Context canceler ,并且当第一次被 cancel 时会被
  // 设为 nil
  children map[canceler]struct{}
  //  第一次被调用 cancel 时,会被设置
  err      error                 
}
 
type timerCtx struct{
 cancelCtx
 timer *time.Timer // 定时器,用来监听是否超时该取消
 deadline time.Time // 终止时间
}
 
type valueCtx struct {
 Context
 key, val any
}

这里就看出来为何cancelCtx为非导出了,因为它通过内嵌Context接口也也是实现了Context的。并且通过这种方式实现了松耦合,可以通过 WithCancel(父Context) (ctx Context,cancel CancelFunc) 来传递任何自定义的Context实现。

而timerCtx是嵌套的cancelCtx,同样他也可以同时调用Context接口所有 method与cancelCtx所有method ,并且还可以重写部分方法。而 valueCtx和上面两个比较独立,所以直接嵌套的Context。

这里应该也看明白了为何canceler为何一个可导出Done一个不可导出 cancel,Done是重写Context的method会由上层调用,所以要可导出, cancel则是由return func(){c.cancel(false,DeadlineExeceed) 类似的封装导出,所以不应该导出。

这是go中推崇的通过组合而非继承来编写代码。其中字段解释我已在后面注明,后面也会讲到。看懂了大的一个设计理念,下面我们就逐一击破,通过上面可以看到timerCtx其实是复用了cancelCtx能力,所以cancelCtx最为重要,下面我们就先将cancelCtx实现。

取消

它非导出,是通过一个方法来直接返回Context类型的,这也是go理念之一,不暴露实现者,只暴露接口(前提是实现者中的可导出method不包含接口之外的method, 否则导出的method外面也无法调用)。

先看看外部构造函数WithCancel,

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}
}

接下来就来到比较重要的func  propagateCancel,我们看看它做了啥,

首先是判断父context的Done()方法返回的channel是否为nil,如果是则直接返回啥也不做了。这是因为父Context从来不会被取消的话,那就没必要进行下面动作。这也表名我们使用.与猫(上下文。Background()) 这个函数是不会做任何动作的。

 done := parent.Done()
  if done == nil {
    return // parent is never canceled
  }

接下里就是一个select ,如果父Context已经被取消了的话,那就直接取消子Context就好了,这个也理所应当,父亲都被取消了,儿子当然也应该取消,没有存在必要了。

select {
  case <-done:
    // parent is already canceled
    child.cancel(false, parent.Err())
    return
  default:
  }

如果父 Context 没有被取消,这里就会做个判断,

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 {
    atomic.AddInt32(&goroutines, +1)
    go func() {
      select {
      case <-parent.Done():
        child.cancel(false, parent.Err())
      case <-child.Done():
      }
    }()
  }

接下来看看parentCancelCtx的实现:它是为了找寻parent底下的 *cancelCtx,

它首先检查parent.Done()如果是一个closedchan这个频道 在初始化时已经是个一个被关闭的通道或者未nil的话(emptyCtx)那就直接返回 nil,false。

func parentCancelCtx(parent Context) (*cancelCtx, bool) {
  done := parent.Done()
  if done == closedchan || done == nil {
    return nil, false
}
var closedchan = make(chan struct{})
func init() {
  close(closedchan)
p, ok := parent.Value(&cancelCtxKey).(*cancelCtx)
if !ok {
  return nil, false
}

接着判断是否parent是*cancelCtx类型,如果不是则返回nil,false,这里调用了parent.Value方法,并最终可能会落到value方法:

func value(c Context, key any) any {
  for {
    switch ctx := c.(type) {
    case *valueCtx:
      if key == ctx.key {
        return ctx.val
      }
      c = ctx.Context
    case *cancelCtx:
      if key == &cancelCtxKey {
        return c
      }
      c = ctx.Context
    case *timerCtx:
      if key == &cancelCtxKey {
        return &ctx.cancelCtx
      }
      c = ctx.Context
    case *emptyCtx:
      return nil
    default:
      return c.Value(key)
    }
  }
}

可以发现如果嵌套实现过多的话这个方法其实是一个递归调用。

如果是则要继续判断p.done与parent.Done()是否相等,如果没有则说明:*cancelCtx已经被包装在一个自定义实现中,提供了一个不同的包装,在这种情况下就返回nil,false:

pdone, _ := p.done.Load().(chan struct{})
if pdone != done {
  return nil, false
}
return p, true

构造算是结束了,接下来看看如何取消的:

 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
d, _ := c.done.Load().(chan struct{})
  if d == nil {
    c.done.Store(closedchan)
  } else {
    close(d)
  }
     d, _ := c.done.Load().(chan struct{})
  if d == nil {
    c.done.Store(closedchan)
  } else {
    close(d)
  }
if removeFromParent {
    removeChild(c.Context, c)
  }

removeChild也比较简单,当为*cancelCtx就将其从Children内删除,为了保证线程安全也是加锁的。

func removeChild(parent Context, child canceler) {
  p, ok := parentCancelCtx(parent)
  if !ok {
    return
  }
  p.mu.Lock()
  if p.children != nil {
    delete(p.children, child)
  }
  p.mu.Unlock()
}

Done就是返回一个channel用于告知应用程序任务已经终止:这一步是只读没有加锁,如果没有读取到则尝试加锁,再读一次,还没读到则创建一个chan,可以看到这是一个懒创建的过程。所以当用户主动调用CancelFunc时,其实根本就是将c.done内存储的chan close掉,这其中可能牵扯到父关闭,也要循环关闭子Context过程。

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{})
}

cancelCtx主要内容就这么多,接下里就是timerCtx了

计时器

回顾下timerCtx定义,就是内嵌了一个cancelCtx另外多了两个字段timer和deadline,这也是组合的体现。

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

下面就看看两个构造函数,WithDeadline与WithTimeout,WithTimeout就是对WithDealine的一层简单封装。

检查不多说了, 第二个检查如果父context的截止时间比传递进来的早的话,这个时间就无用了,那么就退化成cancelCtx了。

func WithDeadline(parent Context, d time.Time) (Context, CancelFunc) {
  if parent == nil {
    panic("cannot create context from nil parent")
  }
  if cur, ok := parent.Deadline(); ok && cur.Before(d) {
    return WithCancel(parent)
  }
func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc) {
  return WithDeadline(parent, time.Now().Add(timeout))
}

构造timerCtx并调用propagateCancel,这个已经在上面介绍过了。

c := &timerCtx{
    cancelCtx: newCancelCtx(parent),
    deadline:  d,
  }
  propagateCancel(parent, c)

接着会看,会先利用time.直到(d.分时。Now()) 来判断传入的 deadlineTime与当前时间差值,如果在当前时间之前的话说明已经该取消了,所以会直接调用cancel函数进行取消,并且将其从父Context中删除。否则就创建一个定时器,当时间到达会调用取消函数,这里是定时调用,也可能用户主动调用。

dur := time.Until(d)
  if dur <= 0 {
    c.cancel(true, DeadlineExceeded)
    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实现吧,相比较cancelCtx就比较简单了,先取消 cancelCtx,也要加锁,将c.timer停止并赋值nil,这里也是第一次调用才会赋值nil,因为外层还有个c.timer !=nil的判断,所以多次调用只有一次赋值。

func (c *timerCtx) cancel(removeFromParent bool, err error) {
  c.cancelCtx.cancel(false, err)
  if removeFromParent {
    // 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()
}

相比较于cancelCtx还覆盖实现了一个Deadline(),就是返回当前 Context的终止时间。

func (c *timerCtx) Deadline() (deadline time.Time, ok bool) {
  return c.deadline, true
}

下面就到了最后一个内置的valueCtx了。

结构器就更加加单,就多了key,val

type valueCtx struct {
 Context
 key, val any
}

也就有个Value method不同,可以看到底层使用的就是我们上面介绍的value函数,重复复用

func (c *valueCtx) Value(key any) any {
  if c.key == key {
    return c.val
  }
  return value(c.Context, key)
}

几个主要的讲解完了,可以看到不到600行代码,就实现了这么多功能,其中蕴含了组合、封装、结构体嵌套接口等许多理念,值得好好琢磨。下面我们再看看其中有些有意思的地方。我们一般打印字符串都是使用 fmt 包,那么不使用fmt包该如何打印呢?context包里就有相应实现,也很简单,就是 switch case来判断v类型并返回,它这么做的原因也有说:

“因为我们不希望上下文依赖于unicode表”,这句话我还没理解,有知道的小伙伴可以在底下评论,或者等我有时间看看fmt包实现。

func stringify(v any) string {
  switch s := v.(type) {
  case stringer:
    return s.String()
  case string:
    return s
  }
  return "<not Stringer>"
}
 
func (c *valueCtx) String() string {
  return contextName(c.Context) + ".WithValue(type " +
    reflectlite.TypeOf(c.key).String() +
    ", val " + stringify(c.val) + ")"
}

使用Context的几个原则

直接在函数参数传递,不要在struct传递,要明确传递,并且作为第一个参数,因为这样可以由调用方来传递不同的上下文在不同的方法上,如果你在 struct内使用context则一个实例是公用一个context也就导致了协程不安全,这也是为何net包Request要拷贝一个新的Request WithRequest(context go 1.7 才被引入),net包牵扯过多,要做到兼容才嵌入到 struct内。

不要使用nil而当你不知道使用什么时则使用TODO,如果你用了nil则会 panic。避免到处判断是否为nil。

WithValue不应该传递业务信息,只应该传递类似request-id之类的请求信息。

无论用哪个类型的Context,在构建后,一定要加上:defer cancel(),因为这个函数是可以多次调用的,但是如果没有调用则可能导致Context没有被取消继而其关联的上下文资源也得不到释放。

在使用WithValue时,包应该将键定义为未导出的类型以避免发生碰撞,这里贴个官网的例子:

// package user 这里为了演示直接在 main 包定义
// User 是存储在 Context 值
type User struct {
  Name string
  Age  int
}
 
// key 是非导出的,可以防止碰撞
type key int
 
// userKey 是存储 User 类型的键值,也是非导出的。
var userKey key
 
// NewContext 创建一个新的 Context,携带 *User
func NewContext(ctx context.Context, u *User) context.Context {
  return context.WithValue(ctx, userKey, u)
}
 
// FromContext 返回存储在 ctx 中的 *User
func FromContext(ctx context.Context) (*User, bool) {
  u, ok := ctx.Value(userKey).(*User)
  return u, ok
}

那怎么能够防止碰撞呢?可以做个示例:看最后输出,我们在第一行就用 userKey的值0,存储了一个值“a”。

然后再利用NewContext存储了&User,底层实际用的是 context.WithValue(ctx,userKey,u)

读取时用的是FromContext,两次存储即使底层的key值都为0, 但是互不影响,这是为什么呢?

还记得WithValue怎么实现的么?你每调用一次都会包一层,并且一层一层解析,而且它会比较c.key==key,这里记住go的==比较是比较值和类型的,二者都相等才为true,而我们使用type key int所以userKey与0底层值虽然一样,但是类型已经不一样了(这里就是main.userKey与0),所以外部无论定义何种类型都无法影响包内的类型。这也是容易令人迷惑的地方

package main
import (
  "context"
  "fmt"
)
func main() {
  ctx := context.WithValue(context.Background(), , "a")
  ctx = NewContext(ctx, &User{})
  v, _ := FromContext(ctx)
  fmt.Println(ctx.Value(0), v) // Output: a, &{ 0}
}

加载全部内容

相关教程
猜你喜欢
用户评论