Go定时任务库Cron
jiangxiaoju 人气:0快速入门
安装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 {} }
加载全部内容