您现在的位置是：首页 > 文章详情

.NET 全能 Cron 表达式解析库 TimeCrontab v3.3.6

日期：2024-01-10点击：36收藏

TimeCrontab

.NET 全能 Cron 表达式解析库，支持 Cron 所有特性。

TimeCrontab.drawio

特性

支持 Cron 所有特性
超高性能
易拓展
很小，仅 4KB
无第三方依赖
跨平台
高质量代码和良好单元测试
支持 .NET Framework 3.5+ 及后续版本

安装

Package Manager

 Install-Package TimeCrontab

.NET CLI

 dotnet add package TimeCrontab

快速入门

我们在主页上有不少例子，这是让您入门的第一个：

常规格式：分时天月周

 var crontab = Crontab.Parse("* * * * *"); var nextOccurrence = crontab.GetNextOccurrence(DateTime.Now);

支持年份：分时天月周年

 var crontab = Crontab.Parse("* * * * * *", CronStringFormat.WithYears); var nextOccurrence = crontab.GetNextOccurrence(DateTime.Now);

支持秒数：秒分时天月周

 var crontab = Crontab.Parse("* * * * * *", CronStringFormat.WithSeconds); var nextOccurrence = crontab.GetNextOccurrence(DateTime.Now);

支持秒和年：秒分时天月周年

 var crontab = Crontab.Parse("* * * * * * *", CronStringFormat.WithSecondsAndYears); var nextOccurrence = crontab.GetNextOccurrence(DateTime.Now);

获取休眠差实现简单定时任务

 // 阻塞方式 var crontab = Crontab.Parse("* * * * * *", CronStringFormat.WithSeconds); while(true) {  Thread.Sleep(crontab.GetSleepMilliseconds(DateTime.Now));  Console.WriteLine(DateTime.Now.ToString("G")); } // 无阻塞方式 var crontab = Crontab.Parse("* * * * * *", CronStringFormat.WithSeconds); Task.Factory.StartNew(async () => {  while (true)  {  await Task.Delay(crontab.GetSleepMilliseconds(DateTime.Now));  Console.WriteLine(DateTime.Now.ToString("G"));  } }, TaskCreationOptions.LongRunning);

