.NET6+Quartz實現定時任務的示例詳解
更新時間：2023年03月27日 11:16:42 作者：公子小六
在實際工作中，經常會有一些需要定時操作的業(yè)務，如：定時發(fā)郵件，定時統(tǒng)計信息等，那么如何實現才能使得我們的項目整齊劃一呢？本文通過一些簡單的小例子，簡述在.Net6+Quartz實現定時任務的一些基本操作，如有不足之處，還請指正
在實際工作中，經常會有一些需要定時操作的業(yè)務，如：定時發(fā)郵件，定時統(tǒng)計信息等內容，那么如何實現才能使得我們的項目整齊劃一呢？本文通過一些簡單的小例子，簡述在.Net6+Quartz實現定時任務的一些基本操作，及相關知識介紹，僅供學習分享使用，如有不足之處，還請指正。
什么是定時任務
定時任務，也叫任務調度，是指在一定的載體上，根據具體的觸發(fā)規(guī)則，執(zhí)行某些操作。所以定時任務需要滿足三個條件：載體（Scheduler），觸發(fā)規(guī)則（Trigger），具體業(yè)務操作（Job）。如下所示：
什么是Quartz
Quartz 是一個開源的作業(yè)調度框架，它完全由 Java 寫成，并設計用于 J2SE 和 J2EE 應用中。它提供了巨大的靈 活性而不犧牲簡單性。你能夠用它來為執(zhí)行一個作業(yè)而創(chuàng)建簡單的或復雜的調度。它有很多特征，如：數據庫支持，集群，插件，EJB 作業(yè)預構 建，JavaMail 及其它，支持 cron-like 表達式等等。雖然Quartz最初是為Java編寫的，但是目前已經有.Net版本的Quartz，所以在.Net中應用Quartz已經不再是奢望，而是輕而易舉的事情了。
Github上開源網址為：https://github.com/quartznet
關于Quartz的快速入門和API文檔，可以參考：https://www.quartz-scheduler.net/documentation/quartz-3.x/quick-start.html
涉及知識點
在Quartz框架中，主要接口和API如下所示：
其中IScheduler，ITrigger , IJob 三者之間的關系，如下所示：
Quartz安裝
為了方便，本示例創(chuàng)建一個基于.Net6.0的控制臺應用程序，在VS2022中，通過Nuget包管理器進行安裝，如下所示：
創(chuàng)建一個簡單的定時器任務
要開發(fā)一個簡單，完整且能運行的定時器任務，步驟如下所示：
1. 創(chuàng)建工作單元Job
創(chuàng)建任務需要實現IJob接口，如下所示：
using Quartz;
using System.Diagnostics;
namespace DemoQuartz.QuartzA.Job
{
/// <summary>
/// 測試任務，實現IJob接口
/// </summary>
public class TestJob : IJob
{
public TestJob()
{
Console.WriteLine("執(zhí)行構造函數");//表示每一次計劃執(zhí)行，都是一次新的實例
}
public Task Execute(IJobExecutionContext context)
{
return Task.Run(() =>
{
Console.WriteLine($"******************************");
Console.WriteLine($"測試信息{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff")}");
Console.WriteLine($"******************************");
Console.WriteLine();
});
}
}
}2. 創(chuàng)建時間軸Scheduler
時間軸也是任務執(zhí)行的載體，可以通過StdSchedulerFactory進行獲取，如下所示：
//創(chuàng)建計劃單元（時間軸，載體） StdSchedulerFactory schedulerFactory = new StdSchedulerFactory(); var scheduler = await schedulerFactory.GetScheduler(); await scheduler.Start();
3. 創(chuàng)建觸發(fā)規(guī)則Trigger
觸發(fā)規(guī)則就是那些時間點執(zhí)行任務，可通過TriggerBuilder進行構建，如下所示：
//Trigger時間觸發(fā)機制
var trigger = TriggerBuilder.Create()
.WithIdentity("TestTrigger","TestGroup")
//.StartNow() //立即執(zhí)行
.WithSimpleSchedule(w=>w.WithIntervalInSeconds(5).WithRepeatCount(5))//.RepeatForever()//無限循環(huán)
//.WithCronSchedule("5/10 * * * * ?") //通過Cron表達式定制時間觸發(fā)規(guī)則, 示例表示從5開始，每隔10秒一次
.Build();4. 創(chuàng)建任務描述
任務描述定義了具體的任務名稱，分組等內容。可通過JobBuilder進行構建，如下所示：
//Job詳細描述
var jobDetail = JobBuilder.Create<TestJob>()
.WithDescription("這是一個測試Job")
.WithIdentity("TestJob", "TestGroup")
.Build();5. 建立三者聯系
通過載體，將規(guī)則和工作單元串聯起來，如下所示：
//把時間和任務通過載體關聯起來 await scheduler.ScheduleJob(jobDetail, trigger);
6. 簡單示例測試
通過運行程序，示例結果如下所示：
傳遞參數
在Quartz框架下，如果需要給執(zhí)行的Job傳遞參數，可以通過兩種方式：
jobDetail.JobDataMap，工作描述時通過JobDataMap傳遞參數。
trigger.JobDataMap, 時間觸發(fā)時通過JobDataMap傳遞參數。
在Job工作單元中，可以通過Context中對應的JobDataMap獲取參數。
傳遞參數，如下所示：
//傳遞參數
jobDetail.JobDataMap.Add("name", "Alan");
jobDetail.JobDataMap.Add("age", 20);
jobDetail.JobDataMap.Add("sex", true);
//trigger同樣可以傳遞參數
trigger.JobDataMap.Add("like1", "meimei");
trigger.JobDataMap.Add("like2", "football");
trigger.JobDataMap.Add("like3", "sing");獲取參數，如下所示：
//獲取參數
var name = context.JobDetail.JobDataMap.GetString("name");
var age = context.JobDetail.JobDataMap.GetInt("age");
var sex = context.JobDetail.JobDataMap.GetBoolean("sex") ? "男" : "女";
var like1 = context.Trigger.JobDataMap.GetString("like1");
var like2 = context.Trigger.JobDataMap.GetString("like2");
var like3 = context.Trigger.JobDataMap.GetString("like3");
//context.MergedJobDataMap.GetString("aa");//注意如果使用MergedJobDataMap，JobDetail和Trigger中用到相同的Key，則后面設置的會覆蓋前面設置的。注意：如果使用MergedJobDataMap，JobDetail和Trigger中用到相同的Key，則后面設置的會覆蓋前面設置的。
任務特性
假如我們的定時任務，執(zhí)行一次需要耗時比較久，而且后一次執(zhí)行需要等待前一次完成，并且需要前一次執(zhí)行的結果作為參考，那么就需要設置任務的任性。因為默認情況下，工作單元在每一次運行都是一個新的實例，相互之間獨立運行，互不干擾。所以如果需要存在一定的關聯，就要設置任務的特性，主要有兩個，如下所示：
- [PersistJobDataAfterExecution]//在執(zhí)行完成后，保留JobDataMap數據
- [DisallowConcurrentExecution]//不允許并發(fā)執(zhí)行，即必須等待上次完成后才能執(zhí)行下一次
以上兩個特性，只需要標記在任務對應的類上即可。標記上后，只需要往對應的JobDataMap中添加值即可。
監(jiān)聽器
在Quartz框架下，有三種監(jiān)聽器，分別是：時間軸監(jiān)聽器ISchedulerListener，觸發(fā)規(guī)則監(jiān)聽器ITriggerListener，任務監(jiān)聽器IJobListener。要實現對應監(jiān)聽器，實現對應接口即可。實現監(jiān)聽器步驟：
1. 創(chuàng)建監(jiān)聽器
根據不同的需要，可以創(chuàng)建不同的監(jiān)聽器，如下所示：
時間軸監(jiān)聽器SchedulerListener
public class TestSchedulerListener : ISchedulerListener
{
public Task JobAdded(IJobDetail jobDetail, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Job is added.");
});
}
public Task JobDeleted(JobKey jobKey, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Job is deleted.");
});
}
public Task JobInterrupted(JobKey jobKey, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Job is Interrupted.");
});
}
public Task JobPaused(JobKey jobKey, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Job is paused.");
});
}
public Task JobResumed(JobKey jobKey, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Job is resumed.");
});
}
public Task JobScheduled(ITrigger trigger, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Job is scheduled.");
});
}
public Task JobsPaused(string jobGroup, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Jobs is paused.");
});
}
public Task JobsResumed(string jobGroup, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Jobs is resumed.");
});
}
public Task JobUnscheduled(TriggerKey triggerKey, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test Jobs is un schedulered.");
});
}
public Task SchedulerError(string msg, SchedulerException cause, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test scheduler is error.");
});
}
public Task SchedulerInStandbyMode(CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test scheduler is standby mode.");
});
}
public Task SchedulerShutdown(CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test scheduler is shut down.");
});
}
public Task SchedulerShuttingdown(CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test scheduler is shutting down.");
});
}
public Task SchedulerStarted(CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test scheduleer is started.");
});
}
public Task SchedulerStarting(CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test scheduler is starting.");
});
}
public Task SchedulingDataCleared(CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test scheduling is cleared.");
});
}
public Task TriggerFinalized(ITrigger trigger, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test trigger is finalized.");
});
}
public Task TriggerPaused(TriggerKey triggerKey, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test trigger is paused.");
});
}
public Task TriggerResumed(TriggerKey triggerKey, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test trigger is resumed.");
});
}
public Task TriggersPaused(string? triggerGroup, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test triggers is paused.");
});
}
public Task TriggersResumed(string? triggerGroup, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test triggers is resumed.");
});
}
}觸發(fā)規(guī)則監(jiān)聽器TriggerListener
/// <summary>
/// 觸發(fā)器監(jiān)聽
/// </summary>
public class TestTriggerListener : ITriggerListener
{
public string Name => "TestTriggerListener";
public Task TriggerComplete(ITrigger trigger, IJobExecutionContext context, SchedulerInstruction triggerInstructionCode, CancellationToken cancellationToken = default)
{
//任務完成
return Task.Run(() => {
Console.WriteLine("Test trigger is complete.");
});
}
public Task TriggerFired(ITrigger trigger, IJobExecutionContext context, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test trigger is fired.");
});
}
public Task TriggerMisfired(ITrigger trigger, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test trigger is misfired.");
});
}
public Task<bool> VetoJobExecution(ITrigger trigger, IJobExecutionContext context, CancellationToken cancellationToken = default)
{
return Task.Run(() => {
Console.WriteLine("Test trigger is veto.");
return false;//是否終止
});
}
}JobListener任務監(jiān)聽器
/// <summary>
/// TestJob監(jiān)聽器
/// </summary>
public class TestJobListener : IJobListener
{
public string Name => "TestJobListener";
public Task JobExecutionVetoed(IJobExecutionContext context, CancellationToken cancellationToken = default)
{
//任務被終止時
return Task.Run(() => {
Console.WriteLine("Test Job is vetoed.");
});
}
public Task JobToBeExecuted(IJobExecutionContext context, CancellationToken cancellationToken = default)
{
//任務被執(zhí)行時
return Task.Run(() => {
Console.WriteLine("Test Job is to be executed.");
});
}
public Task JobWasExecuted(IJobExecutionContext context, JobExecutionException? jobException, CancellationToken cancellationToken = default)
{
//任務已經執(zhí)行
return Task.Run(() => {
Console.WriteLine("Test Job was executed.");
});
}
}2. 添加監(jiān)聽
在時間軸上的監(jiān)聽管理器中進行添加，如下所示：
//增加監(jiān)聽 scheduler.ListenerManager.AddJobListener(new TestJobListener()); scheduler.ListenerManager.AddTriggerListener(new TestTriggerListener()); scheduler.ListenerManager.AddSchedulerListener(new TestSchedulerListener());
日志管理
在Quartz框架中，創(chuàng)建之前會進行日志創(chuàng)建檢測，所以如果需要獲取框架中的日志信息，可以進行創(chuàng)建實現ILogProvider，如下所示：
public class TestLogProvider : ILogProvider
{
public Logger GetLogger(string name)
{
return (level, func, exception, parameters) =>
{
if (level >= Quartz.Logging.LogLevel.Info && func != null)
{
Console.WriteLine("[" + DateTime.Now.ToLongTimeString() + "] [" + level + "] " + func(), parameters);
}
return true;
};
}
public IDisposable OpenMappedContext(string key, object value, bool destructure = false)
{
throw new NotImplementedException();
}
public IDisposable OpenNestedContext(string message)
{
throw new NotImplementedException();
}
}然后在當前的Scheduler中，添加日志即可，如下所示：
//日志 LogProvider.SetCurrentLogProvider(new TestLogProvider());
完整示例
在添加了監(jiān)聽器，日志，參數傳遞，任務特性后，完整的目錄結構，如下所示：
示例截圖
到此這篇關于.NET6+Quartz實現定時任務的示例詳解的文章就介紹到這了,更多相關.NET6 Quartz定時任務內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
本篇文章主要介紹了ASP.NET Web API從注釋自動生成幫助文檔的方法，功能很是強大，現與大家分享一下,需要的朋友可以參考下2015-07-07
這篇文章主要為大家詳細介紹了ASP.NET中如何實現回調操作，感興趣的小伙伴們可以參考一下2016-04-04
這篇文章主要為大家詳細解析了微信公眾平臺開發(fā)之處理圖片.Net代碼，感興趣的小伙伴們可以參考一下2016-06-06
asp.net基于替換模版頁的形式生成靜態(tài)頁的方法
這篇文章主要介紹了asp.net基于替換模版頁的形式生成靜態(tài)頁的方法,涉及asp.net模板的設置、變量替換、配置文件設置與讀取、以及文件夾與靜態(tài)文件的創(chuàng)建等技巧,需要的朋友可以參考下2016-07-07
如何在.NET Core中為gRPC服務設計消息文件（Proto）
這篇文章主要介紹了如何在.NET Core中為gRPC服務設計消息文件（Proto），幫助大家更好的理解和學習使用.net技術，感興趣的朋友可以了解下2021-05-05
本文介紹了如何使用.NET創(chuàng)建新的WPF應用,并向窗口添加控件,通過處理控件事件,可以為應用提供功能,感興趣的朋友跟隨小編一起看看吧2024-11-11
剛到一家新公司，領導下發(fā)任務要用cs系統(tǒng)做一個表格折疊顯示，這真是把我難倒了，自己工作6年一直以來都是做BS的系統(tǒng)，于是上網搜了相關視頻，資料，開始學習起來，下面小編把WinForm中DataGridView折疊控件的知識分享給大家，供大家參考2016-05-05
這篇文章主要介紹了如何使用ASP.NET?Core配置文件，文章圍繞主題展開詳細的內容介紹，具有一定的參考一下，需要的小伙伴可以參考一下2022-09-09
下面小編就為大家分享一篇.net WINFORM的GDI雙緩沖的實現方法，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2017-12-12
asp.net下用DataSet生成XML的問題...2007-04-04