via:
https://medium.com/rungo/understanding-the-context-package-b2e407a9cdae
作者:Uday Hiwarale


在数据密集型和网络密集型的 Go 项目里,你可能会使用并发模式,多个协程并发或者并行地处理各种任务。

我们知道,channel 是不同协程之间通信最安全的方式,channel 在协程之间传输数据或者消息。channel 也可用于协程之间发送取消信号,通知其他相关协程停止执行。

1

详细代码

上面的代码中,我们创建了 printNumbers 协程并在后台执行 for 无限循环,接着 main 协程睡眠了 1s。

等到 main 协程再次醒来时,printNumbers 协程仍然在后台运行或者至少占用可能对执行其他任务有用的系统资源。我们可以从输出信息验证这一点,main 协程执行快结束时,仍然有两个活跃的协程(其中一个是 main 协程)。

这是个极端的例子,但却有意义。我们想要的是一旦 main 协程苏醒,就立刻停止 printNumbers 协程,并释放占用的系统资源和不必要的 CPU 开销。这个可以通过使用 channel 发送停止信号来实现。

2

详细代码

上面的例子中,我们创建了 signal channel 用于 main 协程和 printNumbers 协程之间通信。一旦 main 协程苏醒,向 signal channel 发送值但没有其他协程接收这个值,便会再次阻塞。

由于 printNumbers 协程的 select 语句,至少在 1 秒钟时间内,从 signal channel 是读取不到任何值的,便会一直执行 default case。一旦 channel 有值,便会执行 return 语句终止 for 循环,printNumbers 协程退出。

我们可以看到,当 main 协程返回时,只剩下一个活跃的协程。通过这种办法我们可以释放 printNumbers 协程占用的任何系统资源。两个协程之间通信可以用类似上面提到的简单方式。

然而,一个协程可以创建许多协程并且这些协程之间关系复杂,这种情况下使用 channel 发送取消信号将会变得异常困难。

情况是这样的,一个协程创建其他协程,衍生出的协程又开启子协程,这样一级一级创建,第一个协程应该将取消信号发送到所有的衍生协程。

例如,printNumbers 协程创建子协程,但是 main 协程并不知道,所以向子协程发送取消信号的责任就交给了 PrintNumbers 协程。如果协程衍生出更多的子协程,这种情况就会变得更加复杂。

那还有解决办法吗?

这就是 context 包的用处所在,context 包的主要目的就是在 goroutine 之间传递取消信号,不论这些协程是如何创建的,context 包都能覆盖到。

PS:前面这一大段都是为了引进我们今天的主题:context。

context.Context 对象是接口类型,用于在协程之间传递截止时间、取消信号和值。创建该对象后返回 cancel 函数,调用该函数会关闭 Done 信号 channel,这个 channel 可以通过 Context 对象提供的 Done() 方法获取。

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

简而言之,我们可以在协程里创建 Context 对象并将它传递给其他协程。其他协程可以使用 Done() 方法获取到信号 channel 并开始工作。一旦 Done channel 关闭,相关的协程便会停止任何操作并立即返回。

Context 也可能会与时间相关,当到了自定义时间之后便会关闭信号 channel。就是说,我们可以指定截止时间或者超时时间,到了之后 Context 便会关闭信号 channel。

Context 最大的好处是可以从一个 Context 衍生出其他 Context。当我们使用 Context 派生出另一个 Context 时,它们会形成共生关系。如果父 Context 关闭 Done channel,子 Context 的 Done channel 会自动关闭,反之是同样的原理。

Context 对象也可以包含一个值。从父 Context 派生子 Context 时可以携带一个值,并通过 Value(key) 方法可以从子 Context 获取这个值。

现在,我们可以假设在使并发程序更安全更有效率方面,Context 发挥着巨大作用。下面让我们通过 Context 的实际使用案例,深入了解下它的特定用法。

context.Background()

一个空的 Context 没有携带任何值、没有截止时间并且不能取消。context.Background() 函数返回默认的空 Context,它通常用来派生其他 Context,还可以用在测试用例中。

由于 Context 是一个接口,所以它的值也可以是 nil,但是不推荐传递 nil Context,context.Background() 是个不错的选择。context.TODO() 也会返回一个空的 Context,如果我们还不清楚使用什么 Context 时,可以用它来占个位。

context.WithCancel

context.WithCancel 函数返回一个衍生的 Context 和 CancelFunction 函数。当调用取消函数时或者父 Context 的 Done channel 关闭时,子 Context 的 Done channel 会关闭。

