1 安装依赖
go get github.com/robfig/cron/v3@v3.0.0
2 定时任务HelloWorld
package main
import (
"fmt"
"github.com/robfig/cron/v3"
"time"
)
func main() {
// 新建一个定时任务对象
// 根据cron表达式进行时间调度,cron可以精确到秒,大部分表达式格式也是从秒开始。
//crontab := cron.New() 默认从分开始进行时间调度
crontab := cron.New(cron.WithSeconds()) //精确到秒
//定义定时器调用的任务函数
task := func() {
fmt.Println("hello world", time.Now())
}
//定时任务
spec := "*/5 * * * * ?" //cron表达式,每五秒一次
// 添加定时任务,
crontab.AddFunc(spec, task)
// 启动定时器
crontab.Start()
// 定时任务是另起协程执行的,这里使用 select 简答阻塞.实际开发中需要
// 根据实际情况进行控制
select {} //阻塞主线程停止
}
------------------------------------------输出结果----------------------------------
hello world 2020-03-18 11:13:00.0241639 +0800 CST m=+3.113746301
hello world 2020-03-18 11:13:05.0007375 +0800 CST m=+8.090319901
hello world 2020-03-18 11:13:10.0004232 +0800 CST m=+13.090005601
hello world 2020-03-18 11:13:15.0003857 +0800 CST m=+18.089968101
hello world 2020-03-18 11:13:20.0003788 +0800 CST m=+23.089961201
3 Cron 表达式
cron
表达式是一个好东西,这个东西不仅Java
的quartZ
能用到,Go
语言和Java
中都是可以精确到秒的,但是Linux
中不行。cron
表达式代表一个时间的集合,使用6个空格分隔的字段表示:
字段名 | 是否必须 | 允许的值 | 允许的特定字符 |
---|---|---|---|
秒(Seconds) | 是 | 0-59 | * / , - |
分(Minute) | 是 | 0-59 | * / , - |
时(Hours) | 是 | 0-23 | * / , - |
日(Day of month) | 是 | 1-31 | * / , - ? |
月(Month) | 是 | 1-12 或 JAN-DEC | * / , - |
星期(Day of week) | 否 | 0-6 或 SUM-SAT | * / , - ? |
3.1 Corn表达式说明
- 月(Month)和星期(Day of week)字段的值不区分大小写,如:SUN、Sun 和 sun 是一样的。
- 星期(Day of week)字段如果没提供,相当于是 *
3.2 Corn表达式示例说明
如果我们使用
crontab := cron.New(cron.WithSeconds())
,
比如我们传递了一个字符串是:"* * * * * *"
在crontab.AddFunc()
的第一个参数,这六个*
是指什么呢?
如果是用crontab := cron.New()
则只需要五个*
,如* * * * *
┌─────────────second 范围 (0 - 60)
│ ┌───────────── min (0 - 59)
│ │ ┌────────────── hour (0 - 23)
│ │ │ ┌─────────────── day of month (1 - 31)
│ │ │ │ ┌──────────────── month (1 - 12)
│ │ │ │ │ ┌───────────────── day of week (0 - 6) (0 to 6 are Sunday to
│ │ │ │ │ │ Saturday)
│ │ │ │ │ │
│ │ │ │ │ │
* * * * * *
3.3 cron特定字符说明
符号 | 说明 |
---|---|
(*) | 表示 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),表示不指定值,可以用于代替 * |
3.4 常用cron举例
每隔5秒执行一次:*/5 * * * * ?
每隔1分钟执行一次:0 */1 * * * ?
每天23点执行一次:0 0 23 * * ?
每天凌晨1点执行一次:0 0 1 * * ?
每月1号凌晨1点执行一次:0 0 1 1 * ?
每周一和周三晚上22:30: 00 30 22 * * 1,3
在26分、29分、33分执行一次:0 26,29,33 * * * ?
每天的0点、13点、18点、21点都执行一次:0 0 0,13,18,21 * * ?
每年三月的星期四的下午14:10和14:40: 00 10,40 14 ? 3 4
3.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 * * * * |
@every <duration> |
every duration |
c := cron.New()
c.AddFunc("@every 1h30m", func() { fmt.Println("Every hour thirty") })
4 多个定时任务
package main
import (
"fmt"
"github.com/robfig/cron/v3"
"time"
)
type TestTask struct {
Name string
}
func (t *TestTask) Run() {
fmt.Println("TestTask", t.Name)
}
type Test2Task struct {
Name string
}
func (t *Test2Task) Run() {
fmt.Println("Test2Task", t.Name)
}
func main() {
// 新建一个定时任务对象
// 根据cron表达式进行时间调度,cron可以精确到秒,大部分表达式格式也是从秒开始。
//crontab := cron.New() 默认从分开始进行时间调度
crontab := cron.New(cron.WithSeconds()) //精确到秒
//定义定时器调用的任务函数
//定时任务
spec := "*/5 * * * * ?" //cron表达式,每五秒一次
//定义定时器调用的任务函数
task := func() {
fmt.Println("hello world", time.Now())
}
// 添加定时任务
crontab.AddFunc(spec, task)
// 添加多个定时器
crontab.AddJob(spec, &TestTask{Name: "tom"})
crontab.AddJob(spec, &Test2Task{Name: "jeck"})
// 启动定时器
crontab.Start()
//关闭着计划任务, 但是不能关闭已经在执行中的任务.
defer crontab.Stop()
// 定时任务是另起协程执行的,这里使用 select 简答阻塞.实际开发中需要
// 根据实际情况进行控制
select {} //阻塞主线程停止
}
--------------------------------------输出结果----------------------------------------
TestTask tom
Test2Task jeck
hello world 2020-03-18 13:22:10.0245997 +0800 CST m=+2.761856801
TestTask tom
Test2Task jeck
hello world 2020-03-18 13:22:15.0008245 +0800 CST m=+7.738081601
……………………………………
实际应用
func init() {
task := cron.New(cron.WithSeconds())
if _, err := task.AddFunc("*/1 * * * * *", func() {
service := TaskGyReturnOrder{}
service.GetReturnOrderResult(1, 10)
//fmt.Print("6")
}); err != nil {
//time.Sleep(time.Second * 60)
} else {
task.Start()
}
}