Context初识

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

context.Context是一个接口，定义了4个实现方法

  1. type Context interface {
  2.     Deadline() (deadline time.Time, ok bool)//返回当前Context被取消的时间
  3.     Done() <-chan struct{}//返回一个Channel，这个Channel会在当前工作完成或者上下文被取消后关闭，多次调用Done方法会返回同一个Channel
  4.     Err() error//Err方法会返回当前Context结束的原因，他只会在Done返回的Channel被关闭时才会返回非空的值
  5.     Value(key interface{}) interface{}//Value方法会从Context中返回键对应的值，对同一个上下文来说，多次调用Value并传入相同的Key会返回相同的结果，该方法仅用于传递跨API和进程间跟请求域的数据
  6. }w

Background()和TODO()

Background()主要用于main函数、初始化以及测试代码中，作为Context这个树结构的最顶层的Context，也就是根Context。
TODO()，它目前还不知道具体的使用场景，如果我们不知道该使用什么Context的时候，可以使用这个。

WithCancel

func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
WithCancel返回带有新Done通道的父节点的副本。当调用返回的cancel函数或当关闭父上下文的Done通道时，将关闭返回上下文的Done通道，无论先发生什么情况。
取消此上下文将释放与其关联的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel。

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6. )
  8. func gen(ctx context.Context) <-chan int {
  9.     dst := make(chan int)
  10.     n := 1
  11.     go func() {
  12.         for {
  13.             select {
  14.             case <-ctx.Done():
  15.                 return // return结束该goroutine，防止泄露
  16.             case dst <- n:
  17.                 n++
  18.             }
  19.         }
  20.     }()
  21.     return dst
  22. }
  23. func main() {
  24.     ctx, cancel := context.WithCancel(context.Background())
  25.     defer cancel() // 当我们取完需要的整数后调用cancel
  27.     for n := range gen(ctx) {
  28.         fmt.Println(n)
  29.         if n == 5 {
  30.             break
  31.         }
  32.     }
  33. }

WithDeadline

func WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc)
返回父上下文的副本，并将deadline调整为不迟于d。如果父上下文的deadline已经早于d，则WithDeadline(parent, d)在语义上等同于父上下文。当截止日过期时，当调用返回的cancel函数时，或者当父上下文的Done通道关闭时，返回上下文的Done通道将被关闭，以最先发生的情况为准。
取消此上下文将释放与其关联的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel。

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "time"
  7. )
  9. func main() {
  10.     d := time.Now().Add(time.Millisecond * 50)
  11.     ctx, cancel := context.WithDeadline(context.Background(), d)
  12.     //虽然ctx会过期，但在任何情况下调用它的cancel函数都是很好的实践
  13.     //如果不这样做，可能会使上下文及其父类存活的时间超过必要的时间
  14.     defer cancel()
  16.     for true {
  17.         select {
  18.         case <-time.After(time.Millisecond * 10):
  19.             fmt.Println("oversletp")
  20.         case <-ctx.Done():
  21.             fmt.Println(ctx.Err())
  22.             return
  23.         }
  24.     }
  26. }

WithTimeout

func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
WithTimeout返回WithDeadline(parent, time.Now().Add(timeout))。
取消此上下文将释放与其相关的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel，通常用于数据库或者网络连接的超时控制。

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "sync"
  7.     "time"
  8. )
  10. var wg sync.WaitGroup
  12. func worker(ctx context.Context) {
  13.     LOOP:
  14.     for {
  15.         fmt.Println("db conecting ...")
  16.         time.Sleep(time.Millisecond * 10) //假设正常连接数据库耗时10毫秒
  17.         select {
  18.         case <-ctx.Done(): //50毫秒后自动调用
  19.             break LOOP
  20.         default:
  22.         }
  23.     }
  24.     fmt.Println("worker done!")
  25.     wg.Done()
  26. }
  28. func main() {
  29.     //设置一个50毫秒的超时
  30.     ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
  31.     wg.Add(1)
  32.     go worker(ctx)
  33.     time.Sleep(time.Second * 5)
  34.     cancel() //通知zigoroutine结束
  35.     wg.Wait()
  36.     fmt.Println("over")
  38. }

WithValue

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

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "sync"
  7.     "time"
  8. )
  10. type TraceCode string
  12. var wg sync.WaitGroup
  14. func worker(ctx context.Context) {
  15.     key := TraceCode("TRACE_CODE")
  16.     fmt.Println(ctx.Value(key))
  17.     traceCode, ok := ctx.Value(key).(string)
  18.     if !ok {
  19.         fmt.Println("invalid trace code")
  20.     }
  21. LOOP:
  22.     for {
  23.         fmt.Printf("worker, trace code:%s\n", traceCode)
  24.         time.Sleep(time.Millisecond * 10) // 假设正常连接数据库耗时10毫秒
  25.         select {
  26.         case <-ctx.Done(): // 50毫秒后自动调用
  27.             break LOOP
  28.         default:
  29.         }
  30.     }
  31.     fmt.Println("worker done!")
  32.     wg.Done()
  33. }
  35. func main() {
  36.     //设置一个50毫秒的超时
  37.     ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
  38.     //在系统的入口中设置tracecode传递给后续启动的goroutine实现日志数据聚合
  39.     ctx = context.WithValue(ctx, TraceCode("TRACE_CODE"), "123478978978975")
  40.     wg.Add(1)
  41.     go worker(ctx)
  42.     time.Sleep(time.Second * 5)
  43.     cancel()
  44.     wg.Wait()
  45.     fmt.Println("over")
  47. }

使用Context的注意事项

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