一文帶你入門Go語言中定時任務庫Cron的使用

2022-08-25 14:01:43

前言

在平時的開發需求中，我們經常會有一些重複執行的操作需要觸發執行，和系統約個時間，在幾點幾分幾秒或者每隔幾分鐘跑一個任務，說白了就是定時任務，，想必大家第一反應都是linux的Crontab。其實定時任務不止使用系統自帶的Crontab，在Go語言中也可以使用Cron定時任務庫, 這篇文章給大家介紹如何在go專案中實現一個crontab功能，感興趣的小夥伴們可以參考借鑑，希望對大家能有所幫助。

golang 實現定時服務很簡單，只需要簡單幾步程式碼便可以完成，不需要設定繁瑣的伺服器，直接在程式碼中實現。

使用 github.com/robfig/cron 這個包，robfig/cron是一個第三方開源的任務排程庫，也就是我們平時說的定時任務，它實現了 cron 規範解析器和任務執行器。

快速開始

安裝

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

匯入

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

Demo

package main

import (
	"fmt"
	"github.com/robfig/cron/v3"
)

func main() {
	// 建立一個預設的cron物件
    c := cron.New()
    
    //新增執行任務
	c.AddFunc("30 * * * *", func() { fmt.Println("Every hour on the half hour") })
	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版本預設支援的格式，沒有Seconds。在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  | * / , - ?

預定義時間表

可以用@yearly、@monthly、@weekly、@weekly、@daily、@hourly來替代cron表示式。分別表示每年，每月、每星期、每天、每小時。

還可以用@every <duartion>來表示間隔時間，即間隔執行一次任務。只要可以被time.ParseDuration()解析即可。

常用的方法介紹

new()

會根據本地時間建立一個新（空白）的計劃任務範例

// 建立一個預設的cron物件
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,
)))

AddJob()

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

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

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))
}