当前位置 博文首页 > GOLANG使用Context实现传值、超时和取消的方法

    GOLANG使用Context实现传值、超时和取消的方法

    作者:winlin 时间:2021-07-07 17:43

    GO1.7之后,新增了context.Context这个package,实现goroutine的管理。

    Context基本的用法参考GOLANG使用Context管理关联goroutine。

    实际上,Context还有个非常重要的作用,就是设置超时。比如,如果我们有个API是这样设计的:

    type Packet interface {
      encoding.BinaryMarshaler
      encoding.BinaryUnmarshaler
    }
    
    type Stack struct {
    }
    func (v *Stack) Read(ctx context.Context) (pkt Packet, err error) {
      return
    }
    
    

    一般使用是这样使用,创建context然后调用接口:

    ctx,cancel := context.WithCancel(context.Background())
    stack := &Stack{}
    pkt,err := stack.Read(ctx)
    

    那么,它本身就可以支持取消和超时,也就是用户如果需要取消,比如发送了SIGINT信号,程序需要退出,可以在收到信号后调用cancel:

    sc := make(chan os.Signal, 0)
    signal.Notify(sc, syscall.SIGINT, syscall.SIGTERM)
    go func() {
      for range sc {
        cancel()
      }
    }()
    

    如果需要超时,这个API也不用改,只需要调用前设置超时时间:

    ctx,cancel := context.WithTimeout(context.Background(), 3*time.Second)
    defer cancel()
    pkt,err := stack.Read(ctx)
    

    如果一个程序在运行,比如Read在等待,那么在没有人工干预的情况下,那就应该自己运行就好了。而人工干预,也就是需要取消,比如要升级程序了,或者需要停止服务了,都属于这种取消操作。而超时,一般是系统的策略,因为不能一直等下去,就需要在一定时间没有反应时终止服务。实际上context这两个都能支持得很好,而且还不影响Read本身的逻辑,在Read中只需要关注context是否Done:

    func (v *Stack) Read(ctx context.Context) (pkt Packet, err error) {
      select {
      // case <- dataChannel: // Parse packet from data channel.
      case <- ctx.Done():
        return nil,ctx.Err()
      }
      return
    }
    

    这是为何context被接纳成为标准库的包的缘故了吧,非常之强大和好用,而又非常简单。一行context,深藏功与名。

    另外,Context还可以传递上下文的Key-Value对象,比如我们希望日志中,相关的goroutine都打印一个简化的CID,那么就可以用context.WithValue,参考go-oryx-lib/logger。

    jsjbwy
    下一篇:没有了