目錄

• 什么是定時任務(wù)
• 什么是Quartz
• 涉及知識點
• Quartz安裝
• 創(chuàng)建一個簡單的定時器任務(wù)
• 1. 創(chuàng)建工作單元Job
• 2. 創(chuàng)建時間軸Scheduler
• 3. 創(chuàng)建觸發(fā)規(guī)則Trigger
• 4. 創(chuàng)建任務(wù)描述
• 5. 建立三者聯(lián)系
• 6. 簡單示例測試
• 傳遞參數(shù)
• 任務(wù)特性
• 監(jiān)聽器
• 1. 創(chuàng)建監(jiān)聽器
• 2. 添加監(jiān)聽
• 日志管理
• 完整示例

在實際工作中，經(jīng)常會有一些需要定時操作的業(yè)務(wù)，如：定時發(fā)郵件，定時統(tǒng)計信息等內(nèi)容，那么如何實現(xiàn)才能使得我們的項目整齊劃一呢？本文通過一些簡單的小例子，簡述在.Net6+Quartz實現(xiàn)定時任務(wù)的一些基本操作，及相關(guān)知識介紹，僅供學習分享使用，如有不足之處，還請指正。

什么是定時任務(wù)

定時任務(wù)，也叫任務(wù)調(diào)度，是指在一定的載體上，根據(jù)具體的觸發(fā)規(guī)則，執(zhí)行某些操作。所以定時任務(wù)需要滿足三個條件：載體（Scheduler），觸發(fā)規(guī)則（Trigger），具體業(yè)務(wù)操作（Job）。如下所示：

什么是Quartz

Quartz 是一個開源的作業(yè)調(diào)度框架，它完全由 Java 寫成，并設(shè)計用于 J2SE 和 J2EE 應(yīng)用中。它提供了巨大的靈 活性而不犧牲簡單性。你能夠用它來為執(zhí)行一個作業(yè)而創(chuàng)建簡單的或復雜的調(diào)度。它有很多特征，如：數(shù)據(jù)庫支持，集群，插件，EJB 作業(yè)預構(gòu) 建，JavaMail 及其它，支持 cron-like 表達式等等。雖然Quartz最初是為Java編寫的，但是目前已經(jīng)有.Net版本的Quartz，所以在.Net中應(yīng)用Quartz已經(jīng)不再是奢望，而是輕而易舉的事情了。

Github上開源網(wǎng)址為：https://github.com/quartznet

關(guān)于Quartz的快速入門和API文檔，可以參考：https://www.quartz-scheduler.net/documentation/quartz-3.x/quick-start.html

涉及知識點

在Quartz框架中，主要接口和API如下所示：

其中IScheduler，ITrigger , IJob 三者之間的關(guān)系，如下所示：

Quartz安裝

為了方便，本示例創(chuàng)建一個基于.Net6.0的控制臺應(yīng)用程序，在VS2022中，通過Nuget包管理器進行安裝，如下所示：

創(chuàng)建一個簡單的定時器任務(wù)

要開發(fā)一個簡單，完整且能運行的定時器任務(wù)，步驟如下所示：

1. 創(chuàng)建工作單元Job

創(chuàng)建任務(wù)需要實現(xiàn)IJob接口，如下所示：

