Go
語言的標(biāo)準(zhǔn)庫里提供兩種類型的計(jì)時器Timer
和Ticker
。Timer
經(jīng)過指定的duration
時間后被觸發(fā),往自己的時間channel
發(fā)送當(dāng)前時間,此后Timer
不再計(jì)時。Ticker
則是每隔duration
時間都會把當(dāng)前時間點(diǎn)發(fā)送給自己的時間channel
,利用計(jì)時器的時間channel
可以實(shí)現(xiàn)很多與計(jì)時相關(guān)的功能。
文章主要涉及如下內(nèi)容:
Timer
和Ticker
計(jì)時器的內(nèi)部結(jié)構(gòu)表示
Timer
和Ticker
的使用方法和注意事項(xiàng)
- 如何正確
Reset
定時器
計(jì)時器的內(nèi)部表示
兩種計(jì)時器都是基于Go
語言的運(yùn)行時計(jì)時器runtime.timer
實(shí)現(xiàn)的,rumtime.timer
的結(jié)構(gòu)體表示如下:
type timer struct {
pp puintptr
when int64
period int64
f func(interface{}, uintptr)
arg interface{}
seq uintptr
nextwhen int64
status uint32
}
rumtime.timer結(jié)構(gòu)體中的字段含義是
- when — 當(dāng)前計(jì)時器被喚醒的時間;
- period — 兩次被喚醒的間隔;
- f — 每當(dāng)計(jì)時器被喚醒時都會調(diào)用的函數(shù);
- arg — 計(jì)時器被喚醒時調(diào)用 f 傳入的參數(shù);
- nextWhen — 計(jì)時器處于 timerModifiedLater/timerModifiedEairlier 狀態(tài)時,用于設(shè)置 when 字段;
- status — 計(jì)時器的狀態(tài);
這里的 runtime.timer 只是私有的計(jì)時器運(yùn)行時表示,對外暴露的計(jì)時器 time.Timer 和time.Ticker的結(jié)構(gòu)體表示如下:
type Timer struct {
C -chan Time
r runtimeTimer
}
type Ticker struct {
C -chan Time
r runtimeTimer
}
Timer.C和Ticker.C就是計(jì)時器中的時間channel,接下來我們看一下怎么使用這兩種計(jì)時器,以及使用時要注意的地方。
Timer計(jì)時器
time.Timer 計(jì)時器必須通過 time.NewTimer、time.AfterFunc 或者 time.After 函數(shù)創(chuàng)建。 當(dāng)計(jì)時器失效時,失效的時間就會被發(fā)送給計(jì)時器持有的 channel,訂閱 channel 的 goroutine 會收到計(jì)時器失效的時間。
通過定時器Timer用戶可以定義自己的超時邏輯,尤其是在應(yīng)對使用select處理多個channel的超時、單channel讀寫的超時等情形時尤為方便。Timer常見的使用方法如下:
//使用time.AfterFunc:
t := time.AfterFunc(d, f)
//使用time.After:
select {
case m := -c:
handle(m)
case -time.After(5 * time.Minute):
fmt.Println("timed out")
}
// 使用time.NewTimer:
t := time.NewTimer(5 * time.Minute)
select {
case m := -c:
handle(m)
case -t.C:
fmt.Println("timed out")
}
time.AfterFunc這種方式創(chuàng)建的Timer,在到達(dá)超時時間后會在單獨(dú)的goroutine里執(zhí)行函數(shù)f。
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的源碼可以看到外面?zhèn)魅氲膄參數(shù)并非直接賦值給了運(yùn)行時計(jì)時器的f,而是作為包裝函數(shù)goFunc的參數(shù)傳入的。goFunc會啟動了一個新的goroutine來執(zhí)行外部傳入的函數(shù)f。這是因?yàn)樗杏?jì)時器的事件函數(shù)都是由Go運(yùn)行時內(nèi)唯一的 goroutine timerproc運(yùn)行的。為了不阻塞timerproc的執(zhí)行,必須啟動一個新的goroutine執(zhí)行到期的事件函數(shù)。
對于NewTimer和After這兩種創(chuàng)建方法,則是Timer在超時后,執(zhí)行一個標(biāo)準(zhǔn)庫中內(nèi)置的函數(shù):sendTime。
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) {
select {
case c.(chan Time) - Now():
default:
}
}
sendTime將當(dāng)前時間發(fā)送到Timer的時間channel中。那么這個動作不會阻塞timerproc的執(zhí)行么?答案是不會,原因是NewTimer創(chuàng)建的是一個帶緩沖的channel所以無論Timer.C這個channel有沒有接收方sendTime都可以非阻塞的將當(dāng)前時間發(fā)送給Timer.C,而且sendTime中還加了雙保險:通過select判斷Timer.C的Buffer是否已滿,一旦滿了,會直接退出,依然不會阻塞。
Timer的Stop方法可以阻止計(jì)時器觸發(fā),調(diào)用Stop方法成功停止了計(jì)時器的觸發(fā)將會返回true,如果計(jì)時器已經(jīng)過期了或者已經(jīng)被Stop停止過了,再次調(diào)用Stop方法將會返回false。
Go運(yùn)行時將所有計(jì)時器維護(hù)在一個最小堆Min Heap中,Stop一個計(jì)時器就是從堆中刪除該計(jì)時器。
Ticker計(jì)時器
Ticker可以周期性地觸發(fā)時間事件,每次到達(dá)指定的時間間隔后都會觸發(fā)事件。
time.Ticker需要通過time.NewTicker或者time.Tick創(chuàng)建。
// 使用time.Tick:
go func() {
for t := range time.Tick(time.Minute) {
fmt.Println("Tick at", t)
}
}()
// 使用time.Ticker
var ticker *time.Ticker = time.NewTicker(1 * time.Second)
go func() {
for t := range ticker.C {
fmt.Println("Tick at", t)
}
}()
time.Sleep(time.Second * 5)
ticker.Stop()
fmt.Println("Ticker stopped")
不過time.Tick很少會被用到,除非你想在程序的整個生命周期里都使用time.Ticker的時間channel。官文文檔里對time.Tick的描述是:
time.Tick底層的Ticker不能被垃圾收集器恢復(fù);
所以使用time.Tick時一定要小心,為避免意外盡量使用time.NewTicker返回的Ticker替代。
NewTicker創(chuàng)建的計(jì)時器與NewTimer創(chuàng)建的計(jì)時器持有的時間channel一樣都是帶一個緩存的channel,每次觸發(fā)后執(zhí)行的函數(shù)也是sendTime,這樣即保證了無論有誤接收方Ticker觸發(fā)時間事件時都不會阻塞:
func NewTicker(d Duration) *Ticker {
if d = 0 {
panic(errors.New("non-positive interval for NewTicker"))
}
// Give the channel a 1-element time buffer.
// If the client falls behind while reading, we drop ticks
// on the floor until the client catches up.
c := make(chan Time, 1)
t := Ticker{
C: c,
r: runtimeTimer{
when: when(d),
period: int64(d),
f: sendTime,
arg: c,
},
}
startTimer(t.r)
return t
}
Reset計(jì)時器時要注意的問題
關(guān)于Reset的使用建議,文檔里的描述是:
重置計(jì)時器時必須注意不要與當(dāng)前計(jì)時器到期發(fā)送時間到t.C的操作產(chǎn)生競爭。如果程序已經(jīng)從t.C接收到值,則計(jì)時器是已知的已過期,并且t.Reset可以直接使用。如果程序尚未從t.C接收值,計(jì)時器必須先被停止,并且-如果使用t.Stop時報(bào)告計(jì)時器已過期,那么請排空其通道中值。
例如:
if !t.Stop() {
-t.C
}
t.Reset(d)
下面的例子里producer goroutine里每一秒向通道中發(fā)送一個false值,循環(huán)結(jié)束后等待一秒再往通道里發(fā)送一個true值。在consumer goroutine里通過循環(huán)試圖從通道中讀取值,用計(jì)時器設(shè)置了最長等待時間為5秒,如果計(jì)時器超時了,輸出當(dāng)前時間并進(jìn)行下次循環(huán)嘗試,如果從通道中讀取出的不是期待的值(預(yù)期值是true),則嘗試重新從通道中讀取并重置計(jì)時器。
func main() {
c := make(chan bool)
go func() {
for i := 0; i 5; i++ {
time.Sleep(time.Second * 1)
c - false
}
time.Sleep(time.Second * 1)
c - true
}()
go func() {
// try to read from channel, block at most 5s.
// if timeout, print time event and go on loop.
// if read a message which is not the type we want(we want true, not false),
// retry to read.
timer := time.NewTimer(time.Second * 5)
for {
// timer is active , not fired, stop always returns true, no problems occurs.
if !timer.Stop() {
-timer.C
}
timer.Reset(time.Second * 5)
select {
case b := -c:
if b == false {
fmt.Println(time.Now(), ":recv false. continue")
continue
}
//we want true, not false
fmt.Println(time.Now(), ":recv true. return")
return
case -timer.C:
fmt.Println(time.Now(), ":timer expired")
continue
}
}
}()
//to avoid that all goroutine blocks.
var s string
fmt.Scanln(s)
}
程序的輸出如下:
2020-05-13 12:49:48.90292 +0800 CST m=+1.004554120 :recv false. continue
2020-05-13 12:49:49.906087 +0800 CST m=+2.007748042 :recv false. continue
2020-05-13 12:49:50.910208 +0800 CST m=+3.011892138 :recv false. continue
2020-05-13 12:49:51.914291 +0800 CST m=+4.015997373 :recv false. continue
2020-05-13 12:49:52.916762 +0800 CST m=+5.018489240 :recv false. continue
2020-05-13 12:49:53.920384 +0800 CST m=+6.022129708 :recv true. return
目前來看沒什么問題,使用Reset重置計(jì)時器也起作用了,接下來我們對producer goroutin做一些更改,我們把producer goroutine里每秒發(fā)送值的邏輯改成每6秒發(fā)送值,而consumer gouroutine里和計(jì)時器還是5秒就到期。
// producer
go func() {
for i := 0; i 5; i++ {
time.Sleep(time.Second * 6)
c - false
}
time.Sleep(time.Second * 6)
c - true
}()
再次運(yùn)行會發(fā)現(xiàn)程序發(fā)生了deadlock在第一次報(bào)告計(jì)時器過期后直接阻塞住了:
2020-05-13 13:09:11.166976 +0800 CST m=+5.005266022 :timer expired
那程序是在哪阻塞住的呢?對就是在抽干timer.C通道時阻塞住了(英文叫做drain channel比喻成流干管道里的水,在程序里就是讓timer.C管道中不再存在未接收的值)。
if !timer.Stop() {
-timer.C
}
timer.Reset(time.Second * 5)
producer goroutine的發(fā)送行為發(fā)生了變化,comsumer goroutine在收到第一個數(shù)據(jù)前有了一次計(jì)時器過期的事件,for循環(huán)進(jìn)行一下次循環(huán)。這時timer.Stop函數(shù)返回的不再是true,而是false,因?yàn)橛?jì)時器已經(jīng)過期了,上面提到的維護(hù)著所有活躍計(jì)時器的最小堆中已經(jīng)不包含該計(jì)時器了。而此時timer.C中并沒有數(shù)據(jù),接下來用于drain channel的代碼會將consumer goroutine阻塞住。
這種情況,我們應(yīng)該直接Reset計(jì)時器,而不用顯式drain channel。如何將這兩種情形合二為一呢?我們可以利用一個select來包裹drain channel的操作,這樣無論channel中是否有數(shù)據(jù),drain都不會阻塞住。
//consumer
go func() {
// try to read from channel, block at most 5s.
// if timeout, print time event and go on loop.
// if read a message which is not the type we want(we want true, not false),
// retry to read.
timer := time.NewTimer(time.Second * 5)
for {
// timer may be not active, and fired
if !timer.Stop() {
select {
case -timer.C: //try to drain from the channel
default:
}
}
timer.Reset(time.Second * 5)
select {
case b := -c:
if b == false {
fmt.Println(time.Now(), ":recv false. continue")
continue
}
//we want true, not false
fmt.Println(time.Now(), ":recv true. return")
return
case -timer.C:
fmt.Println(time.Now(), ":timer expired")
continue
}
}
}()
運(yùn)行修改后的程序,發(fā)現(xiàn)程序不會被阻塞住,能正常進(jìn)行通道讀取,讀取到true值后會自行退出。輸出結(jié)果如下:
2020-05-13 13:25:08.412679 +0800 CST m=+5.005475546 :timer expired
2020-05-13 13:25:09.409249 +0800 CST m=+6.002037341 :recv false. continue
2020-05-13 13:25:14.412282 +0800 CST m=+11.005029547 :timer expired
2020-05-13 13:25:15.414482 +0800 CST m=+12.007221569 :recv false. continue
2020-05-13 13:25:20.416826 +0800 CST m=+17.009524859 :timer expired
2020-05-13 13:25:21.418555 +0800 CST m=+18.011245687 :recv false. continue
2020-05-13 13:25:26.42388 +0800 CST m=+23.016530193 :timer expired
2020-05-13 13:25:27.42294 +0800 CST m=+24.015582511 :recv false. continue
2020-05-13 13:25:32.425666 +0800 CST m=+29.018267054 :timer expired
2020-05-13 13:25:33.428189 +0800 CST m=+30.020782483 :recv false. continue
2020-05-13 13:25:38.432428 +0800 CST m=+35.024980796 :timer expired
2020-05-13 13:25:39.428343 +0800 CST m=+36.020887629 :recv true. return
總結(jié)
以上比較詳細(xì)地介紹了Go語言的計(jì)時器以及它們的使用方法和注意事項(xiàng),總結(jié)一下有如下關(guān)鍵點(diǎn):
- Timer和Ticker都是在運(yùn)行時計(jì)時器runtime.timer的基礎(chǔ)上實(shí)現(xiàn)的。
- 運(yùn)行時里的所有計(jì)時器的事件函數(shù)都由運(yùn)行時內(nèi)唯一的goroutine timerproc觸發(fā)。
- time.Tick創(chuàng)建的Ticker在運(yùn)行時不會被gc回收,能不用就不用。
- Timer和Ticker的時間channel都是帶有一個緩沖的通道。
- time.After,time.NewTimer,time.NewTicker創(chuàng)建的計(jì)時器觸發(fā)時都會執(zhí)行sendTime。
- sendTime和計(jì)時器帶緩存的時間通道保證了計(jì)時器不會阻塞程序。
- Reset計(jì)時器時要注意drain channel和計(jì)時器過期存在競爭條件。
到此這篇關(guān)于Go語言的計(jì)時器的文章就介紹到這了,更多相關(guān)Go計(jì)時器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!