Golang context包详解及代码示例

骑猪看日落 2023-10-12 12:13 17阅读 0赞

## context包 ##

Go 语言中的 Context 包提供了一种机制，用于在多个 goroutine 之间传递请求范围的上下文信息，并用于控制 goroutine 的生命周期、取消操作和超时控制。Context 能够帮助我们处理并发任务的取消、超时和值传递等问题。

Context 的核心概念是 Context 对象（Context），它是一个接口类型。Context 对象包含了请求范围的上下文信息，并定义了用于操作上下文的方法。

在 Go 语言中，我们可以使用 `context.Background()` 创建一个根级别的 Context，也可以使用 `context.WithCancel()`、`context.WithDeadline()` 和 `context.WithTimeout()` 等函数基于现有的 Context 创建子级 Context。

以下是 Context 包中常用的方法和用法：

1.  `context.Background()`：创建一个根级别的 Context，通常作为整个 Context 树的根节点。
2.  `context.WithCancel(parent Context) (ctx Context, cancelFunc CancelFunc)`：创建一个带有取消函数的子级 Context。当调用取消函数时，所有基于该 Context 的 goroutine 都会收到取消信号。
3.  `context.WithDeadline(parent Context, deadline time.Time) (Context, CancelFunc)`：创建一个带有截止时间的子级 Context。当截止时间到达时，基于该 Context 的 goroutine 将收到取消信号。
4.  `context.WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)`：创建一个带有超时时间的子级 Context。当超过指定的时间时，基于该 Context 的 goroutine 将收到取消信号。
5.  `context.WithValue(parent Context, key interface{}, value interface{}) Context`：创建一个带有键值对的子级 Context，用于在 goroutine 之间传递请求范围的值。这些值必须是线程安全的。
6.  `ctx.Done() <-chan struct{}`：返回一个只读的通道（channel），用于接收取消信号。当 Context 被取消时，该通道会收到值。
7.  `ctx.Err() error`：返回 Context 的错误状态。如果 Context 被取消，将返回 `context.Canceled` 错误；如果 Context 到达截止时间，将返回 `context.DeadlineExceeded` 错误。

Context 提供了一种简洁且灵活的方式来处理并发任务的取消和超时控制。通过将 Context 传递给 goroutine，我们可以在不同的 goroutine 之间传递请求范围的上下文信息，并及时取消或超时控制这些任务。这对于构建高效的并发应用程序和服务非常有用，可以提高程序的健壮性和可靠性。

## 代码示例 ##

下面是一个使用 Go 语言中的 Context 包的示例代码：

package main
    
    import (
    	"context"
    	"fmt"
    	"time"
    )
    
    func main() {
        
    	// 创建一个父级 Context
    	parentCtx := context.Background()
    
    	// 创建一个带有取消函数的子级 Context，设置超时时间为2秒
    	childCtx, cancel := context.WithTimeout(parentCtx, 2*time.Second)
    	defer cancel()
    
    	// 在子级 Context 中启动一个 goroutine
    	go doSomething(childCtx)
    
    	// 阻塞等待一段时间
    	time.Sleep(3 * time.Second)
    
    	// 调用取消函数，取消子级 Context 中的操作
    	cancel()
    
    	// 阻塞等待一段时间
    	time.Sleep(1 * time.Second)
    }
    
    func doSomething(ctx context.Context) {
        
    	// 模拟一个耗时操作
    	for {
        
    		select {
        
    		case <-ctx.Done():
    			// 当 Context 被取消时，停止操作
    			fmt.Println("Operation cancelled.")
    			return
    		default:
    			// 模拟耗时操作
    			fmt.Println("Performing operation...")
    			time.Sleep(500 * time.Millisecond)
    		}
    	}
    }

该示例中，首先创建了一个父级 Context `parentCtx`，然后使用 `context.WithTimeout()` 函数创建了一个子级 Context `childCtx`，并设置了超时时间为2秒。接着，在子级 Context 中启动了一个 goroutine `doSomething()` 来模拟一个耗时操作。在主函数中，等待3秒后调用取消函数 `cancel()`，取消子级 Context 中的操作。最后，再等待1秒后程序结束。

在 `doSomething()` 函数中，使用了 `select` 语句监听 Context 的 `Done()` 通道。当 Context 被取消时，`Done()` 通道会接收到值，执行相应的操作。在本例中，当子级 Context 被取消时，输出"Operation cancelled."，并返回函数，停止耗时操作。

通过使用 Context，我们可以控制并管理 goroutine 的生命周期，包括取消操作、超时控制和传递上下文等。在示例中，我们使用了超时控制来限制 `doSomething()` 的执行时间，并使用取消函数来提前终止耗时操作。这种方式可以有效地管理资源和避免潜在的资源泄漏。