Go語言版crontab

1、cron 表達式的基本格式

用過 linux 的應該對 cron 有所了解。linux 中可以通過 crontab -e 來配置定時任務。不過，linux 中的 cron 只能精確到分鐘。而我們這里要討論的 Go 實現的 cron 可以精確到秒，除了這點比較大的區別外，cron 表達式的基本語法是類似的。（如果使用過 Java 中的 Quartz，對 cron 表達式應該比較了解，而且它和這里我們將要討論的 Go 版 cron 很像，也都精確到秒）

cron(計劃任務)，顧名思義，按照約定的時間，定時的執行特定的任務（job）。cron 表達式 表達了這種約定。

cron 表達式代表了一個時間集合，使用 6 個空格分隔的字段表示。

注：
1）月(Month)和星期(Day of week)字段的值不區分大小寫，如：SUN、Sun 和 sun 是一樣的。
2）星期
(Day of week)字段如果沒提供，相當于是 *

2、特殊字符說明

1）星號(*)

表示 cron 表達式能匹配該字段的所有值。如在第5個字段使用星號(month)，表示每個月

2）斜線(/)

表示增長間隔，如第1個字段(minutes) 值是 3-59/15，表示每小時的第3分鐘開始執行一次，之后每隔 15 分鐘執行一次（即 3、18、33、48 這些時間點執行），這里也可以表示為：3/15

3）逗號(,)

用于枚舉值，如第6個字段值是 MON,WED,FRI，表示 星期一、三、五 執行

4）連字號(-)

表示一個范圍，如第3個字段的值為 9-17 表示 9am 到 5pm 直接每個小時（包括9和17）

5）問號(?)

只用于 日(Day of month) 和 星期(Day of week)，表示不指定值，可以用于代替 *

3、主要類型或接口說明

1）Cron：包含一系列要執行的實體；支持暫停【stop】；添加實體等

type Cron struct {
    entries  []*Entry
    stop     chan struct{}   // 控制 Cron 實例暫停
    add      chan *Entry     // 當 Cron 已經運行了，增加新的 Entity 是通過 add 這個 channel 實現的
    snapshot chan []*Entry   // 獲取當前所有 entity 的快照
    running  bool            // 當已經運行時為true；否則為false
}

注意，Cron 結構沒有導出任何成員。

注意：有一個成員 stop，類型是 struct{}，即空結構體。

2）Entry：調度實體

type Entry struct {
    // The schedule on which this job should be run.
    // 負責調度當前 Entity 中的 Job 執行
    Schedule Schedule

    // The next time the job will run. This is the zero time if Cron has not been
    // started or this entry's schedule is unsatisfiable
    // Job 下一次執行的時間
    Next time.Time

    // The last time this job was run. This is the zero time if the job has never
    // been run.
    // 上一次執行時間
    Prev time.Time

    // The Job to run.
    // 要執行的 Job
    Job Job
}

3）Job：每一個實體包含一個需要運行的Job

這是一個接口，只有一個方法：run

type Job interface {
    Run()
}

由于 Entity 中需要 Job 類型，因此，我們希望定期運行的任務，就需要實現 Job 接口。同時，由于 Job 接口只有一個無參數無返回值的方法，為了使用方便，作者提供了一個類型：

type FuncJob func()

它通過簡單的實現 Run() 方法來實現 Job 接口：

func (f FuncJob) Run() { f() }

這樣，任何無參數無返回值的函數，通過強制類型轉換為 FuncJob，就可以當作 Job 來使用了，AddFunc 方法 就是這么做的。

4）Schedule：每個實體包含一個調度器（Schedule）

負責調度 Job 的執行。它也是一個接口。

type Schedule interface {
    // Return the next activation time, later than the given time.
    // Next is invoked initially, and then each time the job is run.
    // 返回同一 Entity 中的 Job 下一次執行的時間
    Next(time.Time) time.Time
}

Schedule 的具體實現通過解析 Cron 表達式得到。

庫中提供了 Schedule 的兩個具體實現，分別是 SpecSchedule 和 ConstantDelaySchedule。

① SpecSchedule

type SpecSchedule struct {
    Second, Minute, Hour, Dom, Month, Dow uint64
}

從開始介紹的 Cron 表達式可以容易得知各個字段的意思，同時，對各種表達式的解析也會最終得到一個 SpecSchedule 的實例。庫中的 Parse 返回的其實就是 SpecSchedule 的實例（當然也就實現了 Schedule 接口）。

② ConstantDelaySchedule

type ConstantDelaySchedule struct {
    Delay time.Duration // 循環的時間間隔
}

這是一個簡單的循環調度器，如：每 5 分鐘。注意，最小單位是秒，不能比秒還小，比如 毫秒。

通過 Every 函數可以獲取該類型的實例，如：

constDelaySchedule := Every(5e9)

得到的是一個每 5 秒執行一次的調度器。

4、主要實例化方法

1） 函數

① 實例化 Cron

func New() *Cron {
    return &Cron{
        entries:  nil,
        add:      make(chan *Entry),
        stop:     make(chan struct{}),
        snapshot: make(chan []*Entry),
        running:  false,
    }
}

可見實例化時，成員使用的基本是默認值；

② 解析 Cron 表達式

func Parse(spec string) (_ Schedule, err error)

spec 可以是：

• Full crontab specs, e.g. “* * * * * ?”
• Descriptors, e.g. “@midnight”, “@every 1h30m”

② 成員方法

// 將 job 加入 Cron 中
// 如上所述，該方法只是簡單的通過 FuncJob 類型強制轉換 cmd，然后調用 AddJob 方法
func (c *Cron) AddFunc(spec string, cmd func()) error

// 將 job 加入 Cron 中
// 通過 Parse 函數解析 cron 表達式 spec 的到調度器實例(Schedule)，之后調用 c.Schedule 方法
func (c *Cron) AddJob(spec string, cmd Job) error

// 獲取當前 Cron 總所有 Entities 的快照
func (c *Cron) Entries() []*Entry

// 通過兩個參數實例化一個 Entity，然后加入當前 Cron 中
// 注意：如果當前 Cron 未運行，則直接將該 entity 加入 Cron 中；
// 否則，通過 add 這個成員 channel 將 entity 加入正在運行的 Cron 中
func (c *Cron) Schedule(schedule Schedule, cmd Job)

// 新啟動一個 goroutine 運行當前 Cron
func (c *Cron) Start()

// 通過給 stop 成員發送一個 struct{}{} 來停止當前 Cron，同時將 running 置為 false
// 從這里知道，stop 只是通知 Cron 停止，因此往 channel 發一個值即可，而不關心值是多少
// 所以，成員 stop 定義為空 struct
func (c *Cron) Stop()

5、使用示例

package main

import (
    "github.com/robfig/cron"
    "log"
)

func main() {
    i := 0
    c := cron.New()
    spec := "*/5 * * * * ?"
    c.AddFunc(spec, func() {
        i++
        log.Println("cron running:", i)
    })
    c.Start()

    select{}
}

這是一個簡單示例。

輸出類似這樣：

2014/02/22 21:23:40 cron running: 1
2014/02/22 21:23:45 cron running: 2
2014/02/22 21:23:50 cron running: 3
2014/02/22 21:23:55 cron running: 4
2014/02/22 21:24:00 cron running: 5

可見 cron 的使用還是挺簡單的。

來自：http://blog.studygolang.com/2014/02/go_crontab/