func WithCancel(parent Context) (ctx Context, cancel CancelFunc)

3

详细代码

上面的代码中,我们创建了信道 c 用于传输计算结果,square 协程执行 for 循环依次发送。

main 协程里面,执行 for 循环依次读取计算结果。计算结果读取完成之后,square 协程空闲着,什么也没做。

当 main 协程结束返回时,仍然有两个活跃的协程。为了能及时关闭 square 协程(防止系统资源浪费),可以关闭信道 c,并且在 square 协程里面通过 val, ok := <- c 判断信道是否关闭来结束 for 循环。

但是有的时候,我们无法直接控制 channel 或者处理机制过于复杂,这个时候使用 Context 是最好的选择。

4

详细代码

上面的例子,我们通过 context.WithCancel 函数从 context.Background 派生出一个 Context,返回的是父 Context 的副本,但有 Done channel 和取消函数,我们可以随时调用取消函数。

我们将返回的 Context 作为参数传递给 square 协程,在 square 协程里,我们在 for 循环里使用了 select 语句,有两个 case,第一个 case 在什么情况会执行?当调用 cancel 函数、Done channel 关闭时;当 c channel 能写入时会执行第二个 case。

main 协程里,for 循环经过 5 次迭代以后,调用了 cancel 函数,将会关闭 ctx 的 Done channel,将会执行第一个 case,square 协程会终止并正常退出。

通常,大多数人习惯使用 defer cancel() 来取消 Context,然而取消 Context 能够释放其相关的系统资源,因此建议确定不再需要使用 Context 并且子协程应立即停止工作时立即调用 cancel 函数。

一个 Context 可以传递给多个协程,调用 cancel 函数之后再次调用不会有任何作用。

Context 仅可以作为参数传递给函数或者 goroutine,并且最好命名为 ctx,不推荐将 Context 放在结构体中。

context.WithDeadline

除了标准的 cancel 函数,如果你想 Context 在某一给定的时间自动取消,这时就可以使用 context.WithDeadline。

func WithDeadline(parent Context, d time.Time) (Context, CancelFunc)

与 context.WithCancel 类似,context.WithDeadline 函数也会返回 cancel 函数,方便我们手动取消。参数 d 可以指定将来某一时间,到了这一时间点 Done channel 将会自动关闭。

如果父 Context 也有截止时间并且早于子 Context 的截止时间,默认会与父 Context 截止时间保持一致。

这种情况下,如果发生以下 3 种条件之一,Context 都会被取消: 1. 父 Context 的 Done channel 关闭; 1. 调用 cancel 函数; 1. 到了截止时间;

这种类型的 Context 一般用于对时间比较敏感的操作,比如一组协程必须同时结束运行。

5

详细代码

上面的例子,我们设置的 Context 的截止时间是 3s 后。我们将 context 作为参数,创建了三个 worker 协程,使用 seelct 语句,等待 n 秒钟后执行特定任务。

然而,如果 Context ctx 早于等待时间过期,那么理想情况下,我们应当正常返回保证 worker 协程正常终止。这样才能释放协程占用的任何系统资源,并且待执行的任务就来不会意外执行。

上面代码 case 语句块的顺序无关紧要,因为大概率两个 channel 不会同时有数据(即同时准备好)。如果这两个 channel 同时准备好,select 语句会随机选择一个 channe 读取数据。

context.WithTimeout

使用 context.WithTimeout 可以得到一个带有过期时间的 Context。

func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)

该函数语法与 context.WithDeadline 类似,除了第二个参数是 time.Duration 类型,内部实现上,context.WithTimeout 调用了 context.WithDeadline,截止时间是当前时间加上超时时间(timeout)。

func WithTimeout(p Context, t time.Duration) (Context, CancelFunc) {
    return WithDeadline(p, time.Now().Add(t))
}

上一个例子中,通过在当前时间基础上加 3s 钟手动创建了截止时间。context.WithTimeout 的含义类似于 deadline := context.WithTimeout(3 * time.Second)。

这种类型的 Context 可以为某些操作设置超时时间,比如 HTTP 请求等。但是,Go 提供了一种内置机制来处理大多数 API 中与超时相关的问题。

context.WithValue

context 包提供了 WithValue 函数,父 context 派生子 context 的时候可以携带值。但是,使用哪种类型的键存放值存在一定的限制,更多详细内容可以看官方文档



(全文完)

扫码关注领取学习资料!