Go version → 1.20.4

前语

Package context defines the Context type, which carries deadlines, cancellation signals, and other request-scoped values across API boundaries and between processes.^[1]

Go 在 1.7 引入了 context 包，意图是为了在不同的 goroutine 之间或跨 API 鸿沟传递超时、撤销信号和其他恳求规模内的值（与该恳求相关的值。这些值或许包括用户身份信息、恳求处理日志、盯梢信息等等）。

在 Go 的日常开发中，Context 上下文目标无处不在，无论是处理网络恳求、数据库操作仍是调用 RPC 等场景下，都会运用到 Context。那么，你真的了解它吗？了解它的正确用法吗？了解它的运用注意事项吗？喝一杯你最喜欢的饮料，随着本文一探究竟吧。

Context 接口

context 包在供给了一个用于跨 API 鸿沟传递超时、撤销信号和其他恳求规模值的通用数据结构。它界说了一个名为 Context 的接口，该接口包含一些办法，用于在多个 Goroutine 和函数之间传递恳求规模内的信息。

以下是 Context 接口的界说：

type Context interface {
    Deadline() (deadline time.Time, ok bool)
    Done() <-chan struct{}
    Err() error
    Value(key any) any
}

Context 的中心办法

Context 接口中有四个中心办法：Deadline()、Done()、Err()、Value()。

Deadline()

Deadline() (deadline time.Time, ok bool) 办法回来 Context 的截止时刻，表示在这个时刻点之后，Context 会被主动撤销。假如 Context 没有设置截止时刻，该办法回来一个零值 time.Time 和一个布尔值 false。

deadline, ok := ctx.Deadline()
if ok {
    // Context 有截止时刻
} else {
    // Context 没有截止时刻
}

Done()

Done() 办法回来一个只读通道，当 Context 被撤销时，该通道会被封闭。你能够经过监听这个通道来检测 Context 是否被撤销。假如 Context 永不撤销，则回来 nil。

select {
case <-ctx.Done():
    // Context 已撤销
default:
    // Context 没有撤销
}

Err()

Err() 办法回来一个 error 值，表示 Context 被撤销时发生的过错。假如 Context 没有撤销，该办法回来 nil。

if err := ctx.Err(); err != nil {
    // Context 已撤销，处理过错
}

Value()

Value(key any) any 办法回来与 Context 相关的键值对，一般用于在 Goroutine 之间传递恳求规模内的信息。假如没有相关的值，则回来 nil。

value := ctx.Value(key)
if value != nil {
    // 存在相关的值
}

Context 的创立方法

context.Background()

context.Background() 函数回来一个非 nil 的空 Context，它没有携带任何的值，也没有撤销和超时信号。一般作为根 Context 运用。

ctx := context.Background()

context.TODO()

context.TODO() 函数回来一个非 nil 的空 Context，它没有携带任何的值，也没有撤销和超时信号。尽管它的回来成果和 context.Background() 函数相同，可是它们的运用场景是不相同的，假如不确定运用哪个上下文时，能够运用 context.TODO()。

ctx := context.TODO()

context.WithValue()

context.WithValue(parent Context, key, val any) 函数接纳一个父 Context 和一个键值对 key、val，回来一个新的子 Context，并在其间增加一个 key-value 数据对。

ctx := context.WithValue(parentCtx, "username", "陈明勇")

context.WithCancel()

context.WithCancel(parent Context) (ctx Context, cancel CancelFunc) 函数接纳一个父 Context，回来一个新的子 Context 和一个撤销函数，当撤销函数被调用时，子 Context 会被撤销，同时会向子 Context 相关的 Done() 通道发送撤销信号，到时其衍生的后代 Context 都会被撤销。这个函数适用于手动撤销操作的场景。

ctx, cancelFunc := context.WithCancel(parentCtx)
defer cancelFunc()

context.WithCancelCause() 与 context.Cause()

