golangcontext（golangcontext源码）

## Go 语言 Context 包详解

简介

Go 语言的 `context` 包提供了用于在 goroutine 之间传播取消信号、截止时间和其它请求范围的值的机制。它在构建并发和并行程序时至关重要，尤其是在处理长运行操作时，能够优雅地处理取消和超时。 理解和正确使用 `context` 包对于编写健壮、高效的 Go 程序至关重要。### 1. Context 的核心概念`context` 包的核心是一个接口 `context.Context`，它定义了几个方法：

`Deadline()`:

返回 context 的截止时间，如果没有截止时间，则返回 `ok=false`。

`Done()`:

返回一个通道，当 context 被取消或超时时，该通道会关闭。

`Err()`:

返回 context 取消的原因，如果没有取消，则返回 `nil`。

`Value(key interface{}) (interface{}, bool)`:

从 context 中检索与给定键关联的值。### 2. Context 的类型`context` 包提供了几个预定义的 Context 类型：

`context.Background()`:

创建一个空的根 Context，通常作为其他 Context 的父 Context。

`context.TODO()`:

一个临时的 placeholder，用于在还未确定需要什么 Context 时使用。 应避免在生产代码中长期使用。

`context.WithCancel(parent context.Context)`:

创建一个新的 Context，它与父 Context 关联，并提供了一个取消功能。 当调用 `cancelFunc()` 时，该 Context 及其所有子 Context 都会被取消。

`context.WithDeadline(parent context.Context, deadline time.Time)`:

创建一个新的 Context，它在指定的 deadline 到达时被取消。

`context.WithTimeout(parent context.Context, timeout time.Duration)`:

创建一个新的 Context，它在指定的 timeout 时间后被取消。 这实际上是 `WithDeadline` 的一个简化版本。

`context.WithValue(parent context.Context, key, val interface{})`:

创建一个新的 Context，它包含一个与指定键值对关联的值。### 3. Context 的使用示例以下示例展示了如何使用 `context.WithTimeout` 来限制一个长运行函数的执行时间：```go package mainimport ("context""fmt""time" )func longRunningTask(ctx context.Context) {for {select {case <-ctx.Done():fmt.Println("Task cancelled:", ctx.Err())returncase <-time.After(1