using Quartz;using System.Diagnostics;namespace DemoQuartz.QuartzA.Job{    /// <summary>    /// 測試任務(wù)，實現(xiàn)IJob接口    /// </summary>    public class TestJob : IJob    {public TestJob(){    Console.WriteLine("執(zhí)行構(gòu)造函數(shù)");//表示每一次計劃執(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

時間軸也是任務(wù)執(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í)行任務(wù)，可通過TriggerBuilder進行構(gòu)建，如下所示：

//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)建任務(wù)描述

任務(wù)描述定義了具體的任務(wù)名稱，分組等內(nèi)容?？赏ㄟ^JobBuilder進行構(gòu)建，如下所示：

//Job詳細描述 var jobDetail = JobBuilder.Create<TestJob>()     .WithDescription("這是一個測試Job")     .WithIdentity("TestJob", "TestGroup")     .Build();

5. 建立三者聯(lián)系

通過載體，將規(guī)則和工作單元串聯(lián)起來，如下所示：

 //把時間和任務(wù)通過載體關(guān)聯(lián)起來 await scheduler.ScheduleJob(jobDetail, trigger);

6. 簡單示例測試

通過運行程序，示例結(jié)果如下所示：

傳遞參數(shù)

在Quartz框架下，如果需要給執(zhí)行的Job傳遞參數(shù)，可以通過兩種方式：

jobDetail.JobDataMap，工作描述時通過JobDataMap傳遞參數(shù)。

trigger.JobDataMap, 時間觸發(fā)時通過JobDataMap傳遞參數(shù)。

在Job工作單元中，可以通過Context中對應(yīng)的JobDataMap獲取參數(shù)。

傳遞參數(shù)，如下所示：

//傳遞參數(shù)jobDetail.JobDataMap.Add("name", "Alan");jobDetail.JobDataMap.Add("age", 20);jobDetail.JobDataMap.Add("sex", true);//trigger同樣可以傳遞參數(shù)trigger.JobDataMap.Add("like1", "meimei");trigger.JobDataMap.Add("like2", "football");trigger.JobDataMap.Add("like3", "sing");

獲取參數(shù)，如下所示：

//獲取參數(shù)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，則后面設(shè)置的會覆蓋前面設(shè)置的。

注意：如果使用MergedJobDataMap，JobDetail和Trigger中用到相同的Key，則后面設(shè)置的會覆蓋前面設(shè)置的。

任務(wù)特性

假如我們的定時任務(wù)，執(zhí)行一次需要耗時比較久，而且后一次執(zhí)行需要等待前一次完成，并且需要前一次執(zhí)行的結(jié)果作為參考，那么就需要設(shè)置任務(wù)的任性。因為默認情況下，工作單元在每一次運行都是一個新的實例，相互之間獨立運行，互不干擾。所以如果需要存在一定的關(guān)聯(lián)，就要設(shè)置任務(wù)的特性，主要有兩個，如下所示：

• [PersistJobDataAfterExecution]//在執(zhí)行完成后，保留JobDataMap數(shù)據(jù)
• [DisallowConcurrentExecution]//不允許并發(fā)執(zhí)行，即必須等待上次完成后才能執(zhí)行下一次

以上兩個特性，只需要標記在任務(wù)對應(yīng)的類上即可。標記上后，只需要往對應(yīng)的JobDataMap中添加值即可。

監(jiān)聽器

在Quartz框架下，有三種監(jiān)聽器，分別是：時間軸監(jiān)聽器ISchedulerListener，觸發(fā)規(guī)則監(jiān)聽器ITriggerListener，任務(wù)監(jiān)聽器IJobListener。要實現(xiàn)對應(yīng)監(jiān)聽器，實現(xiàn)對應(yīng)接口即可。實現(xiàn)監(jiān)聽器步驟：

1. 創(chuàng)建監(jiān)聽器

根據(jù)不同的需要，可以創(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)    {//任務(wù)完成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任務(wù)監(jiān)聽器

/// <summary>/// TestJob監(jiān)聽器/// </summary>public class TestJobListener : IJobListener{    public string Name => "TestJobListener";    public Task JobExecutionVetoed(IJobExecutionContext context, CancellationToken cancellationToken = default)    {//任務(wù)被終止時return Task.Run(() => {    Console.WriteLine("Test Job is vetoed.");});    }    public Task JobToBeExecuted(IJobExecutionContext context, CancellationToken cancellationToken = default)    {//任務(wù)被執(zhí)行時return Task.Run(() => {    Console.WriteLine("Test Job is to be executed.");});    }    public Task JobWasExecuted(IJobExecutionContext context, JobExecutionException? jobException, CancellationToken cancellationToken = default)    {//任務(wù)已經(jīng)執(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)建實現(xiàn)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)聽器，日志，參數(shù)傳遞，任務(wù)特性后，完整的目錄結(jié)構(gòu)，如下所示：

示例截圖

到此這篇關(guān)于.NET6+Quartz實現(xiàn)定時任務(wù)的示例詳解的文章就介紹到這了,更多相關(guān).NET6 Quartz定時任務(wù)內(nèi)容請搜索以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持！