Go语言封装Cron定时任务

Go语言封装Cron定时任务

  • 介绍
  • 目标
  • 项目背景
  • 代码分析
    • 代码实现
    • 主要功能
  • Cron表达式解析
    • 例子
  • 使用示例
  • 总结

介绍

在现代应用中,定时任务是非常常见的需求,无论是用于定时清理数据、定时发送邮件,还是定时执行系统维护任务。Go语言作为一门现代编程语言,提供了多种方法来实现定时任务。本文将重点介绍如何在Go中封装一个Cron定时任务管理器,帮助开发者高效管理定时任务。

目标

我们将通过使用 github.com/robfig/cron/v3 库来实现一个简洁、灵活的定时任务调度器。该库支持基于 Cron 表达式的任务调度,我们将基于该库封装出一个简单的 API,供开发者在实际项目中使用。

项目背景

Cron 表达式是一种用来表示时间计划的格式,它通常由 5 或 6 个字段组成,表示一个特定的时间点或时间间隔。Go中的 robfig/cron 库提供了非常便利的接口来处理这些表达式,并能够定期执行任务。

我们的目标是封装一个 Crontab 结构体,它将管理所有的定时任务,支持任务的添加、删除、查询以及启动和停止功能。

代码分析

下面是一个简单的 Cron 定时任务调度器的封装代码。它基于 robfig/cron 库并扩展了一个 Crontab 结构体,提供了一些常用的操作方法。

代码实现

