gocron: 一个 Golang 任务调度包
gocron 是一个任务调度包,允许你在预定的时间间隔运行 Go 函数。
快速开始
go get github.com/go-co-op/gocron/v2
package main
import (
"fmt"
"time"
"github.com/go-co-op/gocron/v2"
)
func main() {
// 创建一个调度器
s, err := gocron.NewScheduler()
if err != nil {
// 处理错误
}
// 向调度器添加一个任务
j, err := s.NewJob(
gocron.DurationJob(
10*time.Second,
),
gocron.NewTask(
func(a string, b int) {
// 执行操作
},
"hello",
1,
),
)
if err != nil {
// 处理错误
}
// 每个任务都有一个唯一的 ID
fmt.Println(j.ID())
// 启动调度器
s.Start()
// 阻塞直到准备关闭
select {
case <-time.After(time.Minute):
}
// 完成后,关闭它
err = s.Shutdown()
if err != nil {
// 处理错误
}
}
示例
概念
- 任务:任务封装了一个"任务",由一个 Go 函数和任何函数参数组成。然后任务为调度器提供下一次应该调度运行的时间。
- 调度器:调度器跟踪所有任务,并在任务准备运行时将其发送给执行器。
- 执行器:执行器调用任务的函数,并管理不同任务执行时间要求的复杂性(例如,不应相互覆盖的单例,限制最大运行任务数)。
特性
任务类型
任务可以按不同的间隔运行。
- 持续时间:
任务可以按固定的
time.Duration
运行。 - 随机持续时间:
任务可以在最小和最大值之间的随机
time.Duration
运行。 - Cron: 任务可以使用 crontab 运行。
- 每日: 任务可以每 x 天在特定时间运行。
- 每周: 任务可以每 x 周在一周的特定日期和特定时间运行。
- 每月: 任务可以每 x 个月在月份的特定日期和特定时间运行。
- 一次性: 任务可以在特定时间运行(一次或多次)。
并发限制
可以单独或在整个调度器范围内限制任务。
- 使用单例模式进行每个任务限制: 任务可以限制为单个并发执行,要么重新调度(跳过重叠执行)或排队(等待前一个执行完成)。
- 使用限制模式进行每个调度器限制: 可以使用重新调度(达到限制时跳过)或排队(任务添加到队列等待限制可用)来限制整个调度器的并发执行数。
- 注意: 可以同时启用调度器限制和任务限制。
gocron 的分布式实例
可以运行 gocron 的多个实例。
- 选举器:
可以使用选举器来选择一个 gocron 实例作为主要实例运行,其他实例检查是否需要选举新的领导者。
- 实现:go-co-op 选举器 (没看到你需要的?在 slack 上请求创建一个仓库来贡献它!)
- 锁定器:
可以使用锁定器将每次任务运行锁定到单个 gocron 实例。
锁定器可以在任务或调度器级别定义,如果在任务和调度器都定义了,则任务的锁定器优先。
- 实现:go-co-op 锁定器 (没看到你需要的?在 slack 上请求创建一个仓库来贡献它!)
事件
任务事件可以触发操作。
选项
提供了许多任务和调度器选项。
- 任务选项:
使用
NewJob
创建任务时可以设置任务选项。 - 全局任务选项:
使用
NewScheduler
创建调度器时,可以使用WithGlobalJobOptions
选项设置全局任务选项。 - 调度器选项:
使用
NewScheduler
创建调度器时可以设置调度器选项。
日志记录
可以启用日志。
- Logger: Logger 接口可以使用你想要的日志库来实现。 提供的 NewLogger 使用标准库的 log 包。
指标
可以从每个任务的执行中收集指标。
- 监控器:
可以使用监控器从调度器收集每个任务的指标。
- 实现:go-co-op 监控器 (没看到你需要的?在 slack 上请求创建一个仓库来贡献它!)
测试
gocron 库设置为支持测试。
- mock 包中提供了使用 gomock 的模拟。
- 可以通过将 FakeClock 传递给 WithClock 来模拟时间 - 参见 WithClock 的示例。
支持者
我们感谢对免费和开源软件的支持!
本项目得到以下支持: