news 2026/4/27 9:41:53

go语言定时任务工具类

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
go语言定时任务工具类

go语言定时任务工具类,支持crontab(精确到秒)和 timer 两种模式。
本文介绍了一个基于Go语言的定时任务工具类,支持crontab(精确到秒)和timer两种模式。工具类使用github.com/robfig/cron/v3包实现,主要功能包括:

提供NamedCronJobTask接口定义定时任务,支持通过cron表达式或时间间隔两种调度方式
实现了任务添加(AddTask)、更新(UpdateTask)等功能
内部使用map管理任务,支持同名任务替换
对cron和ticker两种调度方式进行了封装,自动处理panic恢复
提供了任务日志记录功能

该工具类设计灵活,可以方便地集成到各种需要定时任务调度的Go应用中。

引入包:github.com/robfig/cron/v3我的版本 v3.0.1

直接见代码:
1、cron_job_conf.go

packagejobimport("xxx/utils"// 自定义工具包,包内容见下"fmt""log""sync""time""github.com/google/uuid""github.com/robfig/cron/v3")// 定时任务接口typeNamedCronJobTaskinterface{// 任务名称Name()string// returns a cron expression and/or a time interval.// Scheduling priority:// - If cronSpec is non-empty, it is used (interval is ignored).// - Else, if interval > 0, a ticker-based scheduler runs every 'interval'.// - Otherwise, the task is invalid.// Example:// return "*/5 * * * * *", 0 // cron every 5 seconds// return "", 2*time.Hour // ticker every 2 hours// return "0 0 * * *", 10*time.Minute // cron used (every day at 00:00)SpecOrInterval()(cronSpecstring,interval time.Duration)// 执行方法Execute()}// taskType 任务类型typetaskTypeintconst(taskTypeCron taskType=iotataskTypeTicker)// cronTask 内部任务元数据typecronTaskstruct{specstring// cron 表达式 或 "[TICKER:...]" 占位符(仅用于日志)fnfunc()id cron.EntryID// cron 用ticker*time.Ticker// ticker 用stopChanchanstruct{}// 用于安全停止 ticker goroutinetaskType taskType}var(c*cron.Cron cronTaskMap=make(map[string]*cronTask)cronTaskMapMutex=&sync.RWMutex{})// init 初始化 cron 调度器(带秒支持)funcinit(){c=cron.New(cron.WithSeconds())c.Start()log.Println("cron scheduler started")}// AddTask 添加定时任务。如果之前已存在同名任务则会被覆盖。funcAddTask(named NamedCronJobTask)(string,error){ifnamed==nil{return"",fmt.Errorf("namedCronJobTask is nil")}name:=named.Name()ifname==""{name="anonymous:"+uuid.New().String()}returnAddTaskWithName(name,named.SpecOrInterval,named.Execute)}// AddTaskWithName 添加命名任务,如果之前已存在同名任务则会被覆盖。// specOrInterval 返回 (cronSpec, interval),规则:// - 若 cronSpec != "" → 使用 cron(忽略 interval)// - 否则若 interval > 0 → 使用 ticker// - 否则返回错误funcAddTaskWithName(namestring,specOrIntervalfunc()(specstring,interval time.Duration),fnfunc(),)(string,error){iffn==nil{returnname,fmt.Errorf("task function cannot be nil")}ifspecOrInterval==nil{returnname,fmt.Errorf("specOrInterval function cannot be nil")}cronSpec,interval:=specOrInterval()ifname==""{name="anonymous:"+uuid.New().String()}ifcronSpec==""&&interval<=0{returnname,fmt.Errorf("invalid scheduling policy for task %q: must return non-empty cronSpec or interval > 0",name,)}wrappedFn:=func(){deferutils.RecoverPanic()fn()}cronTaskMapMutex.Lock()defercronTaskMapMutex.Unlock()// 替换已存在的同名任务ifold,ok:=cronTaskMap[name];ok{removeTask(old)log.Printf("Replaced existing task: %s",name)}ifcronSpec!=""{// 使用 cronentryID,err:=c.AddFunc(cronSpec,wrappedFn)iferr!=nil{returnname,fmt.Errorf("invalid cron spec %q: %w",cronSpec,err)}cronTaskMap[name]=&cronTask{spec:cronSpec,fn:fn,id:entryID,taskType:taskTypeCron,}log.Printf("Added cron task: %s (spec: %s, ID: %d)",name,cronSpec,int64(entryID))}elseifinterval>0{// 使用 tickerstopChan:=make(chanstruct{})ticker:=time.NewTicker(interval)gofunc(){deferfunc(){ifr:=recover();r!=nil{log.Printf("Recovered panic in ticker task %s: %v",name,r)}ticker.Stop()}()for{select{case<-ticker.C:wrappedFn()case<-stopChan:return}}}()cronTaskMap[name]=&cronTask{spec:fmt.Sprintf("[TICKER:%v]",interval),fn:fn,ticker:ticker,stopChan:stopChan,taskType:taskTypeTicker,}log.Printf("Added ticker task: %s (every %v)",name,interval)}returnname,nil}// AddTaskWithName 添加匿名任务,通过函数动态获取调度策略。// specOrInterval 返回 (cronSpec, interval),规则:// - 若 cronSpec != "" → 使用 cron(忽略 interval)// - 否则若 interval > 0 → 使用 ticker// - 否则返回错误funcAddTaskWithoutName(specOrIntervalfunc()(specstring,interval time.Duration),fnfunc())(string,error){name:="anonymous:"+uuid.New().String()returnAddTaskWithName(name,specOrInterval,fn)}// UpdateTask 更新任务调度策略,支持在 cron 和 ticker 之间切换。// newSpecOrInterval 应返回新的 (cronSpec, interval)。// 规则:// - 若 cronSpec != "" → 使用 cron(忽略 interval)// - 否则若 interval > 0 → 使用 ticker// - 否则返回错误//// 要求任务必须已存在。funcUpdateTask(namestring,newSpecOrIntervalfunc()(newSpecstring,newInterval time.Duration))error{ifname==""{returnfmt.Errorf("task name cannot be empty")}ifnewSpecOrInterval==nil{returnfmt.Errorf("newSpecOrInterval function cannot be nil")}newSpec,newInterval:=newSpecOrInterval()ifnewSpec==""&&newInterval<=0{returnfmt.Errorf("newSpecOrInterval returned invalid spec (%q) and interval (%v): at least one must be valid",newSpec,newInterval)}cronTaskMapMutex.Lock()defercronTaskMapMutex.Unlock()oldTask,exists:=cronTaskMap[name]if!exists{returnfmt.Errorf("task not found: %s",name)}ifoldTask.fn==nil{returnfmt.Errorf("task function is nil for %s",name)}// 安全停止旧任务removeTask(oldTask)ifnewSpec!=""{// 切换为 cronwrappedFn:=func(){deferutils.RecoverPanic()oldTask.fn()}entryID,e:=c.AddFunc(newSpec,wrappedFn)ife!=nil{delete(cronTaskMap,name)// 防止残留无效条目returnfmt.Errorf("failed to parse new cron spec %q: %w",newSpec,e)}cronTaskMap[name]=&cronTask{spec:newSpec,fn:oldTask.fn,id:entryID,taskType:taskTypeCron,}log.Printf("Updated task %s to cron (spec: %s)",name,newSpec)}elseifnewInterval>0{// 切换为 tickerstopChan:=make(chanstruct{})ticker:=time.NewTicker(newInterval)gofunc(){deferfunc(){ifr:=recover();r!=nil{log.Printf("Recovered panic in updated ticker task %s: %v",name,r)}ticker.Stop()}()for{select{case<-ticker.C:func(){deferutils.RecoverPanic()oldTask.fn()}()case<-stopChan:return}}}()cronTaskMap[name]=&cronTask{spec:fmt.Sprintf("[TICKER:%v]",newInterval),fn:oldTask.fn,ticker:ticker,stopChan:stopChan,taskType:taskTypeTicker,}log.Printf("Updated task %s to ticker (interval: %v)",name,newInterval)}returnnil}// RemoveTaskByName 删除任务(幂等:任务不存在也返回 true)funcRemoveTaskByName(namestring)bool{ifname==""{returntrue}cronTaskMapMutex.Lock()defercronTaskMapMutex.Unlock()iftask,ok:=cronTaskMap[name];ok{removeTask(task)delete(cronTaskMap,name)log.Printf("Removed task: %s",name)}returntrue}// Exists 检查任务是否存在funcExists(namestring)bool{cronTaskMapMutex.RLock()defercronTaskMapMutex.RUnlock()_,ok:=cronTaskMap[name]returnok}// GetAllTaskNames 获取所有任务名funcGetAllTaskNames()[]string{cronTaskMapMutex.RLock()defercronTaskMapMutex.RUnlock()names:=make([]string,0,len(cronTaskMap))forname:=rangecronTaskMap{names=append(names,name)}returnnames}// Stop 停止整个调度器funcStop(){log.Println("Stopping cron scheduler...")c.Stop()// 停止 cron 调度器(不再触发新任务)cronTaskMapMutex.Lock()defercronTaskMapMutex.Unlock()// 复用 removeTask 清理所有任务资源for_,task:=rangecronTaskMap{removeTask(task)}log.Println("All scheduled tasks stopped")}// (内部使用)安全移除一个任务funcremoveTask(task*cronTask){switchtask.taskType{casetaskTypeCron:c.Remove(task.id)casetaskTypeTicker:iftask.ticker!=nil{task.ticker.Stop()}iftask.stopChan!=nil{close(task.stopChan)// 唯一关闭点task.stopChan=nil// 防止重复 close(虽已加锁,但更安全)}}}

2、panic_tookit.go

packageutilsimport("log""runtime/debug")// 捕获 PanicfuncRecoverPanic(){ifr:=recover();r!=nil{log.Printf("panic recovered: %v\n%s",r,debug.Stack())// 后期这里还可以 SendMetrics、SendAlert、Sentry.Capture等指标}}// 在捕获 Panic 下运行某个方法funcRunWithRecoverPanic[T any](data T,fnfunc(T)){deferRecoverPanic()// 增加一层防火墙fn(data)}// 在捕获 Panic 下运行某个方法(无入参)funcRunWithRecoverPanic2(fnfunc()){deferRecoverPanic()// 增加一层防火墙fn()}// 在捕获 Panic 下 异步运行(goroutine) 某个方法funcAsyncRunWithRecoverPanic[T any](data T,fnfunc(T)){gofunc(d T){deferRecoverPanic()// 增加一层防火墙fn(d)}(data)}// 在捕获 Panic 下 异步运行(goroutine) 某个方法(无入参)funcAsyncRunWithRecoverPanic2(fnfunc()){gofunc(){deferRecoverPanic()// 增加一层防火墙fn()}()}
版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/23 15:40:45

为什么顶尖量子团队都在用这个VSCode扩展?配置细节全解析

第一章&#xff1a;量子模拟器 VSCode 扩展的配置 为在本地开发环境中高效运行和调试量子算法&#xff0c;配置适用于量子计算的 VSCode 扩展至关重要。通过集成 Q# 开发工具包&#xff0c;开发者可在熟悉的编辑器中编写、模拟和分析量子程序。 安装 Quantum Development Kit …

作者头像 李华
网站建设 2026/4/23 0:54:54

【高可用边缘Agent架构】:基于Docker的部署优化与监控方案

第一章&#xff1a;高可用边缘Agent架构概述在现代分布式系统中&#xff0c;边缘Agent作为连接中心控制平面与终端设备的核心组件&#xff0c;承担着数据采集、指令执行和状态同步等关键职责。为保障服务连续性&#xff0c;高可用边缘Agent架构需具备故障自动转移、多实例协同与…

作者头像 李华
网站建设 2026/4/20 0:47:52

深入Spring Boot源码(六):Actuator端点与监控机制深度解析

前言在生产环境中&#xff0c;应用的监控和管理是至关重要的。Spring Boot Actuator模块提供了丰富的生产就绪特性&#xff0c;帮助开发者监控应用状态、收集运行时指标、管理应用配置等。本文将深入Actuator的内部机制&#xff0c;解析端点的实现原理、健康检查机制、指标收集…

作者头像 李华
网站建设 2026/4/26 20:14:47

31、深入理解动态内存分配与数据对齐

深入理解动态内存分配与数据对齐 1. 动态内存分配概述 在编程中,动态内存分配是一项关键技术,用于在程序运行时获取和管理内存。与自动和静态变量不同,动态内存是在运行时分配的,其大小可能在分配时才确定。例如,当需要存储文件内容或用户输入时,由于文件大小和用户输入…

作者头像 李华
网站建设 2026/4/23 5:37:56

Tessy集成测试-同一module复制粘贴后新的module执行报错

1_背景 在测试接口过程中&#xff0c;因后续报告需要匹配问题&#xff0c;同一module里的用例较多&#xff0c;生成报告后需要手动匹配对应接口文件夹&#xff0c;所以想法是在测试阶段一条module对应一条用例&#xff0c;那么有些接口调用关系相同&#xff0c;所以只需要粘贴复…

作者头像 李华