Golang 定时任务库使用

golang 中第三方定时任务库

一.cron

官网: https://github.com/robfig/cron

安装

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

cron 表达式的基本格式

用过 linux 的应该对 crond 有所了解。linux 中可以通过 crontab -e 来配置定时任务。不过，linux 中的 crond 只能精确到分钟。而我们这里要讨论的 Go 实现的 cron 可以精确到秒，除了这点比较大的区别外，cron 表达式的基本语法是类似的。（如果使用过 Java 中的 Quartz，对 cron 表达式应该比较了解，而且它和这里我们将要讨论的 Go 版 cron 很像，也都精确到秒） cron(计划任务)，顾名思义，按照约定的时间，定时的执行特定的任务（job）。cron 表达式 表达了这种约定。 cron 表达式代表了一个时间集合，使用 6 个空格分隔的字段表示。

字段名	是否必须	允许的值	允许的特定字符
秒(Seconds)	是	0-59	* / , -
分(Minutes)	是	0-59	* / , -
时(Hours)	是	0-23	* / , -
日(Day of month)	是	1-31	* / , – ?
月(Month)	是	1-12 or JAN-DEC	* / , -
星期(Day of week)	否	0-6 or SUM-SAT	* / , – ?

注：

1. 月(Month)和星期(Day of week)字段的值不区分大小写，如：SUN、Sun 和 sun 是一样的。
2. 星期 (Day of week)字段如果没提供，相当于是 *

特殊字符说明

1. 星号(*) 表示 cron 表达式能匹配该字段的所有值。如在第 5 个字段使用星号(month)，表示每个月
2. 斜线(/) 表示增长间隔，如第 1 个字段(minutes) 值是 3-59/15，表示每小时的第 3 分钟开始执行一次，之后每隔 15 分钟执行一次（即 3、18、33、48 这些时间点执行），这里也可以表示为：3/15
3. 逗号(,) 用于枚举值，如第 6 个字段值是 MON,WED,FRI，表示 星期一、三、五 执行
4. 连字号(-) 表示一个范围，如第 3 个字段的值为 9-17 表示 9am 到 5pm 直接每个小时（包括 9 和 17）
5. 问号(?) 只用于日(Day of month)和星期(Day of week)，表示不指定值，可以用于代替 *

cron 举例说明

• 每隔 5 秒执行一次：*/5 * * * *
• 每隔 1 分钟执行一次：0 */1 * * * ?
• 每天 23 点执行一次：0 0 23 * * ?
• 每天凌晨 1 点执行一次：0 0 1 * * ?
• 每月 1 号凌晨 1 点执行一次：0 0 1 1 * ?
• 在 26 分、29 分、33 分执行一次：0 26, 29, 33 * * * ?
• 每天的 0 点、13 点、18 点、21 点都执行一次：0 0 0, 13, 18, 21 * * ?

示例

最简单 crontab 任务, 根据官网手册写法

package main

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

func main() {
	i := 0
	c := cron.New()
	spec := "*/5 * * * * ?" // 每5秒执行一次
	_, err := c.AddFunc(spec, func() {
		i++
		log.Println("cron running:", i)
	})
	if err != nil {
		fmt.Println(err)
		return
	}
	c.Start()

	select {}
}

会报一个错误

expected exactly 5 fields, found 6: [*/5 * * * * ?]

这就尴尬了，可能默认不支持秒级别的任务吧，查询大量资料，把代码修改为一下代码就可以完美运行了

package main

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

func newWithSeconds() *cron.Cron {
	secondParser := cron.NewParser(cron.Second | cron.Minute |
		cron.Hour | cron.Dom | cron.Month | cron.DowOptional | cron.Descriptor)
	return cron.New(cron.WithParser(secondParser), cron.WithChain())
}

func main() {
	i := 0
	c := newWithSeconds()
	spec := "*/3 * * * * ?" // 每3秒执行一次
	_, err := c.AddFunc(spec, func() {
		i++
		log.Println("cron running:", i)
	})
	if err != nil {
		fmt.Println(err)
		return
	}
	c.Start()

	select {}
}

