Golang Context 的使用指南_golang context 使用,字节跳动学习笔记

59 阅读3分钟

Golang Context 的使用指南

1. 什么是 Context

在 Golang 中,Context 是一个用于跨 goroutine 传递数据、取消任务以及超时控制的标准库。它提供了一种从父 goroutine 向子 goroutine 传递请求或控制信息的机制,可以有效地管理和控制 goroutine 的生命周期。

Context 对于处理并发请求以及处理与请求相关的超时或取消操作非常有用。它能够避免因为一个请求的问题,导致其他相关请求也出现问题的情况。在网络编程、HTTP 服务、微服务等场景中,使用 Context 可以更好地管理请求的生命周期。

2. 导入 Context 包

要使用 Context,我们需要在代码中导入 context 包:

import "context"

3. 创建 Context

在使用 Context 之前,我们需要先创建一个根 Context。一般情况下,我们会使用 context.Background() 函数来创建根 Context。根 Context 是所有其他 Context 的父 Context。

ctx := context.Background()

4. 添加超时/取消功能

为了防止请求耗时过长或无法正常响应,我们可以使用 Context 提供的超时功能。通过给 Context 设置一个超时时间,当超过指定的时间后,Context 会自动取消。

ctx, cancel := context.WithTimeout(ctx, time.Second\*5)
defer cancel()

上述代码将创建一个新的 Context,该 Context 在 5 秒钟之后自动取消。同时,我们也创建了一个 cancel 函数,用于在函数退出时显式地取消 Context。

5. 传递 Context

有了 Context 后,我们可以将其传递给其他函数,以便它们在需要时使用。现在,让我们看看如何在函数间传递 Context。

5.1 手动传递

在函数的参数列表中,添加一个类型为 context.Context 的参数,以便接收调用方传递的 Context。

func Foo(ctx context.Context) {
    // 在这里使用 ctx
}

func Bar(ctx context.Context) {
    Foo(ctx)
}

通过这种方式,我们可以在调用 Bar 函数时,将上层函数传递的 Context 传递给 Foo 函数,从而实现 Context 在函数间的传递。

5.2 Context WithValue

Context 还提供了 WithValue 方法,用于向 Context 中添加一个键值对。这个键值对可以是任意类型的数据,用于传递一些全局信息。

type key int

const (
    userIDKey key = iota
    requestIDKey
)

func Foo(ctx context.Context) {
    userID := ctx.Value(userIDKey).(int)
    requestID := ctx.Value(requestIDKey).(string)

    // 使用 userID 和 requestID
}

func Bar(ctx context.Context, userID int, requestID string) {
    ctx = context.WithValue(ctx, userIDKey, userID)
    ctx = context.WithValue(ctx, requestIDKey, requestID)

    Foo(ctx)
}

在上述代码中,我们首先定义了两个 Context 的键值(userIDKeyrequestIDKey)。在 Bar 函数中,我们使用 WithValue 方法将 userIDrequestID 添加到 Context 中,然后在 Foo 函数中使用这些值。

6. 取消 Context

当我们不再需要某个 Context 时,应该显式地取消它,以释放相关资源并停止与该 Context 相关的操作。

func SomeFunc(ctx context.Context) {
    // 在这里检查 Context 是否已经被取消
    select {
    case <-ctx.Done():


![img](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/83b20b537a1346919b1d98c21705c747~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg5py65Zmo5a2m5Lmg5LmL5b-DQUk=:q75.awebp?rk3s=f64ab15b&x-expires=1771857265&x-signature=XKT%2Ftk3266PDrU9od61a6rxOUi4%3D)
![img](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/1cbb741bcd504f16b5b4af73cf023f2a~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg5py65Zmo5a2m5Lmg5LmL5b-DQUk=:q75.awebp?rk3s=f64ab15b&x-expires=1771857265&x-signature=nYSrblWjGuBQMpXDlRqii2%2FCvbg%3D)
![img](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/3aef454cc96b4dbbb97e859c3cced350~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg5py65Zmo5a2m5Lmg5LmL5b-DQUk=:q75.awebp?rk3s=f64ab15b&x-expires=1771857265&x-signature=Yun1a%2F9rw1In%2FAgDAGNagZtyJp4%3D)

**既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,涵盖了95%以上Go语言开发知识点,真正体系化!**

**由于文件比较多,这里只是将部分目录截图出来,全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频,并且后续会持续更新**

**[如果你需要这些资料,可以戳这里获取](https://gitee.com/vip204888)**