协程如何优雅地退出-优快云博客

本文链接：https://blog.youkuaiyun.com/andrewgithub/article/details/148553859

协程如何优雅地退出

在 Go 语言中，协程（goroutine）是一种轻量级的并发执行单元。虽然协程非常高效且易于使用，但一个常见的问题是：如何让协程在程序关闭时优雅地退出？

优雅退出指的是在程序终止前，释放资源、保存状态、完成正在进行的操作，并确保不会留下任何“脏数据”或“僵尸进程”。本文将介绍一种常见的方式：通过 context 和 WaitGroup 来控制协程的生命周期，并实现优雅退出。

在这里插入图片描述

问题背景

Go 程序通常会启动多个协程来处理不同的任务，例如监听网络请求、定时任务、后台日志收集等。当程序收到退出信号（如 SIGINT 或 SIGTERM）时，如果不做特殊处理，主函数可能会提前退出，导致其他协程被强制终止，无法完成清理工作。

使用 context 控制协程生命周期

Go 提供了 context 包用于在不同协程之间传递截止时间、取消信号和请求范围的值。我们可以使用它来通知所有协程：“现在应该停止了”。

ctx, cancel := context.WithCancel(context.Background())

ctx 是上下文对象。
cancel() 是用于触发取消操作的函数。

一旦调用 cancel()，所有监听该 ctx.Done() 的协程都会收到取消信号，可以安全退出。

使用 WaitGroup 阻塞等待

为了确保主函数不会在协程退出前结束，我们使用 sync.WaitGroup 来阻塞主线程，直到所有协程都完成退出：

var wg sync.WaitGroup
wg.Add(1)
go func() {
    // 协程逻辑
    defer wg.Done()
}()
wg.Wait()

这样可以保证主 goroutine 不会在子协程完成前退出。

捕获系统信号

为了让程序响应用户中断（如 Ctrl+C），我们需要监听系统的信号：

sigs := make(chan os.Signal, 1)
signal.Notify(sigs, os.Interrupt, syscall.SIGTERM)

当接收到 SIGINT 或 SIGTERM 信号时，触发 context.CancelFunc，通知所有协程退出。

完整示例代码

以下是一个完整的示例程序，演示了如何优雅地退出多个协程：

package main

import (
	"context"
	"log"
	"os"
	"os/signal"
	"sync"
	"syscall"
)

func shutdownHandler(ctx context.Context, sigs chan os.Signal, cancel context.CancelFunc) {
	select {
	case <-ctx.Done():
		log.Println("Stopping shutdownHandler...")
	case <-sigs:
		cancel()
		log.Println("shutdownHandler sent cancel signal...")
	}

	signal.Stop(sigs)
}

func main() {
	// 所有协程都需要受ctx的管理，一旦有调用cancel()的，所有子携程都需要即时退出
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	var wg sync.WaitGroup
	sigs := make(chan os.Signal, 1)
	signal.Notify(sigs, os.Interrupt, syscall.SIGTERM)

	wg.Add(1)
	go func() {
		shutdownHandler(ctx, sigs, cancel)
		wg.Done()
	}()

	// 示例：启动多个业务协程
	for i := 0; i < 3; i++ {
		wg.Add(1)
		go func(id int) {
			defer wg.Done()
			for {
				select {
				case <-ctx.Done():
					log.Printf("Worker %d exiting gracefully...", id)
					return
				default:
					log.Printf("Worker %d is working...", id)
					// 模拟工作
					// time.Sleep(time.Second)
				}
			}
		}(i)
	}

	// 主线程等待所有协程退出
	wg.Wait()
	log.Println("All workers exited. Exiting main program.")
}

关键点总结

技术	作用
`context.WithCancel`	创建可取消的上下文，用于通知协程退出
`context.Done()`	协程监听此通道，以接收退出信号
`sync.WaitGroup`	主 goroutine 等待所有子 goroutine 完成退出
`signal.Notify`	监听系统中断信号，触发优雅退出流程