golang学习笔记之-context详细理解篇 - 图1

  • context.Background():可以简单理解我们知道这个上下文要去干什么
  • context.TODO():可以简单理解我们不清楚要使用哪个上下文、或者还没有可用的上下文

    下面代码演示:

    1.context.WithCancel():返回Context和取消函数用来取消Context

  1. package main
  2. import (
  3. "context"
  4. "log"
  5. "os"
  6. "time"
  7. )
  8. var (
  9. logg *log.Logger
  10. )
  11. func work(ctx context.Context, ch chan bool) {
  12. for {
  13. select {
  14. case <-ctx.Done():
  15. logg.Println(`下班!`)
  16. ch <- true
  17. return
  18. default:
  19. logg.Println(`上班!`)
  20. time.Sleep(2 * time.Second)
  21. }
  22. }
  23. }
  24. func main() {
  25. ch := make(chan bool)
  26. logg = log.New(os.Stdout, "", log.Ltime)
  27. ctx, cancel := context.WithCancel(context.Background())
  28. go work(ctx, ch)
  29. time.Sleep(10 * time.Second)
  30. //取消函数:当cancel被调用时,WithCancel遍历Done以执行关闭;
  31. cancel()
  32. // 这个chan是为了保证子的goroutine执行完,当然也可以不用chan用time.Sleep停止几秒
  33. <-ch
  34. logg.Println(`无脑发呆中!`)
  35. }
  36. /* outfile:
  37. 17:27:52 上班!
  38. 17:27:54 上班!
  39. 17:27:56 上班!
  40. 17:27:58 上班!
  41. 17:28:00 上班!
  42. 17:28:02 下班!
  43. 17:28:02 无脑发呆中!
  44. */

2.context.WithDeadline()和context.WithTimeout():返回Context和取消函数用来取消Context(这个取消函数会根据设置的时间自动取消)

  1. package main
  2. import (
  3. "context"
  4. "log"
  5. "os"
  6. "time"
  7. )
  8. var (
  9. logg *log.Logger
  10. )
  11. func work(ctx context.Context, ch chan bool) {
  12. for {
  13. select {
  14. case <-ctx.Done():
  15. logg.Println(`下班!`)
  16. ch <- true
  17. return
  18. default:
  19. logg.Println(`上班!`)
  20. time.Sleep(2 * time.Second)
  21. }
  22. }
  23. }
  24. func main() {
  25. ch := make(chan bool)
  26. logg = log.New(os.Stdout, "", log.Ltime)
  27. ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(5*time.Second))
  28. go work(ctx, ch)
  29. time.Sleep(10 * time.Second)
  30. //取消函数:当cancel被调用时,context.WithDeadline设置的时间超过了,关闭ctx.Done通道。
  31. cancel()
  32. // 这个chan是为了保证子的goroutine执行完,当然也可以不用chan用time.Sleep停止几秒
  33. <-ch
  34. logg.Println(`无脑发呆中!`)
  35. }
  36. /* outfile:
  37. 17:29:43 上班!
  38. 17:29:45 上班!
  39. 17:29:47 上班!
  40. 17:29:49 下班!
  41. 17:29:53 无脑发呆中!
  42. */

3.context.WithTimeout
  1. package main
  2. import (
  3. "context"
  4. "log"
  5. "os"
  6. "time"
  7. )
  8. var (
  9. logg *log.Logger
  10. )
  11. func work(ctx context.Context, ch chan bool) {
  12. for {
  13. select {
  14. case <-ctx.Done():
  15. logg.Println(`下班!`)
  16. ch <- true
  17. return
  18. default:
  19. logg.Println(`上班!`)
  20. time.Sleep(2 * time.Second)
  21. }
  22. }
  23. }
  24. func main() {
  25. ch := make(chan bool)
  26. logg = log.New(os.Stdout, "", log.Ltime)
  27. ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
  28. go work(ctx, ch)
  29. time.Sleep(10 * time.Second)
  30. //取消函数:当cancel被调用时,context.WithTimeout设置的时间超过后,关闭ctx.Done通道;
  31. cancel()
  32. // 这个chan是为了保证子的goroutine执行完,当然也可以不用chan用time.Sleep停止几秒
  33. <-ch
  34. logg.Println(`无脑发呆中!`)
  35. }
  36. /* outfile:
  37. 17:34:56 上班!
  38. 17:34:58 上班!
  39. 17:35:00 上班!
  40. 17:35:02 下班!
  41. 17:35:06 无脑发呆中!
  42. */
  • context.WithCancel():执行取消函数就取消
  • context.WithDeadline、context.WithTimeout:超时的时候就取消

    4.Deadline获取超时时间

  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "log"
  6. "os"
  7. "time"
  8. )
  9. var (
  10. logg *log.Logger
  11. )
  12. func work(ctx context.Context, ch chan bool) {
  13. for {
  14. /*
  15. Deadline:是获取设置的超时时间:
  16. 第一个返回值:设置的超时时间,到超时时间Context会自动发起取消请求
  17. 第二个返回值ok==false时表示没有设置截止时间,如果需要取消的话需要调用取消函数进行取消。
  18. */
  19. if deadline, ok := ctx.Deadline(); ok {
  20. fmt.Println(deadline)
  21. if time.Now().After(deadline) {
  22. logg.Println(`超时退出!`)
  23. //这里是为了演示,Context中的Err()输出:context deadline exceeded
  24. logg.Printf(ctx.Err().Error())
  25. ch <- true
  26. return
  27. }
  28. }
  29. select {
  30. case <-ctx.Done():
  31. logg.Println(`下班!`)
  32. ch <- true
  33. return
  34. default:
  35. logg.Println(`上班!`)
  36. time.Sleep(1 * time.Second)
  37. }
  38. }
  39. }
  40. func main() {
  41. ch := make(chan bool)
  42. logg = log.New(os.Stdout, "", log.Ltime)
  43. ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
  44. go work(ctx, ch)
  45. time.Sleep(10 * time.Second)
  46. //取消函数:当cancel被调用时,context.WithTimeout设置的时间超过后,关闭ctx.Done通道;
  47. cancel()
  48. // 这个chan是为了保证子的goroutine执行完,当然也可以不用chan用time.Sleep停止几秒
  49. <-ch
  50. logg.Println(`无脑发呆中!`)
  51. }
  52. /* outfile:
  53. 2019-01-30 18:23:47.851042 +0800 CST m=+5.000360703
  54. 18:23:42 上班!
  55. 2019-01-30 18:23:47.851042 +0800 CST m=+5.000360703
  56. 18:23:43 上班!
  57. 2019-01-30 18:23:47.851042 +0800 CST m=+5.000360703
  58. 18:23:44 上班!
  59. 2019-01-30 18:23:47.851042 +0800 CST m=+5.000360703
  60. 18:23:45 上班!
  61. 2019-01-30 18:23:47.851042 +0800 CST m=+5.000360703
  62. 18:23:46 上班!
  63. 2019-01-30 18:23:47.851042 +0800 CST m=+5.000360703
  64. 18:23:47 超时退出!
  65. 18:23:47 context deadline exceeded //这里就是ctx超时的时候ctx.Err的错误消息。
  66. 18:23:52 无脑发呆中!
  67. */

