gocron

Gocron：Golang工作计划软件包

Gocron是一个工作调度软件包，可让您以预定的间隔运行GO函数。

如果您想聊天，可以在Slack上找到我们

快速开始

 go get github.com/go-co-op/gocron/v2

 package main

import (
	"fmt"
	"time"

	"github.com/go-co-op/gocron/v2"
)

func main () {
	// create a scheduler
	s , err := gocron . NewScheduler ()
	if err != nil {
		// handle error
	}

	// add a job to the scheduler
	j , err := s . NewJob (
		gocron . DurationJob (
			10 * time . Second ,
		),
		gocron . NewTask (
			func ( a string , b int ) {
				// do things
			},
			"hello" ,
			1 ,
		),
	)
	if err != nil {
		// handle error
	}
	// each job has a unique id
	fmt . Println ( j . ID ())

	// start the scheduler
	s . Start ()

	// block until you are ready to shut down
	select {
	case <- time . After ( time . Minute ):
	}

	// when you're done, shut it down
	err = s . Shutdown ()
	if err != nil {
		// handle error
	}
}

例子

• Go Doc示例
• 示例目录

概念

• 作业：作业封装了一个“任务”，该任务由GO函数和任何功能参数组成。然后，该作业为调度程序提供了接下来应安排工作的时间。
• 调度程序：调度程序可以跟踪所有作业，并在准备运行时将每个作业发送给执行程序。
• 执行人：执行人调用该作业的任务并管理不同作业执行正时要求的复杂性（例如，不应互相覆盖的单例，限制运行的最大作业数）

特征

工作类型

作业可以以不同的间隔运行。

• 持续时间：作业可以在固定time.Duration运行。
• 随机持续时间：可以在随机time.Duration进行作业。
• 克朗：可以使用crontab运行工作。
• 每日：可以在特定时间进行每X天进行一次工作。
• 每周：在一周中和特定时间的特定日子里，可以每X周每周运行工作。
• 月度：可以在一个月的特定日子和特定时间在每X个月运行一次。
• 一次：可以在特定时间（一次或多次）运行作业。

并发限制

作业可以单独或整个调度程序受到限制。

• 通过Singleton模式限制工作：作业可以限于单个并发执行，该执行要么重新安排（跳过重叠执行）或队列（等待先前的执行完成）。
• 每个调度程序以限制模式限制：作业可以使用重新安排（在满足限制时跳过）或队列（将作业添加到队列中以等待限制可用）。
• 注意：调度程序限制和作业限制都可以启用。

Gocron的分布式实例

可以运行多个Gocron实例。

• 选民：选举人可用于选举戈克朗的单个实例，以作为主要实例，其他实例检查是否需要当选新领导者。
  • 实施：GO-CO-OP选举人（没有看到您需要什么？Slack上的请求以创建回购以贡献它！）
• 储物柜：储物柜可用于将作业的每个运行锁定到Gocron的一个实例。储物柜可以在工作或调度程序中，如果在作业和调度程序中都定义，则作业储物柜将优先。
  • 实现：GO-CO-OP储物柜（没有看到您需要什么？Slack上的请求以创建回购以贡献它！）

事件

工作事件可以触发动作。

• 听众：可以添加到工作，活动听众或调度程序中的所有作业，以聆听工作事件和触发操作。

选项

提供许多工作和调度程序选项。

• 作业选项：使用NewJob创建作业时可以设置作业选项。
• 全局作业选项：使用NewScheduler和WithGlobalJobOptions选项创建调度程序时，可以设置全局作业选项。
• 调度程序选项：使用NewScheduler创建调度程序时，可以设置调度程序选项。

记录

可以启用日志。

• Logger：可以使用所需的记录库实现记录器接口。提供的NewLogger使用标准库的日志软件包。

指标

可以从每个作业的执行中收集指标。

• 监视器：
• MonitorStatus （包括作业的状态和错误（如果有），可以使用监视器从调度程序中为每个作业收集指标。
  • 实现：GO-CO-OP监视器（没有看到您需要什么？Slack上的请求以创建回购以贡献它！）

测试

Gocron库设置为启用测试。

• 使用Gomock在模拟软件包中提供了模拟。
• 可以通过将fakeclock传递给clock来嘲笑时间 - 请参阅withClock上的示例。

支持者

我们感谢免费和开源软件的支持！

该项目得到了支持：

喷气桥

哨兵

星历史