Go語言中Timer計時器的使用技巧詳解

更新時間：2023年07月25日 10:56:26 作者：cainmusic

Go語言中的time包里有個Timer計時器的功能，這篇文章主要就是來和大家介紹一下Timer計時器的使用技巧，感興趣的小伙伴可以跟隨小編一起學習一下

time包里有個Timer計時器的功能，主要的結構和函數有：

type Timer struct {
    C <-chan Time
    r runtimeTimer
}
func After(d Duration) <-chan Time
func AfterFunc(d Duration, f func()) *Timer
func NewTimer(d Duration) *Timer
func (*Timer) Reset(d Duration) bool
func (*Timer) Stop() bool

三個基本用法：

c := time.After(time.Second)
fmt.Println(<-c)
t := time.NewTimer(time.Second)
fmt.Println(<-t.C)
tc := make(chan int)
time.AfterFunc(time.Second, func() { tc <- 1 })
fmt.Println(<-tc)

After函數實際就是return NewTimer(d).C，和NewTimer的用法類似，但Timer本身還有Reset、Stop等方法可用，有相關需求的，應使用NewTimer。

AfterFunc相當于在d Duration之后創(chuàng)建了一個執(zhí)行f的goroutine，返回的Timer本身并不會阻塞，也不能像前面的例子那樣使用Timer.C，但可以使用Reset、Stop等方法。

導致上面區(qū)別的原因在于使用NewTimer和AfterFunc生成計時器的時候，內部使用的調用參數并不相同。

NewTimer：

func NewTimer(d Duration) *Timer {
    c := make(chan Time, 1)
    t := &Timer{
        C: c,
        r: runtimeTimer{
            when: when(d),
            f:    sendTime,
            arg:  c,
        },
    }
    startTimer(&t.r)
    return t
}
func sendTime(c interface{}, seq uintptr) {
    // Non-blocking send of time on c.
    // Used in NewTimer, it cannot block anyway (buffer).
    // Used in NewTicker, dropping sends on the floor is
    // the desired behavior when the reader gets behind,
    // because the sends are periodic.
    select {
    case c.(chan Time) <- Now():
    default:
    }
}

NewTimer在計時器完成時使用sendTime函數，非阻塞的向Timer.C中傳入當前時間，所以在計時器完成時，可以從其中獲取內容。

AfterFunc：

func AfterFunc(d Duration, f func()) *Timer {
    t := &Timer{
        r: runtimeTimer{
            when: when(d),
            f:    goFunc,
            arg:  f,
        },
    }
    startTimer(&t.r)
    return t
}
func goFunc(arg interface{}, seq uintptr) {
    go arg.(func())()
}

AfterFunc則是在計時器完成時調用goFunc，在goFunc中啟動一個執(zhí)行參數f的goroutine，而并未對Timer.C進行任何操作，于是我們無法從其中獲取內容。

注：下面的內容主要基于NewTimer創(chuàng)建的Timer

Timer使用的關鍵點：

一，在一些任務中我們需要多次重復計時，不要使用循環(huán)創(chuàng)建大量計時器，會影響性能，盡量使用Reset和Stop來復用已創(chuàng)建的計時器。

二，Timer的Stop方法并不會關閉Timer.C，可能會導致意外的阻塞，如：

func main() {
    timer := time.NewTimer(time.Second)
    go func() {
        timer.Stop()
    }()
    <-timer.C
}

會導致程序阻塞，無法退出。

關于Timer的Reset和Stop的使用小技巧：

// 用下面的非阻塞方法使用Stop
func timerStop(t *time.Timer) {
    if !t.Stop() {
        select {
        case <-t.C:
        default:
        }
    }
}
// Reset之前先執(zhí)行Stop
func timerReset(t *time.Timer, d time.Duration) {
    timerStop(t)
    t.Reset(d)
}

關于Reset之前為何要Stop，time包的Reset文檔如下說：

For a Timer created with NewTimer, Reset should be invoked only on stopped or expired timers with drained channels.

對于使用NewTimer創(chuàng)建的Timer，Reset應該用在已經停止或過期，并已經排空管道的計時器上。

If a program has already received a value from t.C, the timer is known to have expired and the channel drained, so t.Reset can be used directly. If a program has not yet received a value from t.C, however, the timer must be stopped and—if Stop reports that the timer expired before being stopped—the channel explicitly drained:

如果一個程序已經從t.C中接收了值，計時器過期了并且管道已被排空，Reset可以直接使用。但如果程序還未從t.C中接收值，而計時器需要被停止，并且Stop方法報告計時器在被停止前已經過期，則管道需要被顯式的排空：