Golang优雅关闭goroutine技巧

优雅地关闭 Goroutine 的核心方法是使用 select 配合 done channel。1. 创建一个 chan struct{} 类型的 done channel，用于传递关闭信号；2. Goroutine 中使用 select 监听该 channel，一旦收到信号即执行退出逻辑；3. 主 Goroutine 调用 close(done) 发送关闭信号并等待所有子 Goroutine 安全退出。此外，推荐使用 context.Context 管理生命周期，通过 cancel 函数统一发送取消信号，同时可结合 errChan 使用 recover 捕获 panic 并传递错误信息，确保程序健壮性与资源安全释放。

优雅地关闭 Goroutine，本质上就是通知它停止工作并安全退出。Golang 提供了多种方式来实现，其中最常见和推荐的是使用 select 配合 done channel。

解决方案

利用 done channel 发送关闭信号，Goroutine 通过 select 监听这个信号，一旦收到就执行退出逻辑。这种方式既能确保 Goroutine 正常结束，又能避免资源泄露。

如何创建和使用 Done Channel？

Done channel 其实就是一个普通的 channel，只不过它专门用来传递关闭信号。创建一个 chan struct{} 类型的 channel，发送端通过 close(done) 关闭 channel，接收端通过 select 监听 channel 的关闭事件。

package main

import (
    "fmt"
    "time"
)

func worker(id int, done <-chan struct{}) {
    fmt.Printf("Worker %d starting\n", id)
    defer fmt.Printf("Worker %d done\n", id)

    for {
        select {
        case <-done:
            fmt.Printf("Worker %d received done signal\n", id)
            return // 退出 Goroutine
        default:
            fmt.Printf("Worker %d is working...\n", id)
            time.Sleep(time.Second)
        }
    }
}

func main() {
    done := make(chan struct{})

    // 启动多个 worker Goroutine
    for i := 1; i <= 3; i++ {
        go worker(i, done)
    }

    // 模拟一段时间的工作
    time.Sleep(5 * time.Second)

    // 关闭 done channel，通知所有 worker 退出
    fmt.Println("Sending done signal...")
    close(done)

    // 等待一段时间，确保所有 worker 都已退出
    time.Sleep(2 * time.Second)
    fmt.Println("All workers done. Exiting.")
}

这段代码展示了如何启动多个 worker Goroutine，每个 Goroutine 都在循环中执行任务，并监听 done channel。主 Goroutine 在一段时间后关闭 done channel，所有 worker 收到信号后退出。

为什么推荐使用 select 和 done channel？

相比于使用全局变量或者强制 kill Goroutine，select 和 done channel 的方式更加安全和优雅。它允许 Goroutine 在退出前执行清理工作，避免数据损坏或资源泄露。同时，select 语句可以同时监听多个 channel，使得 Goroutine 可以响应多种事件。

如何处理 Goroutine 中的错误？

在 Goroutine 中，错误处理是一个需要特别注意的问题。如果 Goroutine 发生 panic，如果没有 recover，整个程序都会崩溃。一种常见的做法是使用 recover 来捕获 panic，并将其转换为 error 返回。

func workerWithError(id int, done <-chan struct{}, errChan chan<- error) {
    defer func() {
        if r := recover(); r != nil {
            errChan <- fmt.Errorf("worker %d panicked: %v", id, r)
        }
    }()

    // 模拟可能发生 panic 的操作
    if id == 2 {
        panic("Simulating a panic in worker 2")
    }

    // ... 其他工作 ...
}

func main() {
    done := make(chan struct{})
    errChan := make(chan error, 3) // buffered channel

    for i := 1; i <= 3; i++ {
        go workerWithError(i, done, errChan)
    }

    // ... 关闭 done channel ...

    // 收集错误
    close(done) //先关闭done，避免errChan阻塞
    time.Sleep(time.Second)

    close(errChan) //关闭errChan，否则range会一直阻塞
    for err := range errChan {
        fmt.Println("Error:", err)
    }

}

这个例子展示了如何在 Goroutine 中使用 recover 来捕获 panic，并将错误信息发送到 errChan。主 Goroutine 可以从 errChan 中读取错误信息，并进行处理。注意， errChan 需要设置为 buffered channel，避免 Goroutine 在发送错误信息时阻塞。在读取错误信息之前，需要先关闭 done channel，确保所有 Goroutine 都已退出。

Done Channel 的最佳实践？

1. 总是使用 close(done) 来发送关闭信号。 close 操作是幂等的，可以多次调用，但只能关闭一次。
2. 使用 buffered channel 来传递错误信息。 避免 Goroutine 在发送错误信息时阻塞。
3. 在 select 语句中使用 default case。 避免 Goroutine 在没有事件发生时阻塞。
4. 使用 context.Context 来传递取消信号。 context.Context 提供了更丰富的功能，例如超时和截止时间。
5. 在关闭 done channel 之前，确保所有 Goroutine 都已完成清理工作。 避免资源泄露。

Context 如何配合使用？

context.Context 是 Golang 中用于传递请求范围的数据、取消信号和截止时间的标准库。它可以很方便地用于管理 Goroutine 的生命周期。

package main

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

func workerWithContext(ctx context.Context, id int) {
    fmt.Printf("Worker %d starting\n", id)
    defer fmt.Printf("Worker %d done\n", id)

    for {
        select {
        case <-ctx.Done():
            fmt.Printf("Worker %d received context done signal: %v\n", id, ctx.Err())
            return
        default:
            fmt.Printf("Worker %d is working...\n", id)
            time.Sleep(time.Second)
        }
    }
}

func main() {
    ctx, cancel := context.WithCancel(context.Background())
    defer cancel() // 确保 cancel 函数被调用，释放资源

    for i := 1; i <= 3; i++ {
        go workerWithContext(ctx, i)
    }

    time.Sleep(5 * time.Second)

    fmt.Println("Sending context cancel signal...")
    cancel() // 通过调用 cancel 函数发送取消信号

    time.Sleep(2 * time.Second)
    fmt.Println("All workers done. Exiting.")
}

这个例子展示了如何使用 context.Context 来管理 Goroutine 的生命周期。context.WithCancel 函数创建一个可取消的 Context，cancel 函数用于发送取消信号。当 cancel 函数被调用时，所有监听 ctx.Done() channel 的 Goroutine 都会收到信号。ctx.Err() 返回取消的原因。使用 defer cancel() 可以确保 cancel 函数在 main 函数退出前被调用，释放资源。