携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第25天,点击查看活动详情

前言
TimerTickerTimer
Timer
TimerTimerchannel

timer结构体

src/time.sleep.go:TimerTimer
// Timer代表一次定时,时间到达后仅执行一个事件。
type Timer struct {
    C <-chan Time
    r runtimeTimer
}
复制代码
channeltimer.Cchannel

创建定时器

func NewTimer(d Duration) *Timer
复制代码

通过上面方法指定一个事件即可创建一个Timer,Timer一经创建便开始计时,不需要额外的启动命令。

示例:

func main()  {
	timer := time.NewTimer(time.Second * 5) //设置超时时间5s

	<- timer.C
	fmt.Println("Time out!")
}
复制代码

停止定时器

Timer创建后可以随时停止,停止计时器的方法如下:

func (t *Timer) Stop() bool
复制代码

其返回值代表定时器有没有超时:

  • true:定时器超时前停止,后续不会再有事件发送。
  • false:定时器超时后停止。

示例:

func main()  {
	timer := time.NewTimer(time.Second * 5) //设置超时时间5s
    timer.Stop()
}
复制代码

重置定时器

已经过期的定时器或者已停止的定时器,可以通过重置动作重新激活,方法如下:

func (t *Timer) Reset(d Duration) bool
复制代码

重置的动作本质上是先停掉定时器,再启动,其返回值也即是停掉计时器的返回值。

func main()  {
	timer := time.NewTimer(time.Second * 5)

	<- timer.C
	fmt.Println("Time out!")

	timer.Stop() 
	timer.Reset(time.Second*3)  // 重置定时器
}
复制代码
实现原理

每个Go应用程序都有一个协程专门负责管理所有的Timer,这个协程负责监控Timer是否过期,过期后执行一个预定义的动作,这个动作对于Timer而言就是发送当前时间到管道中。

数据结构

type Timer struct {
    C <-chan Time
    r runtimeTimer
}
复制代码

Timer只有两个成员:

  • C:channel,上层应用根据此管道接收事件;
  • r:runtimeTimer定时器,该定时器即系统管理的定时器,上层应用不可见。

runtimeTimer

任务的载体,用于监控定时任务,每创建一个Timer就创建一个runtimeTimer变量,然后把它交给系统进行监控,我们通过设置runtimeTimer过期后的行为来达到定时的目的。

源码包src/time/sleep.go:runtimeTimer定义了其数据结构:

type runtimeTimer struct {
    tb uintptr                          // 存储当前定时器的数组地址
    i  int                              // 存储当前定时器的数组下标

    when   int64                        // 当前定时器触发时间
    period int64                        // 当前定时器周期触发间隔
    f      func(interface{}, uintptr)   // 定时器触发时执行的函数
    arg    interface{}                  // 定时器触发时执行函数传递的参数一
    seq    uintptr                      // 定时器触发时执行函数传递的参数二(该参数只在网络收发场景下使用)
}
复制代码

创建Timer

源码实现:

func NewTimer(d Duration) *Timer {
    c := make(chan Time, 1)  // 创建一个管道
    t := &Timer{ // 构造Timer数据结构
        C: c,               // 新创建的管道
        r: runtimeTimer{
            when: when(d),  // 触发时间
            f:    sendTime, // 触发后执行函数sendTime
            arg:  c,        // 触发后执行函数sendTime时附带的参数
        },
    }
    startTimer(&t.r) // 此处启动定时器,只是把runtimeTimer放到系统协程的堆中,由系统协程维护
    return t
}
复制代码
NewTimer()TimerTimer.rstartTimer()sendTimechannelsendTime

sendTime实现:

//c interface{} 就是NewTimer 赋值的参数,就是channel
func sendTime(c interface{}, seq uintptr) {
    select {
    case c.(chan Time) <- Now(): //写不进去的话,C 已满,走default 分支
    default:
    }
}
复制代码

停止Timer

停止Timer,就是把Timer从系统协程中移除。函数主要实现如下:

func (t *Timer) Stop() bool {
    return stopTimer(&t.r)
}
复制代码

stopTimer()即通知系统协程把该Timer移除,即不再监控。系统协程只是移除Timer并不会关闭管道,以避免用户协程读取错误。

重置Timer

重置Timer时会先把timer从系统协程中删除,修改新的时间后重新添加到系统协程中。

func (t *Timer) Reset(d Duration) bool {
    w := when(d)
    active := stopTimer(&t.r)
    t.r.when = w
    startTimer(&t.r)
    return active
}
复制代码