# FreeScheduler **Repository Path**: anysharp/FreeScheduler ## Basic Information - **Project Name**: FreeScheduler - **Description**: FreeScheduler 轻量化定时任务调度，支持临时的延时任务和重复循环任务(可持久化)，可按秒，每天/每周/每月固定时间，自定义间隔执行（CRON表达式），支持 .NET Framework 4.0，.NETCore2.1 +，Xamarin、MAUI 等平台 运行环境。 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 2 - **Forks**: 0 - **Created**: 2024-10-09 - **Last Updated**: 2025-01-18 ## Categories & Tags **Categories**: Uncategorized **Tags**: 任务调度 ## README FreeScheduler 是利用 IdleBus 实现的轻量化定时任务调度，支持集群、临时的延时任务和重复循环任务(可持久化)，可按秒，每天/每周/每月固定时间，自定义间隔执行，支持 .NET Core 2.1+、.NET Framework 4.0+ 运行环境。 > IdleScheduler 已正式改名为 FreeScheduler 如果对本项目感兴趣，欢迎加入 FreeSql QQ讨论群：8578575 ## Quick start > dotnet add package FreeScheduler > Install-Package FreeScheduler ```csharp static Scheduler scheduler = new FreeSchedulerBuilder() .OnExecuting(task => { Console.WriteLine($"[{DateTime.Now.ToString("HH:mm:ss.fff")}] {task.Topic} 被执行"); switch (task.Topic) { case "武林大会": Wulin(task.Body); break; case "攻城活动": AttackCity(task.Body); break; } }) .Build(); ``` | Method | 说明 | | -- | -- | | OnExecuting(Action\ executing) | 任务触发 | | UseTimeZone() | 设置时区 | | UseStorage() | 基于 数据库或者 Redis 持久化 | | UseCluster() | 开启集群（依赖 Redis），支持跨进程互通 | | UseCustomInterval() | 自定义间隔（可实现 cron） | | UseScanInterval() | 扫描间隔（默认200ms），值越小触发精准 | | Build() | 创建 Scheduler 对象 | 使用 ASP.NET Core 项目，一行代码解决如下： ```csharp app.UseFreeSchedulerUI("/freescheduler/"); ``` ![image](https://github.com/2881099/FreeSql.Wiki.VuePress/assets/16286519/a5d5f4bb-6af9-4695-9570-8777c39d7329) ## 集群特性 - 支持 单项目，多站点部署 - 支持 多进程，不重复执行 - 支持 进程退出后，由其他进程重新加载任务（约30秒后） - 支持 进程互通，任意进程都可以执行（RemoveTask/ExistsTask/PauseTask/RunNowTask/RemoveTempTask/ExistsTempTask） - 支持 进程意外离线后，卸载进程内的任务，重新安排上线 1、临时任务(不可持久化) ```csharp void Callback() { Console.WriteLine("时间到了"); scheduler.AddTempTask(TimeSpan.FromSeconds(10), Callback); //下一次定时 } scheduler.AddTempTask(TimeSpan.FromSeconds(10), Callback); ``` | Method | 说明 | | -- | -- | | string AddTempTask(TimeSpan, Action) | 创建临时的延时任务，返回 id | | bool RemoveTempTask(string id) | 删除任务(临时任务) | | bool ExistsTempTask(string id) | 判断任务是否存在(临时任务) | | int QuantityTempTask | 任务数量(临时任务) | 2、循环任务/可持久化 ```csharp //每5秒触发，执行N次 var id = scheduler.AddTask("topic1", "body1", round: -1, 5); //每次 不同的间隔秒数触发，执行6次 var id = scheduler.AddTask("topic1", "body1", new [] { 5, 5, 10, 10, 60, 60 }); //每天 20:00:00 触发，执行N次（注意设置时区 UseTimeZone） var id = scheduler.AddTaskRunOnDay("topic1", "body1", round: -1, "20:00:00"); //每周一 20:00:00 触发，执行1次 var id = scheduler.AddTaskRunOnWeek("topic1", "body1", round: 1, "1:20:00:00"); //每月1日 20:00:00 触发，执行12次 var id = scheduler.AddTaskRunOnMonth("topic1", "body1", round: 12, "1:20:00:00"); //每月最后一日 20:00:00 触发，执行12次 var id = scheduler.AddTaskRunOnMonth("topic1", "body1", round: 12, "-1:20:00:00"); //自定义间隔 cron var id = scheduler.AddTaskCustom("topic1", "body1", "0/1 * * * * ? "); new FreeSchedulerBuilder() ... .UseCustomInterval(task => { //利用 cron 功能库解析 task.IntervalArgument 得到下一次执行时间 //与当前时间相减，得到 TimeSpan，若返回 null 则任务完成 return TimeSpan.FromSeconds(5); }) .Build(); ``` | Method | 说明 | | -- | -- | | void ctor(ITaskHandler) | 指定任务调度器（单例） | | string AddTask(string topic, string body, int round, int seconds) | 创建循环定时任务，返回 id | | string AddTask(string topic, string body, int[] seconds) | 创建每轮间隔不同的定时任务，返回 id | | string AddTaskRunOnDay(..) | 创建每日循环任务，返回 id | | string AddTaskRunOnWeek(..) | 创建每周循环任务，返回 id | | string AddTaskRunOnMonth(..) | 创建每月循环任务，返回 id | | string AddTaskCustom(string topic, string body, string expression) | 创建自定义任务，返回 id | | bool RemoveTask(string id) | 删除任务 | | bool ExistsTask(string id) | 判断任务是否存在 | | bool ResumeTask(string id) | 恢复已暂停的任务 | | bool PauseTask(string id) | 暂停正在运行的任务 | | bool RunNowTask(string id) | 立刻运行任务（人工触发） | | TaskInfo[] FindTask(lambda) | 查询正在运行中的任务 | | int QuantityTask | 任务数量 | 3、预留任务 > [系统预留]清理任务数据 ```csharp //每小时触发，定期清理24小时之前的数据（单位：秒） scheduler.AddTask("[系统预留]清理任务数据", "86400", round: -1, 3600); ``` 4、管理任务 ```csharp // 使用 FreeSql 或者 SQL 查询 TaskInfo、TaskLog 两个表进行分页显示 fsql.Select().Count(out var total).Page(pageNumber, 30).ToList(); fsql.Select().Count(out var total).Page(pageNumber, 30).ToList(); //暂停任务 scheduler.PauseTask(id); //恢复暂停的任务 scheduler.ResumeTask(id); //删除任务 scheduler.RemoveTask(id); //立刻运行任务（人工触发） scheduler.RunNowTask(id); ``` 如果正在使用 ASP.NET Core 项目，一行代码解决如下： ```csharp app.UseFreeSchedulerUI("/freescheduler/"); ``` https://github.com/2881099/FreeScheduler/tree/master/Examples/Examples_FreeScheduler_Net60 ![image](https://github.com/2881099/FreeSql.Wiki.VuePress/assets/16286519/a5d5f4bb-6af9-4695-9570-8777c39d7329) ## Performance | FreeScheduler | Quartz.net | FluentScheduler | HashedWheelTimer | | -- | -- | -- | -- | | (500,000 Tasks + 10s) | (500,000 Tasks + 10s) | (500,000 Tasks + 10s) | (500,000 Tasks + 10s) | | | | | | | 383M | 1700+M | StackOverflow | 213M | | 70563.6066ms | 50692.5365ms | 未知 | 33697.8758ms | FluentScheduler 单个 Registry 测试正常，但目测单线程执行(间隔1-10ms)，处理速度不理想 [View Code](https://github.com/2881099/FreeScheduler/blob/master/Examples/Examples_FreeScheduler_VsQuartz/Program.cs) 我尝试把 FreeScheduler 内核改成 HashedWheelTimer 内存占用更高(600兆)，结论：FreeScheduler 功能需要占用更多资源 ## 💕 Donation (捐赠) > 感谢你的打赏 - [Alipay](https://www.cnblogs.com/FreeSql/gallery/image/338860.html) - [WeChat](https://www.cnblogs.com/FreeSql/gallery/image/338859.html) ## 🗄 License (许可证) [MIT](LICENSE)