.Net Core中使用Quartz.Net實踐記錄
一、介紹
Quartz.NET是一個強大、開源、輕量的作業(yè)調度框架,是 OpenSymphony 的 Quartz API 的.NET移植,用C#改寫,可用于winform和asp.net應用中。它靈活而不復雜。你能夠用它來為執(zhí)行一個作業(yè)而創(chuàng)建簡單的或復雜的作業(yè)調度。它有很多特征,如:數(shù)據庫支持,集群,插件,支持cron-like表達式等等。
通俗說它的功能是:比如說我想每天晚上2點讓程序或網站執(zhí)行某些代碼,或者每隔5秒種我想查看是否有新的任務要處理等。
Quartz.Net是根據Java的Quartz用C#改寫而來,最新的版本是3.0.6,源碼在https://github.com/quartznet/quartznet (本地下載)。
實踐教程
以WebApi項目舉例,用VS腳手架功能新建WebApi項目。
public void ConfigureServices(IServiceCollection services) { services.AddMvc(); services.AddSingleton<ISchedulerFactory, StdSchedulerFactory>();//注冊ISchedulerFactory的實例。 }
[Route("api/[controller]")] public class ValuesController : Controller { private readonly ISchedulerFactory _schedulerFactory; private IScheduler _scheduler; public ValuesController(ISchedulerFactory schedulerFactory) { this._schedulerFactory = schedulerFactory; } [HttpGet] public async Task<string[]> Get() { //1、通過調度工廠獲得調度器 _scheduler = await _schedulerFactory.GetScheduler(); //2、開啟調度器 await _scheduler.Start(); //3、創(chuàng)建一個觸發(fā)器 var trigger = TriggerBuilder.Create() .WithSimpleSchedule(x => x.WithIntervalInSeconds(2).RepeatForever())//每兩秒執(zhí)行一次 .Build(); //4、創(chuàng)建任務 var jobDetail = JobBuilder.Create<MyJob>() .WithIdentity("job", "group") .Build(); //5、將觸發(fā)器和任務器綁定到調度器中 await _scheduler.ScheduleJob(jobDetail, trigger); return await Task.FromResult(new string[] { "value1", "value2" }); } }
public class MyJob : IJob//創(chuàng)建IJob的實現(xiàn)類,并實現(xiàn)Excute方法。 { public Task Execute(IJobExecutionContext context) { return Task.Run(() => { using (StreamWriter sw = new StreamWriter(@"C:\Users\Administrator\Desktop\error.log", true, Encoding.UTF8)) { sw.WriteLine(DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss")); } }); } }
輸出的結果:
2018-08-03 00-03-19
2018-08-03 00-03-20
2018-08-03 00-03-22
2018-08-03 00-03-24
2018-08-03 00-03-26
上面這種執(zhí)行的Job沒有參數(shù),當需要參數(shù)可以通過下面兩種方法傳遞參數(shù):
1、在Trigger中添加參數(shù)值
var trigger3 = TriggerBuilder.Create() .WithSimpleSchedule(x =>x.WithIntervalInSeconds(2).RepeatForever())//間隔2秒 一直執(zhí)行 .UsingJobData("key1", 321) //通過在Trigger中添加參數(shù)值 .UsingJobData("key2", "123") .WithIdentity("trigger2", "group1") .Build();
2、在Job中添加參數(shù)值
IJobDetail job = JobBuilder.Create<MyJob>() .UsingJobData("key1", 123)//通過Job添加參數(shù)值 .UsingJobData("key2", "123") .WithIdentity("job1", "group1") .Build();
通過下面方法在Job中獲取參數(shù)值
public class MyJob : IJob { public Task Execute(IJobExecutionContext context) { var jobData = context.JobDetail.JobDataMap;//獲取Job中的參數(shù) var triggerData = context.Trigger.JobDataMap;//獲取Trigger中的參數(shù) var data = context.MergedJobDataMap;//獲取Job和Trigger中合并的參數(shù) var value1= jobData.GetInt("key1"); var value2= jobData.GetString("key2"); var dateString = DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss");return Task.Run(() => { using (StreamWriter sw = new StreamWriter(@"C:\Users\Administrator\Desktop\error.log", true, Encoding.UTF8)) { sw.WriteLine(dateString); } }); } }
當Job中的參數(shù)和Trigger中的參數(shù)名稱一樣時,用 context.MergedJobDataMap獲取參數(shù)時,Trigger中的值會覆蓋Job中的值。
3、上面那種情況只能適應那種,參數(shù)值不變的情況。
假如有這種情況,這次的參數(shù)值是上一次執(zhí)行后計算的值,就不能使用上面方法了。如 每兩秒實現(xiàn)累加一操作,現(xiàn)在初始值是0,如果按照上面那種獲取值的操作,一直都是0+1,返回值一直都是1。為了滿足這個情況,只需要加一個特性[PersistJobDataAfterExecution]。
[PersistJobDataAfterExecution]//更新JobDetail的JobDataMap的存儲副本,以便下一次執(zhí)行這個任務接收更新的值而不是原始存儲的值 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賦值,下次再進來執(zhí)行的時候,獲取的值為更新的值,而不是原始值 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}"); } //context.Scheduler.DeleteJob(context.JobDetail.Key); //context.Scheduler.Shutdown(); }); } }
三、Quartz.Net組成
Quartz主要有三部分組成任務(Job)、觸發(fā)器(Trigger)和調度器(Schedule)。
3.1 任務
Job就是執(zhí)行的作業(yè),Job需要繼承IJob接口,實現(xiàn)Execute方法。Job中執(zhí)行的參數(shù)從Execute方法的參數(shù)中獲取。
3.2 觸發(fā)器
觸發(fā)器常用的有兩種:SimpleTrigger觸發(fā)器和CronTrigger觸發(fā)器。
SimpleTrigger:能是實現(xiàn)簡單業(yè)務,如每隔幾分鐘,幾小時觸發(fā)執(zhí)行,并限制執(zhí)行次數(shù)。
var trigger = TriggerBuilder.Create() .WithSimpleSchedule(x => x.WithIntervalInSeconds(2).WithRepeatCount(5))//間隔2秒 執(zhí)行6次 .UsingJobData("key1", 321) .WithIdentity("trigger", "group") .Build();
CronTrigger:Cron表達式包含7個字段,秒 分 時 月內日期 月 周內日期 年(可選)。
舉例:
var trigger = TriggerBuilder.Create() .WithCronSchedule("0 0 0 1 1 ?")// 每年元旦1月1日 0 點觸發(fā) .UsingJobData("key1", 321) .UsingJobData("key2", "trigger-key2") .WithIdentity("trigger4", "group14") .Build();
"0 15 10 * * ? *" 每天上午10:15觸發(fā)
"0 0-5 14 * * ?" 每天下午2點到下午2:05期間的每1分鐘觸發(fā)
3.3 調度器
調度器就是將任務和觸發(fā)器綁定,讓觸發(fā)器觸發(fā)的時候去執(zhí)行任務。
總結
以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關文章
如何利用HttpClientFactory實現(xiàn)簡單的熔斷降級
這篇文章主要給大家介紹了關于如何利用HttpClientFactory實現(xiàn)簡單的熔斷降級的相關資料,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2018-07-07如何在ASP.NET Core 的任意類中注入Configuration
這篇文章主要介紹了如何在 ASP.NET Core 的任意類中注入Configuration ,幫助大家更好的理解和學習使用.net技術,感興趣的朋友可以了解下2021-04-04ASP.NETCore6開啟文件服務允許通過url訪問附件的操作方法
最近在做一個工作臺的文件上傳下載功能,主要想實現(xiàn)上傳圖片之后,可以通過url直接訪問,由于url直接訪問文件不安全,所以需要手動開啟文件服務,這篇文章主要介紹了ASP.NETCore6開啟文件服務允許通過url訪問附件,需要的朋友可以參考下2023-11-11asp.net下用Aspose.Words for .NET動態(tài)生成word文檔中的數(shù)據表格的方法
導出word 文檔,要求這個文檔的格式不是固定的,用戶可以隨便的調整,導出內容中的數(shù)據表格列是動態(tài)的,例如要求導出姓名和性別,你就要導出這兩列的數(shù)據,而且這個文檔不是導出來之后再調整而是導出來后已經是調整過了的。2010-04-04淺析Repeater控件的使用 (原樣導出和動態(tài)顯示/隱藏Repeater中的列)
本文主要介紹了淺析Repeater控件的使用 (原樣導出和動態(tài)顯示/隱藏Repeater中的列)的具體方法,需要的朋友可以看下2016-12-12