前言

这是Go十大常见错误系列的第8篇：并发编程中Context使用常见错误。素材来源于Go布道者，现Docker公司资深工程师Teiva Harsanyi。

本文涉及的源代码全部开源在：Go十大常见错误源代码，欢迎大家关注公众号，及时获取本系列最新更新。

Context是什么

Go语言标准库里有一个package叫context，该package里定义了context.Context类型，在并发编程里非常有用，但是也经常被开发者误解。

官方对Context的表述是：

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

光看这段描述，还是很容易让人迷糊的，我们接下来具体看看Context到底是什么以及可以帮助我们做什么事情。

Context顾名思义，表示的是goroutine的上下文，Context定义如下所示：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

// A Context carries a deadline, cancellation signal, and request-scoped values
// across API boundaries. Its methods are safe for simultaneous use by multiple
// goroutines.
type Context interface {
    // Done returns a channel that is closed when this Context is canceled
    // or times out.
    Done() <-chan struct{}

    // Err indicates why this context was canceled, after the Done channel
    // is closed.
    Err() error

    // Deadline returns the time when this Context will be canceled, if any.
    Deadline() (deadline time.Time, ok bool)

    // Value returns the value associated with key or nil if none.
    Value(key interface{}) interface{}
}

Context可以通过超时设置、携带取消信号、附加参数信息来方便goroutine里做相应的逻辑控制。

  • 超时控制。 通过context.WithTimeout函数和context.WithDeadline函数可以创建一个有超时时间的Context。通过Context的Done函数可以判断是否超时了。

    1
2

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

  • 取消信号。通过context.WithCancel函数可以创建一个接收cancel信号的Context。通过Context的Done函数可以判断是否发出了cancel信号。父Context发出的cancel信号，子Context也可以接收到。

    1

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

  • 附加参数信息。通过context.WithValue函数可以给Context添加参数。其中key和value都是空接口类型(interface{})。通过Context的Value函数可以获取附加参数信息。

    1

    func WithValue(parent Context, key, val any) Context

在实际开发过程中，Context的使用流程一般是：

  • Step 1: 创建Context，给Context指定超时时间，设置取消信号，或者附加参数(链路跟踪里经常使用Context里的附加参数，传递IP等链路跟踪信息)。
  • Step 2: goroutine使用Step 1里的Context作为第一个参数，在该goroutine里就可以做如下事情：
    • 使用Context里的Done函数判断是否达到了Context设置的超时时间或者Context是否被主动取消了。
    • 使用Context里的Value函数获取该Context里的附加参数信息。
    • 使用Context里的Err函数获取错误原因，目前原因就2个，要么是超时，要么是主动取消。

有2点要补充：

  • 第一，Context是可以组合的。比如，我们可以通过context.WithTimeout创建一个有超时时间的Context，再调用context.WithValue添加一些附加参数信息。
  • 第二，多个goroutine可以共享同一个Context，可以通过该Context的超时设置、携带取消信号以及附加参数来控制多个goroutine的行为。

常见错误

在Context使用过程中有以下几个常见错误：

  • 第一，不执行cancel函数去释放Context资源。

    • 对于context.WithTimeout、context.WithDeadline、context.WithCancel函数返回的cancel函数，需要做执行。官方说明如下：

      Canceling this context releases resources associated with it, so code should call cancel as soon as the operations running in this Context complete:

      参考代码示例：

      1
2
3
4
5

      func slowOperationWithTimeout(ctx context.Context) (Result, error) {
	ctx, cancel := context.WithTimeout(ctx, 100*time.Millisecond)
	defer cancel()  // releases resources if slowOperation completes before timeout elapses
	return slowOperation(ctx)
}

  • 第二，不加超时控制，如果执行了非常耗时的rpc操作或者数据库操作，就会阻塞程序。如果rpc调用接口或者数据库操作接口支持传递Context参数，建议加上超时设置。代码示例参考如下：

    1
2

    ctx, cancel := context.WithTimeout(parent, 100 * time.Millisecond)
response, err := grpcClient.Send(ctx, request)

推荐阅读

开源地址

文章和示例代码开源在GitHub: Go语言初级、中级和高级教程。

公众号：coding进阶。关注公众号可以获取最新Go面试题和技术栈。

个人网站：Jincheng’s Blog。

知乎：无忌。

福利

我为大家整理了一份后端开发学习资料礼包，包含编程语言入门到进阶知识(Go、C++、Python)、后端开发技术栈、面试题等。

关注公众号「coding进阶」，发送消息 backend 领取资料礼包，这份资料会不定期更新，加入我觉得有价值的资料。还可以发送消息「进群」，和同行一起交流学习，答疑解惑。

References