当前位置：首页 > article >正文

使用 Go 语言中的 Context 取消协程执行

article 2024/11/29 11:19:57

使用 Go 语言中的 Context 取消协程执行

在 Go 语言中，协程（goroutine）是一种轻量级的线程，非常适合处理并发任务。然而，如何优雅地取消正在运行的协程是一个常见的问题。本文将通过一个具体的例子来展示如何使用 context 包来取消协程的执行，特别是处理嵌套任务中的取消问题。

问题描述

假设我们有一个长时间运行的任务，该任务包含一个外层循环和一个内层任务。我们需要在外层循环接收到取消信号时，能够立即终止内层任务。以下是一个示例代码：

package main

import (
	"context"
	"fmt"
	"time"
)

// longRunningTask 是一个模拟长时间运行的任务。
func longRunningTask(ctx context.Context) {
	for {
		select {
		case <-ctx.Done(): // 监听 ctx.Done() 以获取取消信号
			fmt.Println("任务被取消:", ctx.Err())
			return // 接收到取消信号后退出
		default:
			currentTime := time.Now().Format("2006-01-02 15:04:05") // 获取并格式化当前时间
			fmt.Printf("任务进行中... 当前时间：%s\n", currentTime)
			for {
				fmt.Printf("111")
				time.Sleep(1 * time.Second) //
			}
		}
	}
}

func main() {
	// 创建一个可以取消的 context
	ctx, cancel := context.WithCancel(context.Background())

	// 启动一个新的 goroutine 执行任务
	go longRunningTask(ctx)

	// 模拟一段时间后取消任务
	time.Sleep(3 * time.Second)
	fmt.Println("取消任务...")
	cancel() // 发送取消信号

	// 等待一段时间让任务有时间处理取消信号并退出
	time.Sleep(10 * time.Second)
}

在这个示例中，当我们取消任务时，外层循环会接收到取消信号并退出，但内层循环会继续运行，因为我们没有在内层循环中检查取消信号。

解决方案

为了确保内层任务也能响应取消信号，我们需要在内层任务中也检查 ctx.Done() 通道。以下是修改后的代码：

package main

import (
	"context"
	"fmt"
	"time"
)

// longRunningTask 是一个模拟长时间运行的任务。
func longRunningTask(ctx context.Context) {
	for {
		select {
		case <-ctx.Done(): // 监听 ctx.Done() 以获取取消信号
			fmt.Println("任务被取消:", ctx.Err())
			return // 接收到取消信号后退出
		default:
			currentTime := time.Now().Format("2006-01-02 15:04:05") // 获取并格式化当前时间
			fmt.Printf("任务进行中... 当前时间：%s\n", currentTime)
			// 启动内层任务
			runInnerTask(ctx)
		}
	}
}

// runInnerTask 是一个模拟内层长时间运行的任务。
func runInnerTask(ctx context.Context) {
	for {
		select {
		case <-ctx.Done(): // 内层任务也监听 ctx.Done()
			fmt.Println("内层任务被取消:", ctx.Err())
			return // 接收到取消信号后退出
		default:
			fmt.Printf("111")
			time.Sleep(1 * time.Second)
		}
	}
}

func main() {
	// 创建一个可以取消的 context
	ctx, cancel := context.WithCancel(context.Background())

	// 启动一个新的 goroutine 执行任务
	go longRunningTask(ctx)

	// 模拟一段时间后取消任务
	time.Sleep(3 * time.Second)
	fmt.Println("取消任务...")
	cancel() // 发送取消信号

	// 等待一段时间让任务有时间处理取消信号并退出
	time.Sleep(10 * time.Second)
}