context.WithCancelCause(parent Context) (ctx Context, cancel CancelCauseFunc) 函数是 Go 1.20 版本才新增的，其功用类似于 context.WithCancel()，可是它能够设置额定的撤销原因，也就是 error 信息，回来的 cancel 函数被调用时，需传入一个 error 参数。

ctx, cancelFunc := context.WithCancelCause(parentCtx)
defer cancelFunc(errors.New("原因"))

context.Cause(c Context) error 函数用于回来撤销 Context 的原因，即过错值 error。假如是经过 context.WithCancelCause() 函数回来的撤销函数 cancelFunc(myErr) 进行的撤销操作，咱们能够获取到 myErr 的值。否则，咱们将得到与 c.Err() 相同的回来值。假如 Context 没有被撤销，将回来 nil。

err := context.Cause(ctx)

context.WithDeadline()

context.WithDeadline(parent Context, d time.Time) (Context, CancelFunc) 函数接纳一个父 Context 和一个截止时刻作为参数，回来一个新的子 Context。当截止时刻抵达时，子 Context 其衍生的后代 Context 会被主动撤销。这个函数适用于需求在特定时刻点撤销操作的场景。

deadline := time.Now().Add(time.Second * 2)
ctx, cancelFunc := context.WithTimeout(parentCtx, deadline)
defer cancelFunc()

context.WithTimeout()

context.WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc) 函数和 context.WithDeadline() 函数的功用是相同的，其底层会调用 WithDeadline() 函数，只不过其第二个参数接纳的是一个超时时刻，而不是截止时刻。这个函数适用于需求在一段时刻后撤销操作的场景。

ctx, cancelFunc := context.WithTimeout(parentCtx, time.Second * 2)
defer cancelFunc()

Context 的运用场景

传递共享数据

编写中间件函数，用于向 HTTP 处理链中增加处理恳求 ID 的功用。

type key int
const (
   requestIDKey key = iota
)
func WithRequestId(next http.Handler) http.Handler {
   return http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
      // 从恳求中提取恳求ID和用户信息
      requestID := req.Header.Get("X-Request-ID")
      // 创立子 context，并增加一个恳求 Id 的信息
      ctx := context.WithValue(req.Context(), requestIDKey, requestID)
      // 创立一个新的恳求，设置新 ctx
      req = req.WithContext(ctx)
      // 将带有恳求 ID 的上下文传递给下一个处理器
      next.ServeHTTP(rw, req)
   })
}

首要，咱们从恳求的头部中提取恳求 ID。然后运用 context.WithValue 创立一个子上下文，并将恳求 ID 作为键值对存储在子上下文中。接着，咱们创立一个新的恳求目标，并将子上下文设置为新恳求的上下文。最终，咱们将带有恳求 ID 的上下文传递给下一个处理器。这样，经过运用 WithRequestId 中间件函数，咱们能够在处理恳求的过程中方便地获取和运用恳求 ID，例如在 日志记载、盯梢和调试等方面。

传递撤销信号，结束任务

发动一个工作协程，接纳到撤销信号就停止工作。

package main
import (
   "context"
   "fmt"
   "time"
)
func main() {
   ctx, cancelFunc := context.WithCancel(context.Background())
   go Working(ctx)
   time.Sleep(3 * time.Second)
   cancelFunc()
   // 等候一段时刻，以保证工作协程接纳到撤销信号并退出
   time.Sleep(1 * time.Second)
}
func Working(ctx context.Context) {
   for {
      select {
      case <-ctx.Done():
         fmt.Println("下班啦...")
         return
      default:
         fmt.Println("陈明勇正在工作中...")
      }
   }
}

履行成果



陈明勇正在工作中...
陈明勇正在工作中...
陈明勇正在工作中...
陈明勇正在工作中...
陈明勇正在工作中...
下班啦...

在上面的示例中，咱们创立了一个 Working 函数，它会不断履行工作任务。咱们运用 context.WithCancel 创立了一个上下文 ctx 和一个撤销函数 cancelFunc。然后，发动了一个工作协程，并将上下文传递给它。

