一、概述
Quartz.Net是根據Java的Quartz用C#改寫而來，Quartz.NET是一個開源的作業調度框架，非常適合在平時的工作中，定時輪詢數據庫同步，定時郵件通知，定時處理數據等。 Quartz.NET允許開發人員根據時間間隔來調度作業。它有很多特征如：數據庫支持，集群，插件，支持cron-like表達式等等。
二、參考
Quartz.Net源碼：https://github.com/quartznet/quartznet
官方學習文檔：http://www.quartz-scheduler.net/documentation/index.html
三、Quartz.Net說明
Quartz主要有三部分組成任務(Job)、觸發器(Trigger)和調度器(Schedule)。
1、任務
Job就是執行的作業，Job需要繼承IJob接口，實現Execute方法。Job中執行的參數從Execute方法的參數中獲取。
2、觸發器
觸發器常用的有兩種：SimpleTrigger觸發器和CronTrigger觸發器。
（1）SimpleTrigger
實現簡單業務，如每隔幾分鍾，幾小時觸發執行，並限制執行次數。
- 重復執行：WithRepeatCount()/RepeatForever()
- 設置間隔時間：WithInterval()
- 定時執行：StartAt()/StartNow()
- 設定優先級：WithPriority()，默認為5
var trigger = TriggerBuilder.Create()
.WithSimpleSchedule(x => x.WithIntervalInSeconds(2).WithRepeatCount(5))//間隔2秒 執行6次
.UsingJobData("key1", 321)
.WithIdentity("trigger", "group")
.Build();
（2）CronTrigger
Cron表達式包含7個字段，秒 分 時 月內日期 月 周內日期 年(可選)。corn在線生成https://qqe2.com/cron
var trigger = TriggerBuilder.Create()
.WithCronSchedule("0 0 0 1 1 ?")// 每年元旦1月1日 0 點觸發
.UsingJobData("key1", 321)
.UsingJobData("key2", "trigger-key2")
.WithIdentity("trigger2", "group2")
.Build();
3、調度器
調度器就是將任務和觸發器綁定，讓觸發器觸發的時候去執行任務。
4、參數說明
-
SetJobData：設置JobData
-
StoreDurably：孤立存儲，指即使該JobDetail沒有關聯的Trigger，也會進行存儲
-
RequestRecovery：請求恢復，指應用崩潰后再次啟動，會重新執行該作業
-
WithIdentity：作業的唯一標識
-
WithDescription：作業的描述信息
除此之外，Quartz.Net還支持兩個非常有用的特性：
-
DisallowConcurrentExecution：禁止並行執行，該特性是針對JobDetail生效的
-
PersistJobDataAfterExecution：在執行完成后持久化JobData，該特性是針對Job類型生效的，意味着所有使用該Job的JobDetail都會在執行完成后持久化JobData。
四、示例
- 使用Vs2019創建Quartz.NET的示例 core web 項目
- 在NuGet包管理器引用Quartz.AspNetCore
- 在Startup文件中注入ISchedulerFactory的實例
public void ConfigureServices(IServiceCollection services) { services.AddControllersWithViews(); services.AddMvc(); services.AddSingleton<ISchedulerFactory, StdSchedulerFactory>();//注冊ISchedulerFactory的實例。 }
- 使用注入的服務
using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; using Quartz; using QuartzDemo.Models; using System.Threading.Tasks; namespace QuartzDemo.Controllers { public class HomeController : Controller {private readonly ISchedulerFactory _schedulerFactory; private IScheduler _scheduler; public HomeController(ISchedulerFactory schedulerFactory) { this._schedulerFactory = schedulerFactory; } public async Task<IActionResult> Index() { //通過調度工廠獲得調度器 _scheduler = await _schedulerFactory.GetScheduler(); //開啟調度器 await _scheduler.Start(); //創建一個觸發器 var trigger = TriggerBuilder.Create() .WithSimpleSchedule(x => x.WithIntervalInSeconds(2).RepeatForever())//每兩秒執行一次 .Build(); //創建任務 var jobDetail = JobBuilder.Create<MyJob>() .WithIdentity("job", "group") .Build(); //將觸發器和任務器綁定到調度器中 await _scheduler.ScheduleJob(jobDetail, trigger); return View(); } } }
using Quartz; using System; using System.IO; using System.Text; using System.Threading.Tasks; namespace QuartzDemo.Models { /// <summary> /// 創建IJob的實現類，並實現Excute方法 /// </summary> public class MyJob : IJob { public Task Execute(IJobExecutionContext context) { return Task.Run(() => { using (StreamWriter sw = new StreamWriter(@"C:\Users\lenovo\Desktop\1.txt", true, Encoding.UTF8)) { sw.WriteLine(DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss")); } }); } } }
執行結果：
五、傳參取參
上面這種執行的Job沒有參數，當需要參數可以通過下面兩種方法傳遞參數：
1、傳參方式一：在Trigger中添加參數值
//創建一個觸發器
var trigger = TriggerBuilder.Create()
.WithSimpleSchedule(x =>x.WithIntervalInSeconds(2).RepeatForever())//間隔2秒 一直執行
.UsingJobData("key1", 321) //通過在Trigger中添加參數值
.UsingJobData("key2", "123")
.WithIdentity("trigger", "group")
.Build();
2、傳參方式二：在Job中添加參數值
IJobDetail job = JobBuilder.Create<MyJob>() .UsingJobData("key1", 123)//通過Job添加參數值 .UsingJobData("key2", "123") .WithIdentity("job", "group") .Build();
3、取參：通過下面方法在Job中獲取參數值
using Quartz; using System; using System.IO; using System.Text; using System.Threading.Tasks; namespace QuartzDemo.Models { /// <summary> /// 創建IJob的實現類，並實現Excute方法 /// </summary> public class MyJob : IJob { public Task Execute(IJobExecutionContext context) { //var jobData = context.JobDetail.JobDataMap;//獲取Job中的參數 var triggerData = context.Trigger.JobDataMap;//獲取Trigger中的參數 var data = context.MergedJobDataMap;//獲取Job和Trigger中合並的參數 var value1 = triggerData.GetInt("key1"); var value2 = triggerData.GetString("key2"); return Task.Run(() => { using (StreamWriter sw = new StreamWriter(@"C:\Users\lenovo\Desktop\1.txt", true, Encoding.UTF8)) { sw.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss")}-{value1}-{value2}"); } }); } } }
當Job中的參數和Trigger中的參數名稱一樣時，用 context.MergedJobDataMap獲取參數時，Trigger中的值會覆蓋Job中的值。
4、上面那種情況只能適應參數值不變的情況。如每兩秒實現累加一操作，現在初始值是0，如果按照上面那種獲取值的操作，一直都是0+1，返回值一直都是1。為了滿足這個情況，只需要加一個特性[PersistJobDataAfterExecution]
[PersistJobDataAfterExecution]//更新JobDetail的JobDataMap的存儲副本，以便下一次執行這個任務接收更新的值而不是原始存儲的值 public class MyJob : IJob { public Task Execute(IJobExecutionContext context) { var jobData = context.JobDetail.JobDataMap; var triggerData = context.Trigger.JobDataMap; var data = context.MergedJobDataMap; var value1 = jobData.GetInt("key1"); var value2 = jobData.GetString("key2"); var value3 = data.GetString("key2"); var dateString = DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss"); Random random = new Random(); jobData["key1"] = random.Next(1, 20);//這里面給key賦值，下次再進來執行的時候，獲取的值為更新的值，而不是原始值 jobData["key2"] = dateString; return Task.Run(() => { using (StreamWriter sw = new StreamWriter(@"C:\Users\Administrator\Desktop\error.log", true, Encoding.UTF8)) { sw.WriteLine($"{dateString} value1:{value1} value2:{value2}"); } }); } }
六、總結
通過演示可以看出，要執行一個定時任務，一般需要四步：
- 創建任務調度器。調度器通常在應用程序啟動時創建，一個應用程序實例通常只需要一個調度器即可。
- 創建Job和JobDetail。Job是作業的類型，描述了作業是如何執行的，這個類是由我們定義的；JobDetail是Quartz對作業的封裝，它包含Job類型，以及Job在執行時用到的數據，還包括是否要持久化、是否覆蓋已存在的作業等選項。
- 創建觸發器。觸發器描述了在何時執行作業。
- 添加調度。當完成以上三步以后，就可以對作業進行調度了。