1 context简介

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

2 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）；
  • Done()方法需要返回一个Channel，这个Channel会在当前工作完成或者上下文被取消之后关闭，多次调用Done方法会返回同一个Channel；
  • Err()方法会返回当前Context结束的原因，它只会在Done返回的Channel被关闭时才会返回非空的值；
    • 如果当前Context被取消就会返回Canceled错误；
    • 如果当前Context超时就会返回DeadlineExceeded错误；

  • Value方法会从Context中返回键对应的值，对于同一个上下文来说，多次调用Value 并传入相同的Key会返回相同的结果，该方法仅用于传递跨API和进程间跟请求域的数据；

    3 Background()和TODO()

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

    4 with系列函数

    (1) WithCancel

    1. func WithCancel(parent Context) (ctx Context, cancel CancelFunc)

    WithCancel返回带有新Done通道的父节点的副本。当调用返回的cancel函数或当关闭父上下文的Done通道时，将关闭返回上下文的Done通道，无论先发生什么情况。

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

    (2) WithDeadline

    1. func WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc)

    返回父上下文的副本，并将deadline调整为不迟于d。如果父上下文的deadline已经早于d，则WithDeadline(parent, d)在语义上等同于父上下文。当截止日过期时，当调用返回的cancel函数时，或者当父上下文的Done通道关闭时，返回上下文的Done通道将被关闭，以最先发生的情况为准。

取消此上下文将释放与其关联的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel。

  1. func main() {
  2.     d := time.Now().Add(50 * time.Millisecond)
  3.     ctx, cancel := context.WithDeadline(context.Background(), d)
  5.     // 尽管ctx会过期，但在任何情况下调用它的cancel函数都是很好的实践。
  6.     // 如果不这样做，可能会使上下文及其父类存活的时间超过必要的时间。
  7.     defer cancel()
  9.     select {
  10.     case <-time.After(1 * time.Second):
  11.         fmt.Println("overslept")
  12.     case <-ctx.Done():
  13.         fmt.Println(ctx.Err())
  14.     }
  15. }

上面的代码中，定义了一个50毫秒之后过期的deadline，然后我们调用context.WithDeadline(context.Background(), d)得到一个上下文（ctx）和一个取消函数（cancel），然后使用一个select让主程序陷入等待：等待1秒后打印overslept退出或者等待ctx过期后退出。 因为ctx50秒后就过期，所以ctx.Done()会先接收到值，上面的代码会打印ctx.Err()取消原因。

(3) WithTimeout

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

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

5 案例: 客户端超时取消请求

(1) server

  1. package main
  3. import (
  4.     "fmt"
  5.     "math/rand"
  6.     "net/http"
  8.     "time"
  9. )
  11. // server端，随机出现慢响应
  12. func indexHandler(w http.ResponseWriter, r *http.Request) {
  13.     number := rand.Intn(2)
  14.     if number == 0 {
  15.         time.Sleep(time.Second * 10) // 耗时10秒的慢响应
  16.         fmt.Fprintf(w, "slow response")
  17.         return
  18.     }
  19.     fmt.Fprint(w, "quick response")
  20. }
  22. func main() {
  23.     http.HandleFunc("/", indexHandler)
  24.     err := http.ListenAndServe(":8000", nil)
  25.     if err != nil {
  26.         panic(err)
  27.     }
  28. }