BackgroundService 实现简单定时任务

 using TimeCrontab; namespace WorkerService; public class Worker : BackgroundService {  private readonly ILogger<Worker> _logger;  private readonly Crontab _crontab;  public Worker(ILogger<Worker> logger)  {  _logger = logger;  _crontab = Crontab.Parse("* * * * * *", CronStringFormat.WithSeconds);  }  protected override async Task ExecuteAsync(CancellationToken stoppingToken)  {  while (!stoppingToken.IsCancellationRequested)  {  var taskFactory = new TaskFactory(System.Threading.Tasks.TaskScheduler.Current);  await taskFactory.StartNew(async () =>  {  // 你的业务代码写到这里面  _logger.LogInformation("Worker running at: {time}", DateTime.Now);  await Task.CompletedTask;  }, stoppingToken);  await Task.Delay(_crontab.GetSleepMilliseconds(DateTime.Now), stoppingToken);  }  } }

Macro 标识符

 // macro 字符串 var secondly = Crontab.Parse("@secondly"); // 每秒 var minutely = Crontab.Parse("@minutely"); // 每分钟 var hourly = Crontab.Parse("@hourly"); // 每小时 var daily = Crontab.Parse("@daily"); // 每天 00:00:00 var monthly = Crontab.Parse("@monthly"); // 每月 1 号 00:00:00 var weekly = Crontab.Parse("@weekly"); // 每周日 00：00：00 var yearly = Crontab.Parse("@yearly"); // 每年 1 月 1 号 00:00:00 var workday = Crontab.Parse("@workday"); // 每周一至周五 00:00:00 // 静态属性 var secondly = Crontab.Secondly; // 每秒 var minutely = Crontab.Minutely; // 每分钟 var hourly = Crontab.Hourly; // 每小时 var daily = Crontab.Daily; // 每天 00:00:00 var monthly = Crontab.Monthly; // 每月 1 号 00:00:00 var weekly = Crontab.Weekly; // 每周日 00：00：00 var yearly = Crontab.Yearly; // 每年 1 月 1 号 00:00:00 var workday = Crontab.Workday; // 每周一至周五 00:00:00

Macro At 标识符

 // 每第 3 秒 var crontab = Crontab.SecondlyAt(3); // 每第 3，5，6 秒 var crontab = Crontab.SecondlyAt(3, 5, 6); // 每分钟第 3 秒 var crontab = Crontab.MinutelyAt(3); // 每分钟第 3，5，6 秒 var crontab = Crontab.MinutelyAt(3, 5, 6); // 每小时第 3 分钟 var crontab = Crontab.HourlyAt(3); // 每小时第 3，5，6 分钟 var crontab = Crontab.HourlyAt(3, 5, 6); // 每天第 3 小时正（点） var crontab = Crontab.DailyAt(3); // 每天第 3，5，6 小时正（点） var crontab = Crontab.DailyAt(3, 5, 6); // 每月第 3 天零点正 var crontab = Crontab.MonthlyAt(3); // 每月第 3，5，6 天零点正 var crontab = Crontab.MonthlyAt(3, 5, 6); // 每周星期 3 零点正 var crontab = Crontab.WeeklyAt(3); var crontab = Crontab.WeeklyAt("WED"); // SUN（星期天），MON，TUE，WED，THU，FRI，SAT // 每周星期 3，5，6 零点正 var crontab = Crontab.WeeklyAt(3, 5, 6); var crontab = Crontab.WeeklyAt("WED", "FRI", "SAT"); // 还支持混合 var crontab = Crontab.WeeklyAt(3, "FRI", 6); // 每年第 3 月 1 日零点正 var crontab = Crontab.YearlyAt(3); var crontab = Crontab.YearlyAt("MAR"); // JAN（一月），FEB，MAR，APR，MAY，JUN，JUL，AUG，SEP，OCT，NOV，DEC // 每年第 3，5，6 月 1 日零点正 var crontab = Crontab.YearlyAt(3); var crontab = Crontab.YearlyAt(3, 5, 6); var crontab = Crontab.YearlyAt("MAR", "MAY", "JUN"); // 还支持混合 var crontab = Crontab.YearlyAt(3, "MAY", 6);

更多文档

文档

您可以在主页找到 TimeCrontab 文档。

测试

 public class TimeCrontabUnitTests {  [Theory]  [InlineData("* * * * *", "* * * * *", CronStringFormat.Default)]  [InlineData("0 0 31W * *", "0 0 31W * *", CronStringFormat.Default)]  [InlineData("0 23 ? * MON-FRI", "0 23 ? * 1-5", CronStringFormat.Default)]  [InlineData("*/5 * * * *", "*/5 * * * *", CronStringFormat.Default)]  [InlineData("30 11 * * 1-5", "30 11 * * 1-5", CronStringFormat.Default)]  [InlineData("23 12 * JAN *", "23 12 * 1 *", CronStringFormat.Default)]  [InlineData("* * * * MON#3", "* * * * 1#3", CronStringFormat.Default)]  [InlineData("*/5 * L JAN *", "*/5 * L 1 *", CronStringFormat.Default)]  [InlineData("0 0 ? 1 MON#1", "0 0 ? 1 1#1", CronStringFormat.Default)]  [InlineData("0 0 LW * *", "0 0 LW * *", CronStringFormat.Default)]  [InlineData("0 30 10-13 ? * WED,FRI", "0 30 10-13 ? * 3,5", CronStringFormat.WithSeconds)]  [InlineData("0 */5 * * * *", "0 */5 * * * *", CronStringFormat.WithSeconds)]  [InlineData("0 0/1 * * * ?", "0 */1 * * * ?", CronStringFormat.WithSeconds)]  [InlineData("5-10 30-35 10-12 * * *", "5-10 30-35 10-12 * * *", CronStringFormat.WithSeconds)]  public void TestParse(string expression, string outputString, CronStringFormat format)  {  var output = Crontab.Parse(expression, format).ToString();  Assert.Equal(outputString, output);  }  [Theory]  [InlineData("* * * * *", "2022-01-01 00:01:00", CronStringFormat.Default)]  [InlineData("0 0 31W * *", "2022-01-31 00:00:00", CronStringFormat.Default)]  [InlineData("0 23 ? * MON-FRI", "2022-01-03 23:00:00", CronStringFormat.Default)]  [InlineData("*/5 * * * *", "2022-01-01 00:05:00", CronStringFormat.Default)]  [InlineData("30 11 * * 1-5", "2022-01-03 11:30:00", CronStringFormat.Default)]  [InlineData("23 12 * JAN *", "2022-01-01 12:23:00", CronStringFormat.Default)]  [InlineData("* * * * MON#3", "2022-01-17 00:00:00", CronStringFormat.Default)]  [InlineData("*/5 * L JAN *", "2022-01-31 00:00:00", CronStringFormat.Default)]  [InlineData("0 0 ? 1 MON#1", "2022-01-03 00:00:00", CronStringFormat.Default)]  [InlineData("0 0 LW * *", "2022-01-31 00:00:00", CronStringFormat.Default)]  [InlineData("0 30 10-13 ? * WED,FRI", "2022-01-05 10:30:00", CronStringFormat.WithSeconds)]  [InlineData("0 */5 * * * *", "2022-01-01 00:05:00", CronStringFormat.WithSeconds)]  [InlineData("0 0/1 * * * ?", "2022-01-01 00:01:00", CronStringFormat.WithSeconds)]  [InlineData("5-10 30-35 10-12 * * *", "2022-01-01 10:30:05", CronStringFormat.WithSeconds)]  public void TestGetNextOccurence(string expression, string nextOccurenceString, CronStringFormat format)  {  var beginTime = new DateTime(2022, 1, 1, 0, 0, 0);  var crontab = Crontab.Parse(expression, format);  var nextOccurence = crontab.GetNextOccurrence(beginTime);  Assert.Equal(nextOccurenceString, nextOccurence.ToString("yyyy-MM-dd HH🇲🇲ss"));  } }

贡献

该存储库的主要目的是继续发展 TimeCrontab 核心，使其更快、更易于使用。TimeCrontab 的开发在 Gitee 上公开进行，我们感谢社区贡献错误修复和改进。

许可证

TimeCrontab 采用 MIT 开源许可证。

本期更新

新特性
- [新增] Crontab.IsValid(...) 静态方法，判断 Cron 表达式是否有效 4.8.7.17 ⏱️2023.03.20 #I6OHO4
- [新增] crontab.GetSleepTimeSpan(baseTime) 实例方法 4.8.4.10 ⏱️2023.01.09 #I69HM4
- [新增] Crontab.ParseAt(..) 静态方法 4.8.2.6 ⏱️2022.11.30 035cc23
- [新增] Crontab 所有 Macro At 静态方法 4.8.2.6 ⏱️2022.11.30 a15b69d
- [新增] Crontab.Workday 表示周一至周五的 Macro 静态属性 4.8.2.6 ⏱️2022.11.30 a15b69d
问题修复
- [修复] Cron 表达式步长解析器错误 4.8.8.25 ⏱️2023.06.14 #I7D9XU
- [修复] Cron 表达式 * 符号解析器不够严谨，如：*1111aaaaa 也被解析为 * 4.8.7.17 ⏱️2023.03.20 #I6OHO4