Go中context的简单使用

Go中context的简单使用

简介

在 Go 语言中，context 对象帮助我们更好地管理和控制上下文信息，context 对象为 Go 编程提供了一种优雅且完整的解决方案，使得我们能够更好地控制 goroutine 间的通信和协作，有效地避免了一些常见的编程难点（如竞态条件、信号处理、使用静态变量等场景），提高了代码的可读性和可维护性

WithCancel(parentContext) - 取消

创建一个可取消的上下文，并返回带有 cancel 函数的上下文对象。使用 cancel() 方法来释放 context 资源，同时取消 context 所有活动。这个方法在需要手动控制下游 goroutine 执行结束时很有用，例如需要执行多个子 goroutine，如果其中一个 goroutine 发生了异常，需要 force-stop 所有其他 goroutine。

func Cannel() {
	ctx, cancel := context.WithCancel(context.Background())
	go func() {
		<-ctx.Done()
		fmt.Println("goroutine 1 done")
	}()
	go func() {
		<-ctx.Done()
		fmt.Println("goroutine 2 done")
	}()
	time.Sleep(time.Second)
	fmt.Println("cancelling...")
	cancel()
	time.Sleep(time.Second)

	fmt.Println("cancelled!")
}

WithDeadline(parentContext, time) - 截止

创建一个带有截止时间的上下文，并返回上下文对象。当到达 deadline 时间时，context 会自动取消所有活动。这个方法在需要控制某个操作的运行时间（例如超时），或者设置某个场景下任务的 deadline 时非常有用。

func Deadline() {
	ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(time.Second))
	defer cancel() // ensures cancel is always called
	select {
	case <-time.After(2 * time.Second):
		fmt.Println("overslept")
	case <-ctx.Done():
		fmt.Println(ctx.Err())
	}
}

WithTimeout(parentContext, time) - 超时

与 WithDeadline 类似，但它是相对于当前的时间来计算截止时间的。这个方法也非常适合用于控制某个操作的运行时间（例如超时），或者设置某个场景下任务的 deadline。

func WithTimeout() {
	ctx, cancel := context.WithTimeout(context.Background(), time.Second)
	defer cancel()
	select {
	case <-time.After(2 * time.Second):
		fmt.Println("overslept")
	case <-ctx.Done():
		fmt.Println(ctx.Err())
	}
}

WithValue(parentContext, key, value) - 键值对

创建一个与原始上下文具有相同的超时和取消值的副本，并附加键值对。这个方法可以用于在 context 中传递 request-scoped 的值（例如 trace ID、数据库连接等）。

func WithValue() {
	ctx := context.WithValue(context.Background(), "traceID", "12345")
	go func() {
		if value := ctx.Value("traceID"); value != nil {
			fmt.Printf("traceID=%s\n", value.(string))
		}
	}()
	time.Sleep(time.Second)
}

Done() - 结束

返回一个只读通道（<-chan struct{}），当 context 被取消时（无论是通过 cancel()、timeout、deadline），该通道会被关闭。这个方法对于 goroutine 检测是否认为应该被停止是很有用的。

func Done() {
	ctx, cancel := context.WithCancel(context.Background())
	go func() {
		select {
		case <-ctx.Done():
			fmt.Println("goroutine done")
		}
	}()
	cancel()
	time.Sleep(time.Second)
}

Err() - 异常

返回一个 error，用于判断 context 是否被取消、超时等。如果 context 还未取消，该方法将返回 nil

func Err() {
	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond)
	defer cancel()
	select {
	case <-ctx.Done():
		fmt.Println(ctx.Err()) // prints "context deadline exceeded"
	}
	time.Sleep(time.Second)
}