(2) client

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "io/ioutil"
  7.     "net/http"
  8.     "sync"
  9.     "time"
  10. )
  12. type respData struct {
  13.     resp *http.Response
  14.     err  error
  15. }
  17. func doCall(ctx context.Context) {
  18.     transport := http.Transport{
  19.         DisableKeepAlives: true, // 请求不频繁使用短链接
  20.     }
  21.     client := http.Client{
  22.         Transport: &transport,
  23.     }
  26.     req, err := http.NewRequest("GET", "http://127.0.0.1:8000/", nil)
  27.     if err != nil {
  28.         fmt.Printf("new requestg failed, err:%v\n", err)
  29.         return
  30.     }
  31.     req = req.WithContext(ctx) // 使用带超时的ctx创建一个新的client request
  32.     var wg sync.WaitGroup
  33.     wg.Add(1)
  34.     defer wg.Wait()
  36.     respChan := make(chan *respData, 1)
  37.     go func() {
  38.         resp, err := client.Do(req)
  39.         fmt.Printf("client.do resp:%v, err:%v\n", resp, err)
  40.         rd := &respData{
  41.             resp: resp,
  42.             err:  err,
  43.         }
  44.         respChan <- rd
  45.         wg.Done()
  46.     }()
  48.     select {
  49.     case <-ctx.Done():
  50.         fmt.Println("call api timeout")
  51.     case result := <-respChan:
  52.         fmt.Println("call server api success")
  53.         if result.err != nil {
  54.             fmt.Printf("call server api failed, err:%v\n", result.err)
  55.             return
  56.         }
  57.         defer result.resp.Body.Close()
  58.         data, _ := ioutil.ReadAll(result.resp.Body)
  59.         fmt.Printf("resp:%v\n", string(data))
  60.     }
  61. }
  63. func main() {
  64.     // 定义一个100毫秒的超时
  65.     ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*100)
  66.     defer cancel() // 调用cancel释放子goroutine资源
  67.     doCall(ctx)
  68. }

6 案例: 优雅退出子go程

在Go中, 不能直接杀死协程,
协程的关闭, 一般采用channel和select的方式来控制
但在某些场景下, 一个请求可能会开启多个协程, 它们需要被同时关闭
这样用channel和select就比较难实现, 而context就可以解决这个问题

(1) 关闭单个协程

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "time"
  7. )
  9. func doWork(ctx context.Context) {
  10.     ch := make(chan int)  // 这个用来放返回值
  11.     // 真正的逻辑要放到一个go程里去做
  12.     go func() {
  13.         for i := 0; i < 100; i++ {
  14.             fmt.Println("do work")
  15.             if i == 1 { // 调整这个值看效果
  16.                 ch <- 5
  17.                 break
  18.             }
  19.             time.Sleep(time.Second * 1)
  20.         }
  21.         fmt.Println("work done")
  22.     }()
  23.     select {
  24.     case <-ctx.Done():
  25.         fmt.Println("cancel")
  26.     case i := <-ch:
  27.         fmt.Println("return", i)
  28.     }
  29. }
  31. func main() {
  32.     ctx, cancel := context.WithCancel(context.Background())
  33.     go doWork(ctx)
  34.     fmt.Println("开始")
  35.     time.Sleep(time.Second * 2)
  36.     fmt.Println("正在取消")
  37.     cancel()
  38.     fmt.Println("取消完成")
  39.     time.Sleep(time.Second * 2)
  40.     fmt.Println("结束")
  41. }

输出结果为:

开始 do work do work work done get 5 正在取消 取消完成 结束

(2) 关闭多个协程

  1. package main
  3. import (
  4.     "context"
  5.     "fmt"
  6.     "sync"
  8.     "time"
  9. )
  11. var wg sync.WaitGroup
  13. // 可以把 接收取消通知 这部分封装一下, 更容易理解
  14. func isCancel(ctx context.Context) bool {
  15.     select {
  16.     case <-ctx.Done(): // 接收取消通知
  17.         return true
  18.     default:
  19.         return false
  20.     }
  21. }
  23. func worker(ctx context.Context) {
  24.     go worker2(ctx)
  25.     for {
  26.         fmt.Println("worker")
  27.         time.Sleep(time.Second)
  28.         if isCancel(ctx) {
  29.             break
  30.         }
  31.     }
  32.     wg.Done()
  33. }
  35. func worker2(ctx context.Context) {
  36.     for {
  37.         fmt.Println("worker2")
  38.         time.Sleep(time.Second)
  39.         if isCancel(ctx) {
  40.             break
  41.         }
  42.     }
  43. }
  44. func main() {
  45.     ctx, cancel := context.WithCancel(context.Background())
  46.     wg.Add(1)
  47.     go worker(ctx)
  48.     time.Sleep(time.Second * 3)
  49.     cancel() // 通知子goroutine结束
  50.     wg.Wait()
  51.     fmt.Println("over")
  52. }