输出结果

2020/02/25 22:26:24 cron running: 1
2020/02/25 22:26:27 cron running: 2
2020/02/25 22:26:30 cron running: 3

多个定时 crontab 任务

package main

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

type TestJob01 struct {
}

func (t TestJob01) Run() {
	fmt.Println("test job 01...")
}

type TestJob02 struct {
}

func (t TestJob02) Run() {
	fmt.Println("test job 01...")
}

func newWithSeconds() *cron.Cron {
	secondParser := cron.NewParser(cron.Second | cron.Minute |
		cron.Hour | cron.Dom | cron.Month | cron.DowOptional | cron.Descriptor)
	return cron.New(cron.WithParser(secondParser), cron.WithChain())
}

func main() {
	i := 0
	c := newWithSeconds()
	// AddFunc
	spec := "*/5 * * * * ?" // 每5秒执行一次
	c.AddFunc(spec, func() {
		i++
		log.Println("cron running:", i)
	})

	// AddJob方法
	spec2 := "*/3 * * * * ?" // 每3秒执行一次
	// 结构体只需要实现Job接口的Run()方法就可以使用AddJob方法创建任务
	c.AddJob(spec2, TestJob01{})
	c.AddJob(spec2, TestJob01{})

	c.Start()

	select {}
}

输出结果

test job 01...
test job 02...
2020/02/25 22:35:10 cron running: 1
test job 02...
test job 01...
test job 01...
test job 02...
2020/02/25 22:35:15 cron running: 2

二.gocron

官网: https://github.com/jasonlvhit/gocron

安装

$ go get -u github.com/jasonlvhit/gocron

使用

每隔 1 秒执行一个任务，每隔 4 秒执行另一个任务：

package main

import (
	"fmt"
	"github.com/jasonlvhit/gocron"
	"time"
)

func task() {
	fmt.Println("I am runnning task.", time.Now())
}

func superWang() {
	fmt.Println("I am runnning superWang.", time.Now())
}

func test(s *gocron.Scheduler, sc chan bool) {
	time.Sleep(8 * time.Second)
	s.Remove(task) // 移除task任务
	time.Sleep(6 * time.Second)
	s.Clear() // 清除所有任务
	fmt.Println("所有任务已经移除")
	close(sc) // 关闭阻塞通道
}

func main() {
	s := gocron.NewScheduler()
	s.Every(1).Seconds().Do(task)      // 每1秒执行一次
	s.Every(4).Seconds().Do(superWang) // 每4秒执行一次

	sc := s.Start() // 保持堵塞

	go test(s, sc) // 测试任务

	<-sc
}

输出结果

I am runnning task. 2020-02-25 22:47:14.17147 +0800 CST m=+1.005913427
I am runnning task. 2020-02-25 22:47:15.166802 +0800 CST m=+2.001240185
I am runnning task. 2020-02-25 22:47:16.169687 +0800 CST m=+3.004120087
I am runnning superWang. 2020-02-25 22:47:17.17018 +0800 CST m=+4.004608274
I am runnning task. 2020-02-25 22:47:17.170379 +0800 CST m=+4.004806812
I am runnning task. 2020-02-25 22:47:18.166961 +0800 CST m=+5.001384129
I am runnning task. 2020-02-25 22:47:19.170195 +0800 CST m=+6.004612901
I am runnning task. 2020-02-25 22:47:20.166981 +0800 CST m=+7.001393545
I am runnning task. 2020-02-25 22:47:21.169624 +0800 CST m=+8.004031759
I am runnning superWang. 2020-02-25 22:47:21.169664 +0800 CST m=+8.004071487
I am runnning superWang. 2020-02-25 22:47:22.170581 +0800 CST m=+9.004983584
I am runnning superWang. 2020-02-25 22:47:26.17089 +0800 CST m=+13.005272477
所有任务已经移除