Go 語言一次性定時器使用方式和實現原理

作者：frank 2022-10-17 00:07:55

開發前端

本文我們介紹 Go 語言標準庫 time? 包提供的一次性定時器 Timer，不僅介紹了它的使用方式，還介紹了它的實現原理。

?1.介紹

在 Go 語言標準庫 time? 包中的 Timer 類型，它是表示單一事件的計時器，也就是說它是一次性定時器。

在 Go 語言項目開發中，定時器使用廣泛，本文我們介紹 Go 語言中怎么使用 Timer，以及它的實現原理。

2.使用方式

使用 Timer? 一次性定時器，需要導入 time 包，創建定時器的方式有兩種，分別是：

func NewTimer(d Duration) *Timer

使用 func NewTimer? 創建 Timer?，入參是定時器的等待時間，時間到達時，發送當前時間到 channel中。

示例代碼：

func main() {
 nowTime := time.Now().Unix()
 fmt.Println(nowTime)
 NewTimerDemo()
}

func NewTimerDemo() {
 timer := time.NewTimer(2 * time.Second)
 select {
 case <-timer.C:
  currentTime := time.Now().Unix()
  fmt.Println(currentTime, "do something")
 }
}

輸出結果：

1665894136
1665894138 do something

通過閱讀上面這段代碼，我們可以發現我們定義了一個 2s? 后執行的定時器 timer?，然后使用 select? 讀取 timer.C 中的數據，當讀取到數據時，執行特定業務邏輯代碼。

func AfterFunc(d Duration, f func()) *Timer

使用 func AfterFunc? 創建 Timer，入參是定時器等待時間，和時間到達時執行的函數。

示例代碼：

func main() {
 nowTime := time.Now().Unix()
 fmt.Println(nowTime)
 AfterFuncDemo()
}

func AfterFuncDemo() {
 time.AfterFunc(2 * time.Second, func() {
  currentTime := time.Now().Unix()
  fmt.Println(currentTime, "do something")
 })
 time.Sleep(3 * time.Second)
}

閱讀上面這段代碼，細心的讀者朋友們可能已經發現，我們在代碼末尾使用 time.Sleep()?，這是因為 time.AfterFunc() 是異步執行的，所以需要等待協成退出。

3.實現原理

我們在源碼中查看 Timer? 的數據結構，發現它包含兩個字段，其中一個是可導出字段 C?，這是一個 Time?類型的 chan?；另一個是不可導出字段 r?，這是一個 runtimeTimer 類型。

type Timer struct {
    C <-chan Time
    r runtimeTimer
}

實際上，每個 Go 應用程序底層都會有一個特定的協程管理 Timer?，該協程（底層協程）監控到某個 Timer? 指定的時間到達時，就會將當前時間發送到 C? 中，然后上層讀取到 C 中的數據時，執行相關業務邏輯代碼。

底層協程監控 Timer? 的 r? 字段中的數據，我們在源碼中查看一下 runtimeTimer 的數據結構：

type runtimeTimer struct {
    tb     uintptr
    i      int
    when   int64
    period int64
    f      func(interface{}, uintptr)
    arg    interface{}
    seq    uintptr
}

閱讀上面這段代碼，我們可以發現 runtimeTimer? 中包含的所有字段，我們重點了解 when、f? 和 arg。

when：定時器執行時間。
f：定時器執行的回調函數。
arg：定時器執行的回調函數的參數。

在簡單了解 Timer? 的數據結構之后，我們在源碼中查看一下 func NewTimer 的代碼：

// 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)
 t := &Timer{
  C: c,
  r: runtimeTimer{
   when: when(d),
   f:    sendTime,
   arg:  c,
  },
 }
 startTimer(&t.r)
 return t
}

閱讀上面這段代碼，我們可以發現 func NewTimer? 的實現非常簡單，它實際上就是構造了一個 Timer?，然后把 Timer.r? 傳參給 startTimer()?，除了 startTimer()? 函數外，還有兩個函數，分別是 when()?和 sendTime?，其中 when()? 是計算計時器的執行時間，sendTime 是計時器時間到達時執行的事件（實際上就是將當前時間寫入通道中）。

sendTime 源碼：

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:
 }
}

我們已經了解到，func NewTimer? 將構造的 Timer.r? 傳參給 startTimer()?，它負責把 runtimeTimer?寫入底層協程的數組中（如果底層協程未運行，它將會啟動底層協程），將 Timer? 交給底層協程監控，也就是上面講到的，當底層協程監控到某個 Timer 指定時間到達時，將當前時間發送到它的通道中。

// startTimer adds t to the timer heap.
//go:linkname startTimer time.startTimer
func startTimer(t *timer) {
 if raceenabled {
  racerelease(unsafe.Pointer(t))
 }
 addtimer(t)
}

4.總結

本文我們介紹 Go 語言標準庫 time? 包提供的一次性定時器 Timer，不僅介紹了它的使用方式，還介紹了它的實現原理。

責任編輯：武曉燕來源： Golang語言開發棧

Go 語言標準庫