笔记源于课堂编写:BiliBili
源视频教程:https://www.bilibili.com/video/BV1zJ411k7hY
一、调度服务QuartZ基本使用
1.1-什么是定时服务
在时间轴上,在某一刻,去执行某一个任务,随着时间轴循环往复。
1.2-调度服务
调度服务:就是在指定的时间去做什么事情,循环往复。
1.3-怎么使用Quartz
//防止采坑:控制台应用程序【Quartz.UI】和类库【Quartz.Service】中都需要引入【Quartz】包。
(1)新建一个控制台应用程序,目标程序为【.NET Framework 4.7.2】
(2)管理Nuget程序包,导入Quartz包
(3)Program代码如下:
static void Main(string[] args)
{
Console.WriteLine("开始执行了...");
try
{
DispatchingManager.Init().GetAwaiter().GetResult();
}
catch (Exception ex) {
Console.WriteLine(ex.Message);
throw;
}
Console.Read();
}
(4)创建一个.NET Framework类库【Quartz.Service】结构如下:
(5)管理Nuget程序包,导入Quartz包
(6)【SendMessageJob.cs】代码如下:
namespace Quartz.CustomJob.Service
{
/// <summary>
/// 做什么事情
///
/// 该类是需要继承自:IJob
/// </summary>
public class SendMessageJob : IJob
{
/// <summary>
/// 当前Task内部作业需要执行的任务
/// </summary>
/// <param name="context"></param>
/// <returns></returns>
public async Task Execute(IJobExecutionContext context)
{
await Task.Run(() =>
{
Console.WriteLine();
Console.WriteLine("********************************************");
Console.WriteLine($"你好,现在开始上课了~{DateTime.Now}");
Console.WriteLine("********************************************");
Console.WriteLine();
});
}
}
}
(7)【DispatchingManager.cs】代码如下:
namespace Quartz.Service
{
/// <summary>
/// 管理者
/// </summary>
public class DispatchingManager
{
public async static Task Init() {
#region 创建单元(时间轴/载体)
StdSchedulerFactory factory = new StdSchedulerFactory();
IScheduler scheduler = await factory.GetScheduler();
//让载体开始执行
await scheduler.Start();
#endregion
#region 描述这个任务,做什么事情(Job)
IJobDetail jobDetail = JobBuilder.Create<SendMessageJob>()
.WithIdentity("sendMessageJob","group1")//分组
.WithDescription("This is Send Message Job")//描述信息
.Build();
#endregion
#region 什么时候开始做事(Trigger)
ITrigger trigger = TriggerBuilder.Create()
.WithIdentity("sendMessageTrigger", "group1")//分组
.StartNow()//当前开始
.WithSimpleSchedule(u => u.WithIntervalInSeconds(5).WithRepeatCount(3))//没5秒执行一次,最多执行3次
.Build();
#endregion
//将时间策略和作业承载到单元上
await scheduler.ScheduleJob(jobDetail, trigger);
}
}
}
(8)执行结果如下:
二、Quartz框架在使用的时候传递参数
2.1-Quartz框架的使用传递
- jobDetail.JobDataMap.Add
- trigger.JobDataMap.Add
- 要注意:使用MergedJobMap,都能获得之前传的参数,但是会覆盖,后者为准。
2.2-怎么获取上一次执行的结果作为下一次执行的参数?
在继承自IJob类中添加以下特性: [PersistJobDataAfterExecution]
//执行后的保留作业数据链式传参。
2.3-怎么确定上一次任务执行完毕后在执行下一次任务?
在继承自IJob类中添加以下特性: [DisallowConcurrentExecution]
//在实际的任务执行中,可能会比较耗时,以上特性就是不允许当前执行确定上一次的任务执行完毕后在往后执行。
三、Quartz框架时间策略详解
3.1-常用的时间策略
- Simple Trigger:从什么时间开始,间隔多久执行重复操作,可以限制最大次数。
- Cron:表达式方法,可以灵活定制时间规则。
3.2-Cron表达式详解
Cron生成器:https://cron.qqe2.com/
Cron表达式详解:https://www.cnblogs.com/yanghj010/p/10875151.html
Cron表达式是一个字符串,字符串以5或6个空格隔开,分为6或7个域,每一个域代表一个含义,Cron有如下两种语法格式:
(1) Seconds Minutes Hours DayofMonth Month DayofWeek Year
(2)Seconds Minutes Hours DayofMonth Month DayofWeek
一、结构
corn从左到右(用空格隔开):秒 分 小时 月份中的日期 月份 星期中的日期 年份
二、各字段的含义
字段 | 允许值 | 允许的特殊字符 |
---|---|---|
秒(Seconds) | 0~59的整数 | , - * / 四个字符 |
分(Minutes) | 0~59的整数 | , - * / 四个字符 |
小时(Hours) | 0~23的整数 | , - * / 四个字符 |
日期(DayofMonth) | 1~31的整数(但是你需要考虑你月的天数) | ,- * ? / L W C 八个字符 |
月份(Month) | 1~12的整数或者 JAN-DEC | , - * / 四个字符 |
星期(DayofWeek) | 1~7的整数或者 SUN-SAT (1=SUN) | , - * ? / L C # 八个字符 |
年(可选,留空)(Year) | 1970~2099 | , - * / 四个字符 |
注意事项:
每一个域都使用数字,但还可以出现如下特殊字符,它们的含义是:
(1):表示匹配该域的任意值。假如在Minutes域使用, 即表示每分钟都会触发事件。
(2)?:只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值,但实际不会。因为DayofMonth和DayofWeek会相互影响。例如想在每月的20日触发调度,不管20日到底是星期几,则只能使用如下写法: 13 13 15 20 ?, 其中最后一位只能用?,而不能使用,如果使用表示不管星期几都会触发,实际上并不是这样。
(3)-:表示范围。例如在Minutes域使用5-20,表示从5分到20分钟每分钟触发一次
(4)/:表示起始时间开始触发,然后每隔固定时间触发一次。例如在Minutes域使用5/20,则意味着5分钟触发一次,而25,45等分别触发一次.
(5),:表示列出枚举值。例如:在Minutes域使用5,20,则意味着在5和20分每分钟触发一次。
(6)L:表示最后,只能出现在DayofWeek和DayofMonth域。如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。
(7)W:表示有效工作日(周一到周五),只能出现在DayofMonth域,系统将在离指定日期的最近的有效工作日触发事件。例如:在 DayofMonth使用5W,如果5日是星期六,则将在最近的工作日:星期五,即4日触发。如果5日是星期天,则在6日(周一)触发;如果5日在星期一到星期五中的一天,则就在5日触发。另外一点,W的最近寻找不会跨过月份 。
(8)LW:这两个字符可以连用,表示在某个月最后一个工作日,即最后一个星期五。
(9)#:用于确定每个月第几个星期几,只能出现在DayofMonth域。例如在4#2,表示某月的第二个星期三。
*
三、常用表达式例子
(1)0 0 2 1 ? 表示在每月的1日的凌晨2点调整任务
(2)0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15执行作业
(3)0 15 10 ? 6L 2002-2006 表示2002-2006年的每个月的最后一个星期五上午10:15执行作
(4)0 0 10,14,16 ? 每天上午10点,下午2点,4点
(5)0 0/30 9-17 ? 朝九晚五工作时间内每半小时
(6)0 0 12 ? * WED 表示每个星期三中午12点
(7)0 0 12 ? 每天中午12点触发
(8)0 15 10 ? 每天上午10:15触发
(9)0 15 10 ? 每天上午10:15触发
(10)0 15 10 ? * 每天上午10:15触发
(11)0 15 10 ? 2005 2005年的每天上午10:15触发
(12)0 14 * ? 在每天下午2点到下午2:59期间的每1分钟触发
(13)0 0/5 14 ? 在每天下午2点到下午2:55期间的每5分钟触发
(14)0 0/5 14,18 ? 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
(15)0 0-5 14 ? 在每天下午2点到下午2:05期间的每1分钟触发
(16)0 10,44 14 ? 3 WED 每年三月的星期三的下午2:10和2:44触发
(17)0 15 10 ? * MON-FRI 周一至周五的上午10:15触发
(18)0 15 10 15 * ? 每月15日上午10:15触发
(19)0 15 10 L * ? 每月最后一日的上午10:15触发
(20)0 15 10 ? * 6L 每月的最后一个星期五上午10:15触发
(21)0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发
(22)0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发
注:
(1)有些子表达式能包含一些范围或列表
例如:子表达式(天(星期))可以为 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”
“”字符代表所有可能的值
因此,“”在子表达式(月)里表示每个月的含义,“*”在子表达式(天(星期))表示星期的每一天
“/”字符用来指定数值的增量
例如:在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟
在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样
“?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值
当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”
“L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写
但是它在两个子表达式里的含义是不同的。
在天(月)子表达式中,“L”表示一个月的最后一天
在天(星期)自表达式中,“L”表示一个星期的最后一天,也就是SAT
如果在“L”前有具体的内容,它就具有其他的含义了
例如:“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五
注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题
四、Quartz框架监控日志
4.1-Quartz框架的监听器和日志
- Quartz框架的监听器和日志
- SchedulerListener
- TriggerListener
- JobListener
- LogProvider可以展示框架运行的一些信息。
//如果框架内部有Bug,我们可以通过这个吧错误信息调出来。