介绍

Go1.7加入了一个新的标准库context，它定义了Context类型，专门用来简化 对于处理单个请求的多个 goroutine 之间与请求域的数据、取消信号、截止时间等相关操作，这些操作可能涉及多个 API 调用。
对服务器传入的请求应该创建上下文，而对服务器的传出调用应该接受上下文。它们之间的函数调用链必须传递上下文，或者可以使用WithCancel、WithDeadline、WithTimeout或WithValue创建的派生上下文。当一个上下文被取消时，它派生的所有上下文也被取消。

Go内置两个函数：Background()和TODO()，这两个函数分别返回一个实现了Context接口的background和todo。我们代码中最开始都是以这两个内置的上下文对象作为最顶层的partent context，衍生出更多的子上下文对象。
Background()主要用于main函数、初始化以及测试代码中，作为Context这个树结构的最顶层的Context，也就是根Context。
TODO()，它目前还不知道具体的使用场景，如果我们不知道该使用什么Context的时候，可以使用这个。
background和todo本质上都是emptyCtx结构体类型，是一个不可取消，没有设置截止时间，没有携带任何值的Context。

注意事项

  • 推荐以参数的方式显示传递Context
  • 以Context作为参数的函数方法，应该把Context作为第一个参数。
  • 给一个函数方法传递Context的时候，不要传递nil，如果不知道传递什么，就使用context.TODO()
  • Context的Value相关方法应该传递请求域的必要数据，不应该用于传递可选参数
  • Context是线程安全的，可以放心的在多个goroutine中传递

    Context接口

    context.Context是一个接口，该接口定义了四个需要实现的方法。具体签名如下：
    1. type Context interface {
    2.   Deadline() (deadline time.Time, ok bool)
    3.   Done() <-chan struct{}
    4.   Err() error
    5.   Value(key interface{}) interface{}
    6. }

其中：

  • Deadline方法需要返回当前Context被取消的时间，也就是完成工作的截止时间（deadline）和判断是否为deadline；
  • Done方法需要返回一个Channel，这个Channel会在当前工作完成或者上下文被取消之后关闭，多次调用Done方法会返回同一个Channel；
  • Err方法会返回当前Context结束的原因，它只会在Done返回的Channel被关闭时才会返回非空的值；
    • 如果当前Context被取消就会返回Canceled错误；
    • 如果当前Context超时就会返回DeadlineExceeded错误；
  • Value方法会从Context中返回键对应的值，对于同一个上下文来说，多次调用Value 并传入相同的Key会返回相同的结果，该方法仅用于传递跨API和进程间跟请求域的数据；

    WithCancel

    当调用cancel()方法后会给context内部的channel struct{}传递至，然后可以通过ctx.Done(）去获取值 ```go package main

import ( “context” “fmt” “sync” “time” )

func f1(ctx context.Context) { defer wg.Done() LOOP: for { fmt.Println(“测试”) time.Sleep(time.Millisecond * 500)

  1.     select {
  2.     case <-ctx.Done():
  3.         //需要指定跳出哪个循环
  4.         break LOOP
  5.     default:
  6.     }
  7. }

}

var wg = sync.WaitGroup{}

//如何优雅的将goroutine退出 //方法一：通过全局变量，进行值判断 //方法二：定义一个channel进行状态判断 //方法三：使用context包，优点是公共统一 func main() { wg.Add(1) ctx, cancel := context.WithCancel(context.Background())

  1. go f1(ctx)
  2. time.Sleep(time.Second * 5)
  3. cancel()
  4. wg.Wait()

}

  1. <a name="TnNeS"></a>
  2. ## withDeadline
  3. 当达到截止日期后会给context内部的channel struct{}传递至，然后可以通过ctx.Done(）去获取值
  4. ```go
  5. package main
  7. import (
  8.     "context"
  9.     "fmt"
  10.     "time"
  11. )
  13. func main() {
  14.     deadline := time.Now().Add(2 * time.Second)
  15.     ctx, cancel := context.WithDeadline(context.Background(), deadline)
  16.     defer cancel()
  17.     select {
  18.     case <-ctx.Done():
  19.         fmt.Println("deadline end", ctx.Err())
  20.     case <-time.After(3 * time.Second):
  21.         fmt.Println("time after")
  22.     }
  24. }

WithTimeout

当超时后达到截止日期后会给context内部的channel struct{}传递至，然后可以通过ctx.Done(）去获取值（效果与Deadline一致，暂不清楚这两个的区别）

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "time"
  7. )
  10. func main() {
  11.     ctx, cancel := context.WithTimeout(context.Background(), time.Second*3)
  12.     defer cancel()
  13.     select {
  14.     case <-ctx.Done():
  15.         fmt.Println("deadline end", ctx.Err())
  16.     case <-time.After(4 * time.Second):
  17.         fmt.Println("time after")
  18.     }
  20. }

WithValue

WithValue函数能够将请求作用域的数据与 Context 对象建立关系。声明如下：

  1. func WithValue(parent Context, key, val interface{}) Context

WithValue返回父节点的副本，其中与key关联的值为val。
仅对API和进程间传递请求域的数据使用上下文值，而不是使用它来传递可选参数给函数。
所提供的键必须是可比较的，并且不应该是string类型或任何其他内置类型，以避免使用上下文在包之间发生冲突。WithValue的用户应该为键定义自己的类型。为了避免在分配给interface{}时进行分配，上下文键通常具有具体类型struct{}。或者，导出的上下文关键变量的静态类型应该是指针或接口。

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "time"
  7. )
  9. type TraceCode string
  11. func main() {
  12.     ctx, cancel := context.WithTimeout(context.Background(), time.Second*3)
  13.     ctx = context.WithValue(ctx, TraceCode("trace"), "hello world")
  14.     defer cancel()
  15.     //.(string)表示类型断言
  16.     traceCode, err := ctx.Value(TraceCode("trace")).(string)
  17.     fmt.Println(traceCode,err)
  18.     select {
  19.     case <-ctx.Done():
  20.         fmt.Println("deadline end", ctx.Err())
  21.     case <-time.After(4 * time.Second):
  22.         fmt.Println("time after")
  23.     }
  25. }