Hangfire.HttpJob RESTful API 全解析14个接口玩转任务调度与生命周期管理【免费下载链接】Hangfire.HttpJobhttpjob for Hangfire,restful api for Hangfire,job调度与业务分离项目地址: https://gitcode.com/gh_mirrors/ha/Hangfire.HttpJobHangfire.HttpJob 是一个为 Hangfire 打造的job 调度与业务分离开源方案它把任务调度彻底 RESTful API 化只需向 Dashboard 暴露的/hangfire/httpjob端点 POST 一段 JSON就能完成后台任务、周期性任务的新增、删除、暂停、恢复与生命周期管理真正做到调度与业务代码解耦。本文基于源码逐接口拆解带你快速掌握这 14 个调度接口的用法与最佳实践。一、为什么需要 RESTful API 化的任务调度传统 Hangfire 调度需要引用程序集、编写BackgroundJob.Enqueue代码而 Hangfire.HttpJob 的核心思路是调度即 HTTP 请求调度与业务分离业务方只需提供一个可访问的 URL调度端用 JSON 描述何时调、怎么调。多语言友好任何语言只要会发 HTTP 请求就能接入 .NET 调度体系。可视化闭环所有任务在 Hangfire Dashboard 上可看、可查、可一键操作。所有接口都注册在 GlobalConfigurationExtension.cs 的DashboardRoutes.Routes.Add(/httpjob, ...)中统一走POST通过?op参数区分操作类型具体分发逻辑见 HttpJobDispatcher.cs。二、14个接口全景速查表分类op 参数功能任务创建backgroundjob新增后台任务立即/延迟/定时执行任务创建recurringjob新增或更新周期性任务任务创建addrecurringjob仅新增周期性任务已存在则报错任务创建editrecurringjob编辑周期性任务任务删除deljob删除后台或周期性任务生命周期pausejob暂停/恢复周期性任务生命周期startbackgroundjob启动触发后台任务生命周期stopbackgroundjob停止正在运行的后台任务查询getrecurringjob获取周期性任务详情查询getrecurringjobs分页查询周期性任务列表查询getbackgroundjobdetail获取后台任务Agent详情查询getpasusejobcron获取暂停任务的原 Cron配置getglobalsetting/saveglobalsetting读写全局配置运维getagentserver获取 Agent 服务器列表运维exportjobs/importjobs任务批量导出/导入三、任务创建接口3种方式灵活添加调度任务1. 新增后台任务opbackgroundjob这是最常用的接口JSON 中DelayFromMinutes的语义非常灵活见 BaseJobItems-1手动触发不自动执行0立即执行入队0延迟 N 分钟后执行配置RunAt指定具体运行时间时优先于DelayFromMinutes。{ Method: POST, ContentType: application/json, Url: http://your-api.com/job/do-something, Data: {\userName\:\test\}, Timeout: 5000, DelayFromMinutes: 1, JobName: test_backgroundjob }2. 新增/更新周期性任务oprecurringjob周期性任务依赖 Cron 表达式支持时区、队列名、失败重试等丰富参数。recurringjob是有则更新、无则新增适合幂等场景addrecurringjob则严格要求只新增重复注册会返回is registerd!错误适合防止误覆盖。{ Method: POST, Url: http://your-api.com/sync/data, Cron: 0 12 * * *, JobName: daily_sync, QueueName: default }3. 编辑周期性任务opeditrecurringjob与recurringjob共用同一套处理逻辑见AddOrUpdateRecurringJob特别之处在于如果任务当前处于暂停状态更新时会自动保留暂停状态不变只更新配置避免编辑一次任务导致任务被意外恢复运行。四、任务删除与生命周期管理接口删除任务opdeljob通过Data字段区分删除类型Data: backgroundjob删除后台任务按 JobId否则按 JobName 删除周期性任务。对应的客户端方法见 HangfireJobClient.cs 中的RemoveBackgroundJob与RemoveRecurringJob。暂停/恢复oppausejob暂停的底层实现是把 Cron 改为Cron.Never()同时把原 Cron 存入JobPauseOf:{jobname}集合中恢复时再读回原 Cron。因此暂停期间千万别手动改 Cron否则会丢失原始调度表达式。启动与停止startbackgroundjob/stopbackgroundjob这两个接口配合 Agent 使用实现运行中任务的在线启停startbackgroundjob把运行时参数Data写入{JobName}.runtime哈希唤醒任务按新参数运行stopbackgroundjob写入Action: stop指令通知 Agent 端优雅停止实现见StartBackgroudJob/StopBackgroudJob。五、查询接口全链路任务可见性getrecurringjob按 JobName 返回周期性任务完整 JSON 配置getrecurringjobs分页查询返回pageNo/pageSize/rows/totalPage/totalRows结构getbackgroundjobdetail获取 Agent 任务实时运行详情日志、进度getpasusejobcron查询暂停任务被藏起来的原 Cron用于恢复时预览。六、配置与运维接口让调度系统可管理getglobalsetting/saveglobalsetting读写hangfire_global.json全局配置文件例如全局 HTTP 超时、通用回调配置等getagentserver返回所有在线 Agent 服务器列表HTML 片段用于集群监控exportjobs/importjobs将全部周期性任务导出为 JSON或批量导入实现环境间任务迁移测试→生产零成本。七、Agent 扩展任务生命周期的高级玩法Hangfire.HttpJob.Agent 将任务生命周期抽象为三种运行模式对应 Attribute 目录特性生命周期[SingletonJob]单例同时只允许一个实例运行重复触发直接丢弃[TransientJob]瞬时每次触发都启动新实例互不干扰[HangJobUntilStop]常驻启动后一直运行直到收到 stop 指令才退出这三种模式与前面提到的startbackgroundjob/stopbackgroundjob接口组合即可实现长驻服务型任务的远程启停控制这正是Hangfire.HttpJob 任务调度区别于普通定时 HTTP 调用的核心价值。八、快速上手一行代码完成任务调度推荐直接使用官方客户端 Hangfire.HttpJob.Client零手写 HTTPvar result HangfireJobClient.AddBackgroundJob(serverUrl, new BackgroundJob { JobName 测试任务, Method Get, Url http://localhost:5000/api/test, DelayFromMinutes 1 }, new HangfireServerPostOption { BasicUserName admin, BasicPassword test });也可以直接调 RESTful API配合HangfireServerPostOption实现 Basic 认证与 Dashboard 授权无缝衔接。九、总结Hangfire.HttpJob 用14个 RESTful 接口把任务调度的增删改查、生命周期控制、配置管理、批量迁移全部封装为 HTTP 语义配合 Agent 的三种生命周期模式堪称 .NET 生态中调度与业务分离的教科书级实践。无论是构建分布式定时任务平台还是为既有系统快速补充调度能力这套 API 都值得收藏使用。提示接入 Dashboard 时只需在ConfigureServices中调用UseHangfireHttpJob()即可完成所有接口注册完整示例可参考仓库 TestHangfire 等测试工程。【免费下载链接】Hangfire.HttpJobhttpjob for Hangfire,restful api for Hangfire,job调度与业务分离项目地址: https://gitcode.com/gh_mirrors/ha/Hangfire.HttpJob创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考