在主函数中，需求等候一段时刻（3 秒）模仿业务逻辑的履行。然后，调用撤销函数 cancelFunc，通知工作协程停止工作。工作协程在每次循环中都会检查上下文的状况，一旦接纳到撤销信号，就会退出循环。

最终，等候一段时刻（1 秒），以保证工作协程接纳到撤销信号并退出。

超时操控

模仿耗时操作，超时操控。

package main
import (
   "context"
   "fmt"
   "time"
)
func main() {
   // 运用 WithTimeout 创立一个带有超时的上下文目标
   ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
   defer cancel()
   // 在另一个 goroutine 中履行耗时操作
   go func() {
      // 模仿一个耗时的操作，例如数据库查询
      time.Sleep(5 * time.Second)
      cancel()
   }()
   select {
   case <-ctx.Done():
      fmt.Println("操作已超时")
   case <-time.After(10 * time.Second):
      fmt.Println("操作完结")
   }
}

履行成果

操作已超时

在上面的例子中，首要运用 context.WithTimeout() 创立了一个带有 3 秒超时的上下文目标 ctx, cancel := context.WithTimeout(ctx, 3*time.Second)。

接下来，在一个新的 goroutine 中履行一个模仿的耗时操作，例如等候 5 秒钟。当耗时操作完结后，调用 cancel() 办法来撤销超时上下文。

最终，在主 goroutine 中运用 select 句子等候超时上下文的完结信号。假如在 3 秒内耗时操作完结，那么会输出 “操作完结”。假如超过了 3 秒仍未完结，超时上下文的 Done() 通道会被封闭，输出 “操作已超时”。

运用 Context 的一些规矩

运用 Context 上下文，应该遵从以下规矩，以坚持包之间的接口一致，并使静态分析东西能够检查上下文传播:

不要在结构类型中参加 Context 参数，而是将它显式地传递给需求它的每个函数，而且它应该是第一个参数，一般命名为 ctx:
```
func DoSomething(ctx context.Context, arg Arg) error {
        // ... use ctx ...
}
```
即使函数允许，也不要传递 nil Context。假如不确定要运用哪个 Context，建议运用 context.TODO()。
仅将 Context 的值用于传输进程和 api 的恳求作用域数据，不能用于向函数传递可选参数。^[1]

小结

本文具体介绍了 Go 语言中的 Context 上下文，经过阅览本文，信任你们对 Context 的功用和运用场景有所了解。同时，你们也应该能够依据实践需求挑选最合适的 Context 创立方法，而且依据规矩，正确、高效地运用它。

文章继续更新，假如本文能让您有所收获，欢迎关注本号。微信阅览可搜【Go技能干货】。这篇文章已被收录于GitHubgithub.com/chenmingyon…，欢迎我们 Star 催更并继续关注。

参考资料

[1] pkg.go.dev/context@go1…

一文掌握 Go 并发模式 Context 上下文

前语

Context 接口

Context 的中心办法

Deadline()

Done()

Err()

Value()

Context 的创立方法

context.Background()

context.TODO()

context.WithValue()

context.WithCancel()

context.WithCancelCause() 与 context.Cause()

context.WithDeadline()

context.WithTimeout()

Context 的运用场景

传递共享数据

传递撤销信号，结束任务

超时操控

运用 Context 的一些规矩

小结

参考资料

作者信息

一文掌握 Go 并发模式 Context 上下文

前语

Context 接口

Context 的中心办法

Deadline()

Done()

Err()

Value()

Context 的创立方法

context.Background()

context.TODO()

context.WithValue()

context.WithCancel()

context.WithCancelCause() 与 context.Cause()

context.WithDeadline()

context.WithTimeout()

Context 的运用场景

传递共享数据

传递撤销信号，结束任务

超时操控

运用 Context 的一些规矩

小结

参考资料

相关文章

6000字干货分享：数据中台项目管理实践分享

《小团队web技术搭建》（七）自动化部署方式（CI/CD）（二）

JVM调优-JVM调优实践一

通过几道CTF题学习yii2框架

作者信息