Golang Ticker 停止方法与正确使用

本文深入探讨了 Golang 中 time.Ticker 的停止行为。Ticker.Stop() 仅停止计时器，并不会关闭通道，导致在 range 循环中监听通道的 Goroutine 永久阻塞。本文将提供一种使用额外通道来优雅地停止 Ticker 并退出 Goroutine 的方法，确保资源得到正确释放。

在 Golang 中，time.Ticker 用于周期性地发送时间事件到其通道 C。然而，当使用 Ticker.Stop() 停止计时器时，需要特别注意其行为。Stop() 方法会停止计时器，但不会关闭通道 C。这意味着如果有一个 Goroutine 正在使用 range 循环监听 ticker.C，它将永远阻塞，因为通道永远不会关闭。

问题分析

考虑以下示例：

package main

import (
    "log"
    "time"
)

func main() {
    ticker := time.NewTicker(1 * time.Second)
    go func() {
        for _ = range ticker.C {
            log.Println("tick")
        }
        log.Println("stopped")
    }()
    time.Sleep(3 * time.Second)
    log.Println("stopping ticker")
    ticker.Stop()
    time.Sleep(3 * time.Second)
}

运行此代码，会发现 Goroutine 在调用 ticker.Stop() 后并没有退出，"stopped" 消息永远不会打印。这是因为 range ticker.C 会一直等待通道接收数据，而 Stop() 只是停止了计时器发送数据，并没有关闭通道。

解决方案：使用额外的通道

为了解决这个问题，可以使用一个额外的通道来通知 Goroutine 退出循环。以下是一个改进后的示例：

package main

import (
    "log"
    "time"
)

// Run the function every tick
// Return false from the func to stop the ticker
func Every(duration time.Duration, work func(time.Time) bool) chan bool {
    ticker := time.NewTicker(duration)
    stop := make(chan bool, 1)

    go func() {
        defer log.Println("ticker stopped")
        for {
            select {
            case time := <-ticker.C:
                if !work(time) {
                    stop <- true
                }
            case <-stop:
                ticker.Stop() // Important: Stop the ticker before exiting
                return
            }
        }
    }()

    return stop
}

func main() {
    stop := Every(1*time.Second, func(time.Time) bool {
        log.Println("tick")
        return true
    })

    time.Sleep(3 * time.Second)
    log.Println("stopping ticker")
    stop <- true
    time.Sleep(3 * time.Second)
}

在这个解决方案中：

1. 创建了一个名为 stop 的通道，用于发送停止信号。
2. 在 Goroutine 中，使用 select 语句同时监听 ticker.C 和 stop 通道。
3. 当从 stop 通道接收到数据时，select 语句会执行 case <-stop 分支，从而退出循环。
4. 在退出循环前，必须调用 ticker.Stop()，以确保计时器被正确停止，防止资源泄露。
5. Every 函数返回 stop 通道，允许调用者发送停止信号。

代码解释

• Every(duration time.Duration, work func(time.Time) bool) chan bool: 这个函数封装了 Ticker 的创建和管理，接收一个时间间隔 duration 和一个回调函数 work。回调函数在每次 tick 时执行。
• stop := make(chan bool, 1): 创建一个带缓冲的通道，用于发送停止信号。缓冲大小为 1，可以防止发送者阻塞。
• select { ... }: select 语句用于同时监听多个通道。当其中一个通道有数据可读时，相应的 case 分支会被执行。
• ticker.Stop(): 在 Goroutine 退出前，必须调用 ticker.Stop()，停止计时器。
• stop <- true: 向 stop 通道发送数据，通知 Goroutine 退出。

注意事项

• 确保在 Goroutine 退出前调用 ticker.Stop()。 否则，计时器将继续运行，导致资源泄露。
• 使用带缓冲的通道作为停止信号通道，可以防止发送者阻塞。
• 在 select 语句中同时监听 ticker.C 和 stop 通道，以确保 Goroutine 可以及时响应停止信号。
• 避免直接关闭 ticker.C 通道，因为这可能会导致程序 panic。

总结

正确处理 Golang 中 time.Ticker 的停止行为至关重要，可以避免 Goroutine 永久阻塞和资源泄露。 通过使用额外的通道来发送停止信号，并确保在 Goroutine 退出前调用 ticker.Stop()，可以优雅地停止计时器并释放相关资源。 本文提供的示例代码和注意事项可以帮助你更好地理解和应用 time.Ticker。