package crontabimport ("github.com/pkg/errors"cron "github.com/robfig/cron/v3""sync"
)// Crontab crontab struct
type Crontab struct {inner *cron.Cronids   map[string]cron.EntryIDmutex *sync.RWMutex
}// NewCrontab new crontab
func NewCrontab() *Crontab {return &Crontab{inner: cron.New(cron.WithSeconds()), // 支持秒级别的Cron表达式ids:   make(map[string]cron.EntryID),mutex: new(sync.RWMutex),}
}// IDs 获取所有有效的Cron任务ID
func (c *Crontab) IDs() []string {c.mutex.RLock()defer c.mutex.RUnlock()validIDs := make([]string, 0, len(c.ids))invalidIDs := make([]string, 0)for sid, eid := range c.ids {if e := c.inner.Entry(eid); e.ID != eid {invalidIDs = append(invalidIDs, sid)continue}validIDs = append(validIDs, sid)}// 清理无效的任务IDfor _, id := range invalidIDs {delete(c.ids, id)}return validIDs
}// Start 启动定时任务调度器
func (c *Crontab) Start() {c.inner.Start()
}// Stop 停止定时任务调度器
func (c *Crontab) Stop() {c.inner.Stop()
}// DelByID 根据ID删除定时任务
func (c *Crontab) DelByID(id string) error {c.mutex.Lock()defer c.mutex.Unlock()eid, ok := c.ids[id]if !ok {return errors.Errorf("crontab id not exists!")}c.inner.Remove(eid)delete(c.ids, id)return nil
}// AddByID 根据ID添加定时任务
// spec 是Cron表达式,cmd 是执行的任务
func (c *Crontab) AddByID(id, spec string, cmd cron.Job) error {c.mutex.Lock()defer c.mutex.Unlock()if _, ok := c.ids[id]; ok {return errors.Errorf("crontab id exists!")}eid, err := c.inner.AddJob(spec, cmd)if err != nil {return err}c.ids[id] = eidreturn nil
}// AddByFunc 根据ID添加函数作为定时任务
func (c *Crontab) AddByFunc(id, spec string, f func()) error {c.mutex.Lock()defer c.mutex.Unlock()if _, ok := c.ids[id]; ok {return errors.Errorf("crontab id exists!")}eid, err := c.inner.AddFunc(spec, f)if err != nil {return err}c.ids[id] = eidreturn nil
}// IsExists 判断某个任务ID是否已存在
func (c *Crontab) IsExists(jid string) bool {c.mutex.RLock()defer c.mutex.RUnlock()_, exist := c.ids[jid]return exist
}

主要功能

  • NewCrontab(): 初始化一个新的 Crontab 实例,内部使用 cron.New() 来创建一个 Cron 调度器,支持秒级别的 Cron 表达式。

  • IDs(): 获取当前所有有效的定时任务ID。会清理掉无效的任务ID。

  • Start(): 启动 Cron 调度器,开始执行所有的定时任务。

  • Stop(): 停止 Cron 调度器,暂停定时任务的执行。

  • DelByID(id): 根据任务ID删除定时任务。

  • AddByID(id, spec, cmd): 根据 Cron 表达式添加一个新的定时任务。任务ID必须唯一。

  • AddByFunc(id, spec, f): 将一个函数作为定时任务来添加,使用 Cron 表达式来指定执行频率。

  • IsExists(jid): 判断某个定时任务ID是否存在。

Cron表达式解析

Cron 表达式是定时任务调度中常见的表示方式,它由五个或六个字段组成,每个字段代表一个时间单位。标准的 Cron 表达式格式如下:

* * * * * *
│ │ │ │ │ │
│ │ │ │ │ └─ 星期几 (0 - 7) (0或7代表星期天)
│ │ │ │ └──── 月份 (1 - 12)
│ │ │ └────── 日 (1 - 31)
│ │ └──────── 小时 (0 - 23)
│ └────────── 分钟 (0 - 59)
└──────────── 秒 (0 - 59)

例子

* * * * * *:每秒执行一次任务
0 * * * * *:每分钟的第0秒执行一次任务
0 0 * * * *:每天午夜执行一次任务
0 0 1 * * *:每月的第一天执行一次任务

使用示例

以下是如何使用封装好的 Crontab 类型来管理定时任务的示例:

package mainimport ("fmt""github.com/robfig/cron/v3""time""your_project/crontab"
)func main() {// 创建一个新的 Crontab 实例c := crontab.NewCrontab()// 定义一个定时任务task := func() {fmt.Println("Task executed at", time.Now())}// 添加定时任务err := c.AddByFunc("task1", "*/5 * * * * *", task) // 每5秒执行一次if err != nil {fmt.Println("Error adding task:", err)return}// 启动任务调度器c.Start()// 等待一段时间后停止time.Sleep(20 * time.Second)c.Stop()// 删除任务err = c.DelByID("task1")if err != nil {fmt.Println("Error deleting task:", err)}
}

总结

通过使用 robfig/cron 库并封装成一个简单易用的 Crontab 类型,我们可以非常方便地在 Go 项目中管理定时任务。Cron 表达式为我们提供了灵活的时间配置,帮助开发者应对复杂的定时任务调度需求。

在实际应用中,我们可以根据需要扩展 Crontab 类型,支持更多功能,如任务状态监控、任务重试等,进一步提高定时任务管理的效率。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/493963.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

powershell美化

powershell美化 写在前面 除了安装命令,其他都是测试命令,后续再写进配置文件 安装主题控件 安装主题oh-my-posh,powershell中执行 winget install JanDeDobbeleer.OhMyPosh -s winget oh-my-posh init pwsh | Invoke-Expression # 查看…

3. Kafka入门—安装与基本命令

Kafka基础操作 一. 章节简介二. kafka简介三. Kafka安装1. 准备工作2. Zookeeper安装2.1 配置文件2.2 启动相关命令3. Kafka安装3.1 配置文件3.2 启动相关命令-------------------------------------------------------------------------------------------------------------…

Element@2.15.14-tree checkStrictly 状态实现父项联动子项,实现节点自定义编辑、新增、删除功能

背景:现在有一个新需求,需要借助树结构来实现词库的分类管理,树的节点是不同的分类,不同的分类可以有自己的词库,所以父子节点是互不影响的;同样为了选择的方便性,提出了新需求,选择…

基于Spring Boot的房屋租赁管理系统

一、系统背景与目的 随着城市化进程的加快和人口流动性的增强,租房市场需求急剧增长。传统的租房方式依赖于中介平台或线下交易,存在房源信息更新不及时、虚假信息泛滥、交易流程繁琐、沟通渠道不畅等问题。基于Spring Boot的房屋租赁管理系统旨在通过构…

【NLP 16、实践 ③ 找出特定字符在字符串中的位置】

看着父亲苍老的白发和渐渐老态的面容 希望时间再慢一些 —— 24.12.19 一、定义模型 1.初始化模型 ① 初始化父类 super(TorchModel, self).__init__(): 调用父类 nn.Module 的初始化方法,确保模型能够正确初始化。 ② 创建嵌入层 self.embedding n…

jvm栈帧中的动态链接

“-Xss”这一名称并没有一个特定的“为什么”来解释其命名,它更多是JVM(Java虚拟机)配置参数中的一个约定俗成的标识。在JVM中,有多个配置参数用于调整和优化Java应用程序的性能,这些参数通常以一个短横线“-”开头&am…

使用Vscode+EIDE+Jlink开发STM32环境配置教程

环境准备 电脑,最好有梯子。一块开发板。烧录调试工具。比如Jlink。 参考文章 超级馒头神的教程 安装环境 安装Vscode,这里不多说,直接百度下载安装即可。 安装如下插件。 然后重启vscode,就可以看到左侧工具栏有了EIDE图标…

信创技术栈发展现状与展望:机遇与挑战并存

一、引言 在信息技术应用创新(信创)战略稳步推进的大背景下,我国信创技术栈已然在诸多关键层面收获了亮眼成果,不过也无可避免地遭遇了一系列亟待攻克的挑战。信创产业作为我国达成信息技术自主可控这一目标的关键一招&#xff0c…

微信小程序开发入门

实现滚动 需要设置高度和边框 轮播图 差值表达式( {{表达式的值}} ),info数据要写到js文件的data数据中 小程序中常用的事件

cad c# 二次开发 ——动态加载dll 文件制作(loada netloadx)

原理:制作一个dll工具,此dll工具可动态加载调试代码所生成的dll。 using System.Collections.Generic; using System.IO; using System.Reflection; using System.Windows.Forms; using Autodesk.AutoCAD.ApplicationServices.Core; using Autodesk.Aut…

基于AT89C52单片机的6位电子密码锁设计

点击链接获取Keil源码与Project Backups仿真图: https://download.csdn.net/download/qq_64505944/90166684?spm1001.2014.3001.5503 14 部分参考设计如下: 目 录 摘要 1 abstract 2 1 绪论 3 1.1 课题背景 3 1.2 课题的目的和意义 3 1.3 电子密码…

文件解析漏洞中间件(iis和Apache)

IIS解析漏洞 IIS6.X #环境 Windows Server 2003 在iis6.x中&#xff0c;.asp文件夹中的任意文件都会被当做asp文件去执行 在默认网站里创建一个a.asp文件夹并创建一个1.jpg写进我们的asp代码 <%now()%> #asp一句话 <%eval request("h")%> 单独创建一…

ASP.NET|日常开发中数据集合详解

ASP.NET&#xff5c;日常开发中数据集合详解 前言一、数组&#xff08;Array&#xff09;1.1 定义和基本概念1.2 数组的操作 二、列表&#xff08;List<T>&#xff09;2.1 特点和优势2.2 常用操作 三、字典&#xff08;Dictionary<K, V>&#xff09;3.1 概念和用途…

OpenCV putText增加中文支持

OpenCV 默认并不支持中文字符显示&#xff0c;需要增加 freetype 支持&#xff0c;也需正确设置中文字体才能正常显示中文。 OpenCV 2.x 版本没有该模块&#xff0c;而 OpenCV 3.x 及以上版本才正式引入了 freetype 模块 &#xff0c;可检查并更新到较新且包含该模块的版本。 O…

设计模式期末复习

一、设计模式的概念以及分类 二、设计模式的主题和意图 设计模式的主题是关于软件设计中反复出现的问题以及相应的解决方案。这些主题是基于长期实践经验的总结&#xff0c;旨在提供一套可复用的设计思路和框架&#xff0c;以应对软件开发中的复杂性和变化性。 三、面向对象程…

Windows脚本清理C盘缓存

方法一&#xff1a;使用power文件.ps1的文件 脚本功能 清理临时文件夹&#xff1a; 当前用户的临时文件夹&#xff08;%Temp%&#xff09;。系统临时文件夹&#xff08;C:\Windows\Temp&#xff09;。 清理 Windows 更新缓存&#xff1a; 删除 Windows 更新下载缓存&#xff0…

随手记:小程序兼容后台的wangEditor富文本配置链接

场景&#xff1a; 在后台配置wangEditor富文本&#xff0c;可以文字配置链接&#xff0c;图片配置链接&#xff0c;产生的json格式为&#xff1a; 例子&#xff1a; <h1><a href"https://uniapp.dcloud.net.cn/" target"_blank"><span sty…

OpenHarmony-6.IPC/RPC组件

IPC/RPC组件机制 1.基本概念 IPC&#xff1a;设备内的进程间通信&#xff08;Inter-Process Communication&#xff09;。 RPC&#xff1a;设备间的进程间通信&#xff08;Remote Procedure Call&#xff09;。 IPC/RPC用于实现跨进程通信&#xff0c;不同的是前者使用Binder驱…

米思齐图形化编程之ESP32开发指导

在当今充满创意与探索的科技领域&#xff0c;米思齐图形化编程为广大爱好者开启了一扇通往智能硬件控制的便捷之门&#xff0c;尤其是当它与强大的 ESP32相结合时&#xff0c;更是碰撞出无限可能的火花。ESP32作为一款高性能、多功能的微控制器&#xff0c;拥有丰富的外设接口与…

tslib(触摸屏输入设备的轻量级库)的学习、编译及测试记录

目录 tslib的简介tslib的源码和make及make install后得到的文件下载tslib的主要功能tslib的工作原理tslib的核心组成部分tslib的框架和核心函数分析tslib的框架tslib的核心函数ts_setup()的分析(对如何获取设备名和数据处理流程的分析)函数ts_setup()自身的主要代码ts_setup()对…