golang 中第三方定時任務庫
一.cron
官網: https://github.com/robfig/cron
安裝
$ go get github.com/robfig/cron/v3@v3.0.0
cron 表達式的基本格式
用過 linux 的應該對 crond 有所了解。linux 中可以通過 crontab -e 來配置定時任務。不過，linux 中的 crond 只能精確到分鍾。而我們這里要討論的 Go 實現的 cron 可以精確到秒，除了這點比較大的區別外，cron 表達式的基本語法是類似的。（如果使用過 Java 中的 Quartz，對 cron 表達式應該比較了解，而且它和這里我們將要討論的 Go 版 cron 很像，也都精確到秒） cron(計划任務)，顧名思義，按照約定的時間，定時的執行特定的任務（job）。cron 表達式 表達了這種約定。 cron 表達式代表了一個時間集合，使用 6 個空格分隔的字段表示。
| 字段名 | 是否必須 | 允許的值 | 允許的特定字符 |
|---|---|---|---|
| 秒(Seconds) | 是 | 0-59 | * / , - |
| 分(Minutes) | 是 | 0-59 | * / , - |
| 時(Hours) | 是 | 0-23 | * / , - |
| 日(Day of month) | 是 | 1-31 | * / , – ? |
| 月(Month) | 是 | 1-12 or JAN-DEC | * / , - |
| 星期(Day of week) | 否 | 0-6 or SUM-SAT | * / , – ? |
注：
- 月(Month)和星期(Day of week)字段的值不區分大小寫，如：SUN、Sun 和 sun 是一樣的。
- 星期 (Day of week)字段如果沒提供，相當於是 *
特殊字符說明
- 星號(*) 表示 cron 表達式能匹配該字段的所有值。如在第 5 個字段使用星號(month)，表示每個月
- 斜線(/) 表示增長間隔，如第 1 個字段(minutes) 值是 3-59/15，表示每小時的第 3 分鍾開始執行一次，之后每隔 15 分鍾執行一次（即 3、18、33、48 這些時間點執行），這里也可以表示為：3/15
- 逗號(,) 用於枚舉值，如第 6 個字段值是 MON,WED,FRI，表示 星期一、三、五 執行
- 連字號(-) 表示一個范圍，如第 3 個字段的值為 9-17 表示 9am 到 5pm 直接每個小時（包括 9 和 17）
- 問號(?) 只用於日(Day of month)和星期(Day of week)，\表示不指定值，可以用於代替 *
cron 舉例說明
- 每隔 5 秒執行一次：*/5 * * * *
- 每隔 1 分鍾執行一次：0 */1 * * * ?
- 每天 23 點執行一次：0 0 23 * * ?
- 每天凌晨 1 點執行一次：0 0 1 * * ?
- 每月 1 號凌晨 1 點執行一次：0 0 1 1 * ?
- 在 26 分、29 分、33 分執行一次：0 26, 29, 33 * * * ?
- 每天的 0 點、13 點、18 點、21 點都執行一次：0 0 0, 13, 18, 21 * * ?
示例
最簡單 crontab 任務, 根據官網手冊寫法
package main
import (
"fmt"
"github.com/robfig/cron/v3"
"log"
)
func main() {
i := 0
c := cron.New()
spec := "*/5 * * * * ?" // 每5秒執行一次
_, err := c.AddFunc(spec, func() {
i++
log.Println("cron running:", i)
})
if err != nil {
fmt.Println(err)
return
}
c.Start()
select {}
}
會報一個錯誤
expected exactly 5 fields, found 6: [*/5 * * * * ?]
這就尷尬了，可能默認不支持秒級別的任務吧，查詢大量資料，把代碼修改為一下代碼就可以完美運行了
package main
import (
"fmt"
"github.com/robfig/cron/v3"
"log"
)
func newWithSeconds() *cron.Cron {
secondParser := cron.NewParser(cron.Second | cron.Minute |
cron.Hour | cron.Dom | cron.Month | cron.DowOptional | cron.Descriptor)
return cron.New(cron.WithParser(secondParser), cron.WithChain())
}
func main() {
i := 0
c := newWithSeconds()
spec := "*/3 * * * * ?" // 每3秒執行一次
_, err := c.AddFunc(spec, func() {
i++
log.Println("cron running:", i)
})
if err != nil {
fmt.Println(err)
return
}
c.Start()
select {}
}
輸出結果
2020/02/25 22:26:24 cron running: 1
2020/02/25 22:26:27 cron running: 2
2020/02/25 22:26:30 cron running: 3
多個定時 crontab 任務
package main
import (
"fmt"
"github.com/robfig/cron/v3"
"log"
)
type TestJob01 struct {
}
func (t TestJob01) Run() {
fmt.Println("test job 01...")
}
type TestJob02 struct {
}
func (t TestJob02) Run() {
fmt.Println("test job 01...")
}
func newWithSeconds() *cron.Cron {
secondParser := cron.NewParser(cron.Second | cron.Minute |
cron.Hour | cron.Dom | cron.Month | cron.DowOptional | cron.Descriptor)
return cron.New(cron.WithParser(secondParser), cron.WithChain())
}
func main() {
i := 0
c := newWithSeconds()
// AddFunc
spec := "*/5 * * * * ?" // 每5秒執行一次
c.AddFunc(spec, func() {
i++
log.Println("cron running:", i)
})
// AddJob方法
spec2 := "*/3 * * * * ?" // 每3秒執行一次
// 結構體只需要實現Job接口的Run()方法就可以使用AddJob方法創建任務
c.AddJob(spec2, TestJob01{})
c.AddJob(spec2, TestJob01{})
c.Start()
select {}
}
輸出結果
test job 01...
test job 02...
2020/02/25 22:35:10 cron running: 1
test job 02...
test job 01...
test job 01...
test job 02...
2020/02/25 22:35:15 cron running: 2
二.gocron
官網: https://github.com/jasonlvhit/gocron
安裝
$ go get -u github.com/jasonlvhit/gocron
使用
每隔 1 秒執行一個任務，每隔 4 秒執行另一個任務：
package main
import (
"fmt"
"github.com/jasonlvhit/gocron"
"time"
)
func task() {
fmt.Println("I am runnning task.", time.Now())
}
func superWang() {
fmt.Println("I am runnning superWang.", time.Now())
}
func test(s *gocron.Scheduler, sc chan bool) {
time.Sleep(8 * time.Second)
s.Remove(task) // 移除task任務
time.Sleep(6 * time.Second)
s.Clear() // 清除所有任務
fmt.Println("所有任務已經移除")
close(sc) // 關閉阻塞通道
}
func main() {
s := gocron.NewScheduler()
s.Every(1).Seconds().Do(task) // 每1秒執行一次
s.Every(4).Seconds().Do(superWang) // 每4秒執行一次
sc := s.Start() // 保持堵塞
go test(s, sc) // 測試任務
<-sc
}
輸出結果
I am runnning task. 2020-02-25 22:47:14.17147 +0800 CST m=+1.005913427
I am runnning task. 2020-02-25 22:47:15.166802 +0800 CST m=+2.001240185
I am runnning task. 2020-02-25 22:47:16.169687 +0800 CST m=+3.004120087
I am runnning superWang. 2020-02-25 22:47:17.17018 +0800 CST m=+4.004608274
I am runnning task. 2020-02-25 22:47:17.170379 +0800 CST m=+4.004806812
I am runnning task. 2020-02-25 22:47:18.166961 +0800 CST m=+5.001384129
I am runnning task. 2020-02-25 22:47:19.170195 +0800 CST m=+6.004612901
I am runnning task. 2020-02-25 22:47:20.166981 +0800 CST m=+7.001393545
I am runnning task. 2020-02-25 22:47:21.169624 +0800 CST m=+8.004031759
I am runnning superWang. 2020-02-25 22:47:21.169664 +0800 CST m=+8.004071487
I am runnning superWang. 2020-02-25 22:47:22.170581 +0800 CST m=+9.004983584
I am runnning superWang. 2020-02-25 22:47:26.17089 +0800 CST m=+13.005272477
所有任務已經移除