Go語言中定時任務庫Cron使用方法介紹

2022-03-30 19:03:42

快速入門

安裝cron，注意這裡安裝的是v3版本。新版本和舊版時間使用有所區別

go get github.com/robfig/cron/v3@v3.0.0

在專案中匯入

import "github.com/robfig/cron/v3"

v3版本的github.com/robfig/cron/v3預設解析器符合Cron 維基百科頁面所描述的標準
用法大致如下

package main
import (
	"fmt"
	"github.com/robfig/cron/v3"
)
func main() {
	c := cron.New()
	c.AddFunc("30 * * * *", func() { fmt.Println("Every hour on the half hour") })
	c.AddFunc("30 3-6,20-23 * * *", func() { fmt.Println(".. in the range 3-6am, 8-11pm") })
	c.AddFunc("CRON_TZ=Asia/Tokyo 30 04 * * *", func() { fmt.Println("Runs at 04:30 Tokyo time every day") })
	c.AddFunc("@hourly", func() { fmt.Println("Every hour, starting an hour from now") })
	c.AddFunc("@every 1h30m", func() { fmt.Println("Every hour thirty, starting an hour thirty from now") })
	c.Start()
	select {}
}

Cron表示式格式

一個 cron 表示式表示一組時間，使用 5 個空格分隔的欄位。這是v3版本預設支援的格式。

Field name   | Mandatory? | Allowed values  | Allowed special characters
----------   | ---------- | --------------  | --------------------------
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  | * / , - ?

如果要想在v3版本中也支援秒級別的解析，需要自定義解析器。程式碼如下

Field name   | Mandatory? | Allowed values  | Allowed special characters
----------   | ---------- | --------------  | --------------------------
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  | * / , - ?

func main() {
// Seconds field, required
cron.New(cron.WithSeconds())

// Seconds field, optional
cron.New(cron.WithParser(cron.NewParser(
	cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
)))
}

預定義時間表

可以用@yearly、@monthly、@weekly、@weekly、@daily、@hourly來替代cron表示式。分別表示每年，每月、每星期、每天、每小時。
還可以用@every <duartion>來表示間隔時間，即間隔<duration>執行一次任務。<duration>只要可以被time.ParseDuration()解析即可

設定時區

func main() {

cron.New(
    cron.WithLocation(time.UTC))
}

常用的方法介紹

New()

package main
import (
	"fmt"
	"github.com/robfig/cron/v3"
)
func main() {
    // 建立一個預設的cron物件
	c := cron.New()
    
    // 自定義解析器
    cron.New(cron.WithSeconds())
    // Seconds field, optional
    cron.New(cron.WithParser(cron.NewParser(
        cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
    )))
    
	select {}
}

AddJob()

// 有兩個引數，第一個引數可以是cron表示式或者預定義時間表，第二個Job
func (c *Cron) AddJob(spec string, cmd Job) (EntryID, error)

// Job是一個介面，有一個Run方法
type Job interface {
	Run()
}

自定義個一個func型別，實現Run方法。不過一般可以直接用下面講的AddFunc方法即可

package main
import (
	"fmt"
	"github.com/robfig/cron/v3"
)
type MyJob func()
func (f MyJob) Run() {
	fmt.Println("myJob")
}
func main() {
	c := cron.New()
	c.AddJob("@every 1s", MyJob(func() {
		fmt.Println("myjob")
	}))
	c.Start()
	select {}

AddFunc()

// 有兩個引數，第一個引數可以是cron表示式或者預定義時間表，第二個傳入一個函數，就是要執行的任務
// 會返回一個Id和error
// 會把傳入的cmd func轉成FuncJob。FuncJob實現了Job介面
func (c *Cron) AddFunc(spec string, cmd func()) (EntryID, error) {
	return c.AddJob(spec, FuncJob(cmd))
}

package main
import (
	"fmt"
	"github.com/robfig/cron/v3"
)
func main() {
	c := cron.New()
	Id, err := c.AddFunc("30 * * * *", func() { fmt.Println("Every hour on the half hour") })
	
    // Id可以用做取消任務
    c.Remove(Id)
	select {}
}

Start()
呼叫start方法開始執行任務

func main() {
	c := cron.New()
	c.AddJob("@every 1s", MyJob(func() {
		fmt.Println("myjob")
	}))
	c.AddFunc()
	c.Start()
	select {}
}

到此這篇關於Go語言中定時任務庫Cron使用詳解的文章就介紹到這了,更多相關Go定時任務庫Cron內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！