Golang 中的 Context 包(Golang Context 包详解：掌握上下文管理技巧)

原创

ithorizon 6个月前 (10-19) 阅读数 19 #后端开发

Golang Context 包详解：掌握上下文管理技巧

一、Context 包简介

在 Golang 中，Context 包是一个非常有用的工具，用于传递请求相关的数据、取消信号、截止时间等。它通常用于在多个 goroutine 之间共享请求范围内的信息，以及控制并发的取消操作。Context 包的核心是 context.Context 接口，该接口定义了三个方法：Deadline、Done 和 Value。

二、Context 接口

context.Context 接口定义如下：


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

以下是对这些方法的简要说明：

Deadline 方法返回当前 context 的截止时间，如果没有设置截止时间，则返回 false。

Done 方法返回一个通道，当 context 被取消或过期时，该通道会关闭。

Err 方法返回 context 被取消或过期时的谬误信息。

Value 方法返回 context 中存储的值，如果没有设置该值，则返回 nil。

三、Context 的创建与使用

Context 包提供了多种创建 Context 的函数，以下是一些常用的函数：

context.Background()：返回一个空的 Context，通常用于根节点。

context.WithCancel(parent Context)：返回一个可取消的 Context。

context.WithTimeout(parent Context, timeout time.Duration)：返回一个具有超时的 Context。

context.WithDeadline(parent Context, d time.Time)：返回一个具有截止时间的 Context。

context.WithValue(parent Context, key, value interface{})：返回一个带有值的 Context。

四、Context 的使用示例

以下是一个使用 Context 的明了示例，展示了怎样创建一个可取消的 Context，并在子 goroutine 中使用它：


package main
import (
    "context"
    "fmt"
    "time"
)
func main() {
    ctx, cancel := context.WithCancel(context.Background())
    defer cancel()
    go func() {
        for {
            select {
            case <-ctx.Done():
                fmt.Println("goroutine is cancelled")
                return
            default:
                fmt.Println("goroutine is running")
                time.Sleep(1 * time.Second)
            }
        }
    }()
    time.Sleep(3 * time.Second)
    fmt.Println("main function is done")
}

在这个例子中，我们创建了一个可取消的 Context，并在一个子 goroutine 中使用它。子 goroutine 每秒打印一次信息，当主函数执行完毕时，我们通过调用 cancel 函数来取消 Context。子 goroutine 在检测到 Context 被取消后，退出循环并打印一条消息。

五、Context 的最佳实践

以下是一些使用 Context 的最佳实践：

不要将 Context 存储在结构体中，而是作为函数的参数传递。

不要在 Context 中传递过多的值，以免造成性能问题。

尽量使用标准库中的 Context 函数创建 Context，而不是自定义。

在长生命周期的 Context 中传递数据时，考虑使用 sync.Map。

不要在 Context 中传递敏感信息，如密码、令牌等。

六、Context 与 HTTP 的结合

在 HTTP 服务中，Context 通常用于处理请求的取消和超时。以下是一个明了的例子，展示了怎样在 HTTP 请求中使用 Context：


package main
import (
    "context"
    "net/http"
    "time"
)
func handleRequest(ctx context.Context, w http.ResponseWriter, r *http.Request) {
    // 获取请求的 Context
    ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
    defer cancel()
    // 模拟处理请求
    for {
        select {
        case <-ctx.Done():
            w.WriteHeader(http.StatusInternalServerError)
            w.Write([]byte("request timeout"))
            return
        default:
            // 模拟处理请求的逻辑
            fmt.Println("processing request")
            time.Sleep(1 * time.Second)
        }
    }
}
func main() {
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        // 创建一个 Context
        ctx := r.Context()
        handleRequest(ctx, w, r)
    })
    http.ListenAndServe(":8080", nil)
}