time.Second):fmt.Println("Task working...")}} }func main() {ctx, cancel := context.WithTimeout(context.Background(), 5

time.Second)defer cancel()go longRunningTask(ctx)time.Sleep(10

time.Second) // main goroutine 继续运行 10 秒fmt.Println("Main goroutine exiting") }```在这个例子中，`longRunningTask` 函数会在 5 秒后被取消，即使它还没有完成。`ctx.Done()` 通道会关闭，`longRunningTask` 会从 `select` 语句中退出，并打印取消原因。### 4. Context 的值传递使用 `context.WithValue` 可以方便地在 goroutine 之间传递请求范围的值，避免了使用全局变量或其他不优雅的方式。```go package mainimport ("context""fmt" )func main() {ctx := context.Background()ctx = context.WithValue(ctx, "user_id", 123)go func(ctx context.Context) {userID := ctx.Value("user_id").(int)fmt.Println("User ID:", userID)}(ctx)time.Sleep(1

time.Second) } ```在这个例子中，`user_id` 值被传递到了 goroutine 中。### 5. 取消机制和最佳实践

总是传递 Context:

在所有长运行函数中传递 Context。

避免 Context 泄露:

确保在函数完成时取消 Context。

处理取消信号:

在你的长运行操作中使用 `select` 语句来监控 `ctx.Done()` 通道。

选择合适的 Context 类型:

根据你的需求选择 `WithCancel`、`WithDeadline` 或 `WithTimeout`。

使用 Context 传递请求范围的值:

避免全局变量，保持代码简洁和可维护性。正确地使用 Go 的 `context` 包对于编写高性能、可扩展和可靠的并发程序至关重要。 通过理解其核心概念和最佳实践，你可以构建出更加健壮的应用程序。

Go 语言 Context 包详解**简介**Go 语言的 `context` 包提供了用于在 goroutine 之间传播取消信号、截止时间和其它请求范围的值的机制。它在构建并发和并行程序时至关重要，尤其是在处理长运行操作时，能够优雅地处理取消和超时。 理解和正确使用 `context` 包对于编写健壮、高效的 Go 程序至关重要。

1. Context 的核心概念`context` 包的核心是一个接口 `context.Context`，它定义了几个方法：* **`Deadline()`:** 返回 context 的截止时间，如果没有截止时间，则返回 `ok=false`。 * **`Done()`:** 返回一个通道，当 context 被取消或超时时，该通道会关闭。 * **`Err()`:** 返回 context 取消的原因，如果没有取消，则返回 `nil`。 * **`Value(key interface{}) (interface{}, bool)`:** 从 context 中检索与给定键关联的值。

2. Context 的类型`context` 包提供了几个预定义的 Context 类型：* **`context.Background()`:** 创建一个空的根 Context，通常作为其他 Context 的父 Context。 * **`context.TODO()`:** 一个临时的 placeholder，用于在还未确定需要什么 Context 时使用。 应避免在生产代码中长期使用。 * **`context.WithCancel(parent context.Context)`:** 创建一个新的 Context，它与父 Context 关联，并提供了一个取消功能。 当调用 `cancelFunc()` 时，该 Context 及其所有子 Context 都会被取消。 * **`context.WithDeadline(parent context.Context, deadline time.Time)`:** 创建一个新的 Context，它在指定的 deadline 到达时被取消。 * **`context.WithTimeout(parent context.Context, timeout time.Duration)`:** 创建一个新的 Context，它在指定的 timeout 时间后被取消。 这实际上是 `WithDeadline` 的一个简化版本。 * **`context.WithValue(parent context.Context, key, val interface{})`:** 创建一个新的 Context，它包含一个与指定键值对关联的值。

3. Context 的使用示例以下示例展示了如何使用 `context.WithTimeout` 来限制一个长运行函数的执行时间：```go package mainimport ("context""fmt""time" )func longRunningTask(ctx context.Context) {for {select {case <-ctx.Done():fmt.Println("Task cancelled:", ctx.Err())returncase <-time.After(1 * time.Second):fmt.Println("Task working...")}} }func main() {ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)defer cancel()go longRunningTask(ctx)time.Sleep(10 * time.Second) // main goroutine 继续运行 10 秒fmt.Println("Main goroutine exiting") }```在这个例子中，`longRunningTask` 函数会在 5 秒后被取消，即使它还没有完成。`ctx.Done()` 通道会关闭，`longRunningTask` 会从 `select` 语句中退出，并打印取消原因。

4. Context 的值传递使用 `context.WithValue` 可以方便地在 goroutine 之间传递请求范围的值，避免了使用全局变量或其他不优雅的方式。```go package mainimport ("context""fmt" )func main() {ctx := context.Background()ctx = context.WithValue(ctx, "user_id", 123)go func(ctx context.Context) {userID := ctx.Value("user_id").(int)fmt.Println("User ID:", userID)}(ctx)time.Sleep(1 * time.Second) } ```在这个例子中，`user_id` 值被传递到了 goroutine 中。

5. 取消机制和最佳实践* **总是传递 Context:** 在所有长运行函数中传递 Context。 * **避免 Context 泄露:** 确保在函数完成时取消 Context。 * **处理取消信号:** 在你的长运行操作中使用 `select` 语句来监控 `ctx.Done()` 通道。 * **选择合适的 Context 类型:** 根据你的需求选择 `WithCancel`、`WithDeadline` 或 `WithTimeout`。 * **使用 Context 传递请求范围的值:** 避免全局变量，保持代码简洁和可维护性。正确地使用 Go 的 `context` 包对于编写高性能、可扩展和可靠的并发程序至关重要。 通过理解其核心概念和最佳实践，你可以构建出更加健壮的应用程序。