Quartz在.NET中的使用教程
一、背景
例如需要在某年某月去將數(shù)據(jù)庫(kù)的某個(gè)數(shù)據(jù)更新或者同步,又或者是每隔一段時(shí)間來(lái)執(zhí)行一部分代碼去調(diào)用接口,但是又不想人為的手動(dòng)去執(zhí)行
針對(duì)此類(lèi)業(yè)務(wù)可以使用"定時(shí)調(diào)用任務(wù)",市面上有很多的定時(shí)調(diào)度任務(wù)框架,甚至你可以使用定時(shí)器來(lái)結(jié)合Windows服務(wù)做一個(gè)簡(jiǎn)易版的任務(wù)調(diào)度程序,此處我們學(xué)習(xí)Quartz,因?yàn)镼uartz是一個(gè)強(qiáng)大、開(kāi)源、輕量級(jí)的任務(wù)調(diào)度框架,支持cron-like表達(dá)式其他一些優(yōu)秀的特性。
二、Quartz
1.基本概念
| Scheduler | Trigger | Job |
|---|---|---|
| 調(diào)度器,quartz工作時(shí)的獨(dú)立容器 | 觸發(fā)器,定義了調(diào)度任務(wù)的時(shí)間規(guī)則 | 調(diào)用任務(wù)具體要執(zhí)行的動(dòng)作的容器 |
2.初步使用
1.Nuget引入QuartZ程序集
2.創(chuàng)建一個(gè)Scheduler任務(wù)調(diào)度容器
3.指定具體執(zhí)行的任務(wù)Job和觸發(fā)器
4.把策略和任務(wù)放入到Scheduler并啟動(dòng)
public class QuartzManager
{
public async static void Init()
{
StdSchedulerFactory factory = new StdSchedulerFactory();
//創(chuàng)建一個(gè)Scheduler任務(wù)調(diào)度容器
IScheduler scheduler = await factory.GetScheduler();
//指定具體執(zhí)行的任務(wù)Job
IJobDetail sendEmailJob = JobBuilder.Create<SendMailJob>()
.WithIdentity("sendEmailJob", "sendEmailJobGrop")
.WithDescription("定時(shí)發(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ù)不會(huì)重疊執(zhí)行
[DisallowConcurrentExecution]
public class SendMailJob : IJob
{
//Job類(lèi)
public async Task Execute(IJobExecutionContext context)
{
await Task.Run(() =>
{
//doSomthing
Console.WriteLine($"開(kāi)始發(fā)送郵件{DateTime.Now}");
});
}
}
三、傳遞參數(shù)
有時(shí)候我們想在Job執(zhí)行時(shí)需要一些參數(shù),并根據(jù)這些參數(shù)來(lái)做一些邏輯處理,這時(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傳一個(gè)參數(shù)
sendEmailJob.JobDataMap.Add("params","job測(cè)試傳參");
ITrigger trigger = TriggerBuilder.Create().Build();
//往trigger傳一個(gè)參數(shù)
trigger.JobDataMap.Add("params", "trigger測(cè)試傳參");
//在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($"開(kāi)始發(fā)送郵件{DateTime.Now}");
});
}
四、在scheduler中注冊(cè)監(jiān)聽(tīng)器
監(jiān)聽(tīng)器是為調(diào)度程序中發(fā)生的事件執(zhí)行操作而創(chuàng)建的對(duì)象,主要有一下三種監(jiān)聽(tīng)器
1.調(diào)度監(jiān)聽(tīng)器ISchedulerListener主要用于調(diào)度過(guò)程的監(jiān)聽(tīng)。
2.觸發(fā)器監(jiān)聽(tīng)器ITriggerListener主要用于接收和觸發(fā)器相關(guān)的事件監(jiān)聽(tīng)。
3.作業(yè)監(jiān)聽(tīng)器IJobListener用于接收J(rèn)ob運(yùn)行生命周期相關(guān)事件監(jiān)聽(tīng)。
1.實(shí)現(xiàn)監(jiān)聽(tīng)器
以作業(yè)監(jiān)聽(tīng)器為例,因?yàn)橛|發(fā)和調(diào)度監(jiān)聽(tīng)一樣的實(shí)現(xiàn)。
1.自定義作業(yè)監(jiān)聽(tīng)器需要繼承自IJobListener接口并實(shí)現(xiàn)方法.
2.在調(diào)度器的監(jiān)聽(tīng)管理中添加自定義監(jiān)聽(tīng)器.
//實(shí)現(xiàn)監(jiān)聽(tīng)器
public class CustomJobListener : IJobListener
{
public string Name => "CustomJobListener";
}
//添加到監(jiān)聽(tīng)管理中
scheduler.ListenerManager.AddJobListener(new CustomJobListener());
五、可視化管理界面
用于可視化工具來(lái)查看當(dāng)前運(yùn)行Job的信息。
1.需要新建一個(gè)web項(xiàng)目或者控制臺(tái)項(xiàng)目。
2.在web項(xiàng)目中 Nuget 引入Quartz 和CrystalQuartz.Remote程序包
3.在Job調(diào)度中配置StdSchedulerFactory相關(guān)信息指定監(jiān)聽(tīng)端口
var properties = new NameValueCollection(); properties["quartz.scheduler.instanceName"] = "Test Monitor System"; // 設(shè)置線(xiàn)程池 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)控端去訪問(wèn)統(tǒng)一的端口號(hào)下的CrystalQuartzPanel.axd即可查看。

