golang 實現定時服務很簡單,只需要簡單幾步代碼便可以完成,不需要配置繁瑣的服務器,直接在代碼中實現。
使用 https://github.com/robfig/cron 這個包,它實現了 cron 規范解析器和任務運行器。
cron 介紹
參見:https://godoc.org/github.com/robfig/cron
用法
注冊在指定時間上運行的函數,cron 將會在協程中運行這些注冊函數。AddFunc 函數第一個參數指定定時任務時間間隔,第二個參數指定運行函數。
c := cron.New()
c.AddFunc("0 30 * * * *", func() { fmt.Println("Every hour on the half hour") })
c.AddFunc("@hourly", func() { fmt.Println("Every hour") })
c.AddFunc("@every 1h30m", func() { fmt.Println("Every hour thirty") })
c.Start()
..
// 函數將在它們自己的goroutine中異步調用
...
// 也可以在運行的Cron中添加任務
c.AddFunc("@daily", func() { fmt.Println("Every day") })
..
// 檢查cron任務條目的下一個和上一個運行時間
inspect(c.Entries())
..
c.Stop() // 停止定時任務(不停止已經運行的任務)
Cron 表達式格式
字段名 | 是否必須 | 取值范圍 | 特殊字符串 |
---|---|---|---|
秒(Seconds) | Yes | 0-59 | * / , - |
分(Minutes) | Yes | 0-59 | * / , - |
小時(Hours) | Yes | 0-23 | * / , - |
一個月中的某一天(Day of month) | Yes | 1-31 | * / , - ? |
月(Month) | Yes | 1-12 or JAN-DEC | * / , - |
星期幾(Day of week) | Yes | 0-6 or SUN-SAT | * / , - ? |
注意:月和星期字段值不區分大小寫。'SUN'、'Sun'和'sun'都是一樣的
特殊字符說明
星號(*)
星號表示cron表達式將匹配該字段的所有值,比如,在上面表達式'月'中使用星號,就表示每個月
斜線(/)
斜杠用于描述范圍的增量,比如'3-59/15'這個表達式在表示從現在的第三分鐘開始和往后的每15分鐘,到第59分鐘為止。表現形式為"* \ / ...",等同于"N-MAX / m",即在該字段范圍內的增量。即從N開始,使用增量 m 直到 MAX 結束,它沒有重復
逗號(,)
逗號用于分隔列表中的項,比如,在上表的'星期幾'中使用 "MON,WED,FRI" 表示星期一、星期三和星期五
連字符 (-)
連字符用于定義范圍。例如,9-17表示包括上午9點至下午5點在內的每小時
問好 (?)
表示不指定值,可以來代替 "*"
預定義的時間格式
您可以使用幾個預定義的表達式來代替上表的表達式
輸入 | 描述 | 等式 |
---|---|---|
@yearly (or @annually) | 每年1月1日午夜跑步一次 | 0 0 0 1 1 * |
@monthly | 每個月第一天的午夜跑一次 | 0 0 0 1 * * |
@weekly | 每周周六的午夜運行一次 | 0 0 0 * * 0 |
@daily (or @midnight) | 每天午夜跑一次 | 0 0 0 * * * |
@hourly | 每小時運行一次 | 0 0 * * * * |
使用說明
從github下載cron的包到本地庫或者加入道自己的項目中引用都可以,包中有多個測試用例,可以參考它們的用法
代碼實現
代碼很簡單,只要幾行即可實現,下面是一個簡單使用的示例,說明見代碼注釋:
package main
import (
"demo/cron"
"log"
"time"
)
func main() {
log.Println("Starting...")
// 定義一個cron運行器
c := cron.New()
// 定時5秒,每5秒執行print5
c.AddFunc("*/5 * * * * *", print5)
// 定時15秒,每5秒執行print5
c.AddFunc("*/15 * * * * *", print15)
// 開始
c.Start()
defer c.Stop()
// 這是一個使用time包實現的定時器,與cron做對比
t1 := time.NewTimer(time.Second * 10)
for {
select {
case <-t1.C:
t1.Reset(time.Second * 10)
print10()
}
}
}
func print5() {
log.Println("Run 5s cron")
}
func print10() {
log.Println("Run 10s cron")
}
func print15() {
log.Println("Run 15s cron")
}
運行結果
可以看出time包形式的定時器是以程序啟動時間為準的,而cron的定時有表達式決定,兩者都實現了定時器效果,一般程序中也夠用了
以上就是基于golang的cron的基本使用了