5.遇到某个上下文在传递的时候:context.WithCancel()存储和检索附加于请求的数据包.当一个函数创建一个goroutine和Context时,它通常会启动一个为请求提供服务的进程,并且子函数可能需要相关的请求信息。

  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. )
  6. func main() {
  7. ProcessRequest("admin", "admin888")
  8. }
  9. func ProcessRequest(UserName, PassWord string) {
  10. ctx := context.WithValue(context.Background(), "UserName", UserName)
  11. ctx = context.WithValue(ctx, "PassWord", PassWord)
  12. HandleResponse(ctx)
  13. }
  14. func HandleResponse(ctx context.Context) {
  15. fmt.Printf("处理响应 用户名:%v 密码:%v",
  16. ctx.Value("UserName"),
  17. ctx.Value("PassWord"),
  18. )
  19. }
  20. /* outfile:
  21. 处理响应 用户名:admin 密码:admin888
  22. */
  • 很简单的用法,不过也是有限制的:

    使用的key必须是可比较的,也就是说== 和 != 必须能返回正确的结果 返回值必须是并发安全的,这样才能从多个goroutine访问

  • 由于Context的Value(key interface{}) interface{} 键和值都被定义为interface{},当试图检索值时,会失去其类型安全性。基于此,Go建议在context中存储和检索值时遵循一些规则。

  • 推荐在包中自行定义key的类型,这样无论是否其他包执行相同的操作都可以防止context中的冲突。看下面这个例子:
  1. type foo int
  2. type bar int
  3. m := make(map[interface{}]int)
  4. m[foo(1)] = 1
  5. m[bar(1)] = 2
  6. fmt.Printf("%v", m)
  7. /*
  8. map[1:2 1:1]
  9. */
  • 可以看到,虽然基础值是相同的,但不同类型的信息会在map中区分它们。由于你为包定义的key类型未导出,因此其他包不会与你在包中生成的key冲突。
  • 由于用于存储数据的key是非导出的,因此我们必须导出执行检索数据的函数。这很容易做到,因为它允许这些数据的使用者使用静态的,类型安全的函数。

当你把所有这些放在一起时,你会得到类似下面的例子:

  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. )
  6. func main() {
  7. ProcessRequest("jane", "abc123")
  8. }
  9. type ctxKey int
  10. const (
  11. ctxUserName ctxKey = iota
  12. ctxPassWord
  13. )
  14. func UserName(c context.Context) string {
  15. return c.Value(ctxUserName).(string)
  16. }
  17. func PassWord(c context.Context) string {
  18. return c.Value(ctxPassWord).(string)
  19. }
  20. func ProcessRequest(UserName, PassWord string) {
  21. ctx := context.WithValue(context.Background(), ctxUserName, UserName)
  22. ctx = context.WithValue(ctx, ctxPassWord, PassWord)
  23. HandleResponse(ctx)
  24. }
  25. func HandleResponse(ctx context.Context) {
  26. fmt.Printf(
  27. "处理响应 用户名:%v 密码:%v",
  28. UserName(ctx),
  29. PassWord(ctx),
  30. )
  31. }
  32. /* outfile:
  33. 处理响应 用户名:jane 密码:abc123
  34. */