六、配置文件配置任務(wù)
我們除了在代碼中定義任務(wù)的各種調(diào)度和觸發(fā)器之外,還可以使用xml配置文件的方式來(lái)創(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所在的類(lèi),及程序集-->
<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.讀取配置文件,獲取信息,生成對(duì)應(yīng)的Job和Trigger
XMLSchedulingDataProcessor processor = new XMLSchedulingDataProcessor(new SimpleTypeLoadHelper());
//讀取配置文件
await processor.ProcessFileAndScheduleJobs("~/config/quartz.xml", scheduler);
//啟動(dòng)調(diào)度任務(wù)
await scheduler.Start();
到此這篇關(guān)于Quartz在.NET中的使用的文章就介紹到這了,更多相關(guān)Quartz .NET使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Asp.net mvc實(shí)時(shí)生成縮率圖到硬盤(pán)
這篇文章主要介紹了Asp.net mvc實(shí)時(shí)生成縮率圖到硬盤(pán)的相關(guān)資料,需要的朋友可以參考下2016-05-05
.Net 調(diào)用存儲(chǔ)過(guò)程取到return的返回值
存儲(chǔ)過(guò)程只能返回 int 類(lèi)型,如果返回一個(gè)字符串 ,將會(huì)報(bào)類(lèi)型轉(zhuǎn)化錯(cuò)誤,下面以示例介紹下如何取到return的值,需要的朋友可以參考下2014-08-08
.NET通過(guò)字典給類(lèi)賦值實(shí)現(xiàn)代碼
這篇文章主要介紹了.NET通過(guò)字典給類(lèi)賦值實(shí)現(xiàn)代碼,代碼簡(jiǎn)單易懂,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-09-09
.net MVC使用Session驗(yàn)證用戶(hù)登錄(4)
這篇文章主要為大家詳細(xì)介紹了.net MVC使用Session驗(yàn)證用戶(hù)登錄的相關(guān)資料,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-04-04
.net mvc超過(guò)了最大請(qǐng)求長(zhǎng)度的解決方法
這篇文章主要為大家詳細(xì)介紹了.net mvc超過(guò)了最大請(qǐng)求長(zhǎng)度的解決方法,限制文件上傳大小,感興趣的小伙伴們可以參考一下2016-07-07
.net core webapi jwt 更為清爽的認(rèn)證詳解
這篇文章主要介紹了.net core webapi jwt 更為清爽的認(rèn)證詳解,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2019-05-05
asp.net DataGrid控件中彈出詳細(xì)信息窗口
在DataGrid控件里單擊某一行的超級(jí)鏈接時(shí),彈出一個(gè)新的頁(yè)面顯示出該行的詳細(xì)信息2008-12-12
asp.net實(shí)現(xiàn)多個(gè)文件同時(shí)下載功能
這篇文章主要為大家詳細(xì)介紹了asp.net實(shí)現(xiàn)多個(gè)文件同時(shí)下載功能,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-04-04

