Quartz在.NET中的使用教程
一、背景
例如需要在某年某月去將數(shù)據(jù)庫的某個數(shù)據(jù)更新或者同步,又或者是每隔一段時間來執(zhí)行一部分代碼去調(diào)用接口,但是又不想人為的手動去執(zhí)行
針對此類業(yè)務(wù)可以使用"定時調(diào)用任務(wù)",市面上有很多的定時調(diào)度任務(wù)框架,甚至你可以使用定時器來結(jié)合Windows服務(wù)做一個簡易版的任務(wù)調(diào)度程序,此處我們學(xué)習(xí)Quartz,因為Quartz是一個強(qiáng)大、開源、輕量級的任務(wù)調(diào)度框架,支持cron-like表達(dá)式其他一些優(yōu)秀的特性。
二、Quartz
1.基本概念
Scheduler | Trigger | Job |
---|---|---|
調(diào)度器,quartz工作時的獨立容器 | 觸發(fā)器,定義了調(diào)度任務(wù)的時間規(guī)則 | 調(diào)用任務(wù)具體要執(zhí)行的動作的容器 |
2.初步使用
1.Nuget引入QuartZ程序集
2.創(chuàng)建一個Scheduler任務(wù)調(diào)度容器
3.指定具體執(zhí)行的任務(wù)Job和觸發(fā)器
4.把策略和任務(wù)放入到Scheduler并啟動
public class QuartzManager { public async static void Init() { StdSchedulerFactory factory = new StdSchedulerFactory(); //創(chuàng)建一個Scheduler任務(wù)調(diào)度容器 IScheduler scheduler = await factory.GetScheduler(); //指定具體執(zhí)行的任務(wù)Job IJobDetail sendEmailJob = JobBuilder.Create<SendMailJob>() .WithIdentity("sendEmailJob", "sendEmailJobGrop") .WithDescription("定時發(fā)送郵件").Build(); //設(shè)置觸發(fā)條件為五秒執(zhí)行一次 ITrigger sendEmailTrigger = TriggerBuilder.Create() .WithIdentity("sendEmailTrigger", "sendEmailJobGrop" .WithDescription("QuartZ") .WithCronSchedule("3/5 * * * * ?") .Build(); //把策略和任務(wù)放入到Scheduler await scheduler.ScheduleJob(sendEmailJob, sendEmailTrigger); //執(zhí)行任務(wù) await scheduler.Start(); } } //增加特性保證任務(wù)不會重疊執(zhí)行 [DisallowConcurrentExecution] public class SendMailJob : IJob { //Job類 public async Task Execute(IJobExecutionContext context) { await Task.Run(() => { //doSomthing Console.WriteLine($"開始發(fā)送郵件{DateTime.Now}"); }); } }
三、傳遞參數(shù)
有時候我們想在Job執(zhí)行時需要一些參數(shù),并根據(jù)這些參數(shù)來做一些邏輯處理,這時候就需要使用Quartz傳參了。
在Quartz中傳參主要有一些幾種方式
1.job傳參
2.Trigger傳參
1.job傳參和Trigger傳參
使用JobDataMap.Add添加參數(shù),在job內(nèi)部使用上下文的JobDataMap.GetString獲取
IJobDetail sendEmailJob = JobBuilder.Create<SendMailJob>().Build(); //往Job傳一個參數(shù) sendEmailJob.JobDataMap.Add("params","job測試傳參"); ITrigger trigger = TriggerBuilder.Create().Build(); //往trigger傳一個參數(shù) trigger.JobDataMap.Add("params", "trigger測試傳參"); //在job中獲取參數(shù) public async Task Execute(IJobExecutionContext context) { await Task.Run(() => { //獲取job傳參 string paramJob = context.JobDetail.JobDataMap.GetString("params"); //獲取Trigger傳參 string paramTrigger = context.Trigger.JobDataMap.GetString("params"); //doSomthing Console.WriteLine($"開始發(fā)送郵件{DateTime.Now}"); }); }
四、在scheduler中注冊監(jiān)聽器
監(jiān)聽器是為調(diào)度程序中發(fā)生的事件執(zhí)行操作而創(chuàng)建的對象,主要有一下三種監(jiān)聽器
1.調(diào)度監(jiān)聽器ISchedulerListener主要用于調(diào)度過程的監(jiān)聽。
2.觸發(fā)器監(jiān)聽器ITriggerListener主要用于接收和觸發(fā)器相關(guān)的事件監(jiān)聽。
3.作業(yè)監(jiān)聽器IJobListener用于接收J(rèn)ob運行生命周期相關(guān)事件監(jiān)聽。
1.實現(xiàn)監(jiān)聽器
以作業(yè)監(jiān)聽器為例,因為觸發(fā)和調(diào)度監(jiān)聽一樣的實現(xiàn)。
1.自定義作業(yè)監(jiān)聽器需要繼承自IJobListener接口并實現(xiàn)方法.
2.在調(diào)度器的監(jiān)聽管理中添加自定義監(jiān)聽器.
//實現(xiàn)監(jiān)聽器 public class CustomJobListener : IJobListener { public string Name => "CustomJobListener"; } //添加到監(jiān)聽管理中 scheduler.ListenerManager.AddJobListener(new CustomJobListener());
五、可視化管理界面
用于可視化工具來查看當(dāng)前運行Job的信息。
1.需要新建一個web項目或者控制臺項目。
2.在web項目中 Nuget 引入Quartz 和CrystalQuartz.Remote程序包
3.在Job調(diào)度中配置StdSchedulerFactory相關(guān)信息指定監(jiān)聽端口
var properties = new NameValueCollection(); properties["quartz.scheduler.instanceName"] = "Test Monitor System"; // 設(shè)置線程池 properties["quartz.threadPool.type"] = "Quartz.Simpl.SimpleThreadPool, Quartz"; properties["quartz.threadPool.threadCount"] = "5"; properties["quartz.threadPool.threadPriority"] = "Normal"; // 遠(yuǎn)程輸出配置 properties["quartz.scheduler.exporter.type"] = "Quartz.Simpl.RemotingSchedulerExporter, Quartz"; properties["quartz.scheduler.exporter.port"] = "8081"; properties["quartz.scheduler.exporter.bindName"] = "QuartzScheduler"; properties["quartz.scheduler.exporter.channelType"] = "tcp"; var schedulerFactory = new StdSchedulerFactory(properties); IScheduler _scheduler = await schedulerFactory.GetScheduler();
4.web監(jiān)控端去訪問統(tǒng)一的端口號下的CrystalQuartzPanel.axd即可查看。
六、配置文件配置任務(wù)
我們除了在代碼中定義任務(wù)的各種調(diào)度和觸發(fā)器之外,還可以使用xml配置文件的方式來創(chuàng)建Job任務(wù)
1.準(zhǔn)備配置文件,配置Job+trigger相關(guān)信息,一定要將此文件屬性設(shè)為"始終復(fù)制"
<?xml version="1.0" encoding="UTF-8"?> <job-scheduling-data xmlns="http://quartznet.sourceforge.net/JobSchedulingData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0"> <processing-directives> <overwrite-existing-data>true</overwrite-existing-data> </processing-directives> <schedule> <job> <name>sendEmailJob</name> <group>Test Mail Job</group> <description>This is Test Mail Job</description> <!--此處為Job所在的類,及程序集--> <job-type>DispatcherProject.Job.SendMailJob,DispatcherProject</job-type> <durable>true</durable> <recover>false</recover> </job> <trigger> <cron> <name>sendEmailTrigger</name> <group>sendEmailJobGrop</group> <job-name>sendEmailJob</job-name> <job-group>Test Mail Job</job-group> <cron-expression>5/3 * * * * ?</cron-expression> </cron> </trigger> </schedule> </job-scheduling-data>
2.讀取配置文件,獲取信息,生成對應(yīng)的Job和Trigger
XMLSchedulingDataProcessor processor = new XMLSchedulingDataProcessor(new SimpleTypeLoadHelper()); //讀取配置文件 await processor.ProcessFileAndScheduleJobs("~/config/quartz.xml", scheduler); //啟動調(diào)度任務(wù) await scheduler.Start();
到此這篇關(guān)于Quartz在.NET中的使用的文章就介紹到這了,更多相關(guān)Quartz .NET使用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
asp.net 上傳下載輸出二進(jìn)制流實現(xiàn)代碼
asp.net 上傳下載輸出二進(jìn)制流實現(xiàn)代碼,需要的朋友可以參考下。2009-12-12VB.NET設(shè)置屏幕分辨率、顏色位數(shù)、刷新率 實例代碼
這篇文章介紹了VB.NET設(shè)置屏幕分辨率、顏色位數(shù)、刷新率 實例代碼,有需要的朋友可以參考一下2013-07-07利用Timer在ASP.NET中實現(xiàn)計劃任務(wù)的方法
利用Timer在ASP.NET中實現(xiàn)計劃任務(wù)的方法...2007-04-04asp.net中日歷函數(shù)Calendar的使用方法
calendar 控件用于在瀏覽器中顯示日歷,該控件可顯示某個月的日歷,允許用戶選擇日期,也可以跳到前一個或下一個月2011-05-05Asp.net內(nèi)置對象之Server對象(概述及應(yīng)用)
Server對象提供對服務(wù)器上的方法和屬性的訪問以及進(jìn)行HTML編碼的功能,本文主要圍繞server對象介紹詳細(xì)功能及常用屬性和主要方法,感興趣的朋友可以了解下,或許對你學(xué)習(xí)server對象有所幫助2013-02-02asp.net ajaxControlToolkit FilteredTextBoxExtender的簡單用法
最近寫的東西驗證比較多,尤其是數(shù)字驗證,無意中發(fā)現(xiàn)這個控件,有點兒意思。記錄一下2008-11-11在.NET使用JSON作為數(shù)據(jù)交換格式實例演示
JSON(JavaScript Object Notation)是一種輕量級輕量級的數(shù)據(jù)交換格式,并且它獨立于編程語言,接下來為大家介紹下使用JSON作為數(shù)據(jù)交換格式在.net中的應(yīng)用2013-03-03