Gone框架介绍20 - 用cron表达式配置定时任务

原创已于 2024-05-24 06:41:36 修改 · 344 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#gone #定时任务

于 2024-05-16 14:33:43 首次发布

Gone框架介绍专栏收录该内容

66 篇文章

订阅专栏

gone是可以高效开发Web服务的Golang依赖注入框架
github地址：https://github.com/gone-io/gone
文档地址：https://goner.fun/zh/

文章目录

用cron表达式配置定时任务

用cron表达式配置定时任务

定时任务对于Web项目基本上时标配，可以通过Gone的内置组件来实现定时任务，支持cron表达式。在Web项目中代码一般都是多节点运行，我们使用了redis作为分布式锁来保证任务每次执行只在一个节点上进行，所以需要先准备redis服务，关于redis相关内容请参考：利用redis提供分布式锁和分布式缓存。另外定时任务还可以和框架“配置注入”的特性结合，将cron表达式放到配置文件中，参考通过内置Goners支持配置文件。

将相关Goners埋葬到Cemetery

	//使用 goner.SchedulePriest 函数，将 定时任务 相关的Goner 埋葬到 Cemetery 中
	_ = goner.SchedulePriest(cemetery)

编写定时任务执行的Job函数

type sch struct {
	gone.Flag
}

func (sch *sch) job1() {
	//todo 定时任务逻辑
}

设置定时任务

实现Cron(run schedule.RunFuncOnceAt) ，框架会扫描结构体上的该方法并自动执行，在该方法中设置定时任务。

func (sch *sch) Cron(run schedule.RunFuncOnceAt) {

	//使用 run `RunFuncOnceAt`设置定时任务，
	run(
		"*/5 * * * * *", // cron 表达式，表示每5秒执行一次
		"job1",          //需要设置一个唯一标识，用于 分布式锁加锁
		sch.job1,        // 定时任务逻辑
	)
}

完整的demo代码如下：

package main

import (
	"fmt"
	"github.com/gone-io/gone"
	"github.com/gone-io/gone/goner"
	"github.com/gone-io/gone/goner/schedule"
)

func priest(cemetery gone.Cemetery) error {

	//使用 goner.SchedulePriest 函数，将 定时任务 相关的Goner 埋葬到 Cemetery 中
	_ = goner.SchedulePriest(cemetery)

	cemetery.Bury(&sch{})
	return nil
}

type sch struct {
	gone.Flag
}

func (sch *sch) job1() {
	//todo 定时任务逻辑
	fmt.Println("job1 execute")
}

func (sch *sch) Cron(run schedule.RunFuncOnceAt) {

	//使用 run `RunFuncOnceAt`设置定时任务，
	run(
		"*/5 * * * * *", // cron 表达式，表示每5秒执行一次
		"job1",          //需要设置一个唯一标识，用于 分布式锁加锁
		sch.job1,        // 定时任务逻辑
	)
}

func main() {
	gone.Serve(priest)
}

上面代码会每隔5s打印：job1 execute，是不是很简单？

将定时配置放到配置文件中

将定时配置放到配置文件中，代码上只需要做如下3点修改：

将配置文件支持的相关Goner 埋葬到 Cemetery 中
注入放到配置文件的定时任务配置
使用从配置文件注入的定时配置设置定时任务

修改后的代码如下：

package main

import (
	"fmt"
	"github.com/gone-io/gone"
	"github.com/gone-io/gone/goner"
	"github.com/gone-io/gone/goner/config"
	"github.com/gone-io/gone/goner/schedule"
)

func priest(cemetery gone.Cemetery) error {

	//使用 goner.SchedulePriest 函数，将 定时任务 相关的Goner 埋葬到 Cemetery 中
	_ = goner.SchedulePriest(cemetery)

	//1.将配置文件支持的相关Goner 埋葬到 Cemetery 中
	_ = config.Priest(cemetery)

	cemetery.Bury(&sch{})
	return nil
}

type sch struct {
	gone.Flag

	cron string `gone:"config,cron.job1,default=*/5 * * * * *"` //2. 注入放到配置文件的定时任务配置
}

func (sch *sch) job1() {
	//todo 定时任务逻辑
	fmt.Println("job1 execute")
}

func (sch *sch) Cron(run schedule.RunFuncOnceAt) {

	//使用 run `RunFuncOnceAt`设置定时任务，
	run(
		sch.cron, // 3. 使用从配置文件注入的定时配置
		"job1",   //需要设置一个唯一标识，用于 分布式锁加锁
		sch.job1, // 定时任务逻辑
	)
}

func main() {
	gone.Serve(priest)
}