Project Icon

gocron

Go语言的多功能任务调度包

gocron是一个功能全面的Go语言任务调度包,支持多种任务类型如定时、随机间隔和cron表达式等。它提供并发控制、分布式支持、事件监听和丰富配置选项。gocron还包含日志记录、性能监控和测试工具,适用于构建各类定时任务系统。

gocron: 一个 Golang 任务调度包

CI 状态 Go 报告卡 Go 文档

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() {
	// 创建一个调度器
	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 库设置为支持测试。

支持者

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

本项目得到以下支持:

Star 历史

Star 历史图表

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号