Golang定時器陷阱

所謂陷阱，就是它不是你認為的那樣，這種認知誤差可能讓你的軟體留下隱藏Bug。剛好Timer就有3個陷阱，我們會講1）Reset的陷阱和2）通道的陷阱，3）Stop的陷阱與Reset的陷阱類似，自己探索吧。

Reset的陷阱在哪

Timer.Reset()函數的傳回值是bool類型，我們看一個問題三連：

1. 它的傳回值代表什麼呢？
2. 我們想要的成功是什嗎？
3. 失敗是什嗎？

• 成功：一段時間之後定時器逾時，收到逾時事件。
• 失敗：成功的反面，我們收不到那個事件。對於失敗，我們應當做些什麼，確保我們的定時器發揮作用。

Reset的傳回值是不是這個意思？

通過查看文檔和實現，Timer.Reset()的傳回值並不符合我們的預期，這就是誤差。它的傳回值不代表重設定時器成功或失敗，而是在表達定時器在重設前的狀態：

• 當Timer已經停止或者逾時，返回false。
• 當定時器未逾時時，返回true。

所以，當Reset返回false時，我們並不能認為一段時間之後，逾時不會到來，實際上可能會到來，定時器已經生效了。

跳過陷阱，再遇陷阱

如何跳過前面的陷阱，讓Reset符合我們的預期功能呢？直接忽視Reset的傳回值好了，它不能協助你達到預期的效果。

真正的陷阱是Timer的通道，它和我們預期的成功、失敗密切相關。我們所期望的定時器設定失敗，通常只和通道有關：設定定時器前，定時器的通道Timer.C中是否已經有資料。

• 如果有，我們設定的定時器失敗了，我們可能讀到不正確的逾時事件。
• 如果沒有，我們設定的定時器成功了，我們在設定的時間得到逾時事件。

接下來解釋為何失敗只與通道中是否存在逾時事件有關。

定時器的緩衝通道大小隻為1，無法多存放逾時事件，看源碼。

// NewTimer creates a new Timer that will send// the current time on its channel after at least duration d.func NewTimer(d Duration) *Timer {    c := make(chan Time, 1) // 緩衝通道大小為1    t := &Timer{        C: c,        r: runtimeTimer{            when: when(d),            f:    sendTime,            arg:  c,        },    }    startTimer(&t.r)    return t}

定時器建立後是單獨啟動並執行，逾時後會向通道寫入資料，你從通道中把資料讀走。當前一次的逾時資料沒有被讀取，而設定了新的定時器，然後去通道讀資料，結果讀到的是上次逾時的逾時事件，看似成功，實則失敗，完全掉入陷阱。

跨越陷阱，確保成功

如果確保Timer.Reset()成功，得到我們想要的結果？Timer.Reset()前清空通道。

• 當業務情境簡單時，沒有必要主動清空通道。比如，處理流程是：設定1次定時器，處理一次定時器，中間無中斷，下次Reset前，通道必然是空的。
• 當業務情境複雜時，不確定通道是否為空白，那就主動清除。

if len(Timer.C) > 0{    <-Timer.C}Timer.Reset(time.Second)

測試代碼

package mainimport (    "fmt"    "time")// 不同情況下，Timer.Reset()的傳回值func test1() {    fmt.Println("第1個測試：Reset傳回值和什麼有關？")    tm := time.NewTimer(time.Second)    defer tm.Stop()    quit := make(chan bool)    // 退出事件    go func() {        time.Sleep(3 * time.Second)        quit <- true    }()    // Timer未逾時，看Reset的傳回值    if !tm.Reset(time.Second) {        fmt.Println("未逾時，Reset返回false")    } else {        fmt.Println("未逾時，Reset返回true")    }    // 停止timer    tm.Stop()    if !tm.Reset(time.Second) {        fmt.Println("停止Timer，Reset返回false")    } else {        fmt.Println("停止Timer，Reset返回true")    }    // Timer逾時    for {        select {        case <-quit:            return        case <-tm.C:            if !tm.Reset(time.Second) {                fmt.Println("逾時，Reset返回false")            } else {                fmt.Println("逾時，Reset返回true")            }        }    }}func test2() {    fmt.Println("\n第2個測試:逾時後，不讀通道中的事件，可以Reset成功嗎？")    sm2Start := time.Now()    tm2 := time.NewTimer(time.Second)    time.Sleep(2 * time.Second)    fmt.Printf("Reset前通道中事件的數量:%d\n", len(tm2.C))    if !tm2.Reset(time.Second) {        fmt.Println("不讀通道資料，Reset返回false")    } else {        fmt.Println("不讀通道資料，Reset返回true")    }    fmt.Printf("Reset後通道中事件的數量:%d\n", len(tm2.C))    select {    case t := <-tm2.C:        fmt.Printf("tm2開始的時間: %v\n", sm2Start.Unix())        fmt.Printf("通道中事件的時間：%v\n", t.Unix())        if t.Sub(sm2Start) <= time.Second+time.Millisecond {            fmt.Println("通道中的時間是重新設定sm2前的時間，即第一次逾時的時間，所以第二次Reset失敗了")        }    }    fmt.Printf("讀通道後，其中事件的數量:%d\n", len(tm2.C))    tm2.Reset(time.Second)    fmt.Printf("再次Reset後，通道中事件的數量:%d\n", len(tm2.C))    time.Sleep(2 * time.Second)    fmt.Printf("逾時後通道中事件的數量:%d\n", len(tm2.C))}func test3() {    fmt.Println("\n第3個測試：Reset前清空通道，儘可能通暢")    smStart := time.Now()    tm := time.NewTimer(time.Second)    time.Sleep(2 * time.Second)    if len(tm.C) > 0 {        <-tm.C    }    tm.Reset(time.Second)    // 逾時    t := <-tm.C    fmt.Printf("tm開始的時間: %v\n", smStart.Unix())    fmt.Printf("通道中事件的時間：%v\n", t.Unix())    if t.Sub(smStart) <= time.Second+time.Millisecond {        fmt.Println("通道中的時間是重新設定sm前的時間，即第一次逾時的時間，所以第二次Reset失敗了")    } else {        fmt.Println("通道中的時間是重新設定sm後的時間，Reset成功了")    }}func main() {    test1()    test2()    test3()}