.NET6+Quartz實現定時任務_ZenDei技術網路在線

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

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

什麼是定時任務？

定時任務，也叫任務調度，是指在一定的載體上，根據具體的觸發規則，執行某些操作。所以定時任務需要滿足三個條件：載體（Scheduler），觸發規則（Trigger），具體業務操作（Job）。如下所示：

什麼是Quartz？

Quartz 是一個開源的作業調度框架，它完全由 Java 寫成，並設計用於 J2SE 和 J2EE 應用中。它提供了巨大的靈活性而不犧牲簡單性。你能夠用它來為執行一個作業而創建簡單的或複雜的調度。它有很多特征，如：資料庫支持，集群，插件，EJB 作業預構建，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安裝

為了方便，本示例創建一個基於.Net6.0的控制台應用程式，在VS2022中，通過Nuget包管理器進行安裝，如下所示：

創建一個簡單的定時器任務

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

1. 創建工作單元Job

創建任務需要實現IJob介面，如下所示：

 1 using Quartz;
 2 using System.Diagnostics;
 3 
 4 namespace DemoQuartz.QuartzA.Job
 5 {
 6     /// <summary>
 7     /// 測試任務，實現IJob介面
 8     /// </summary>
 9     public class TestJob : IJob
10     {
11         public TestJob()
12         {
13             Console.WriteLine("執行構造函數");//表示每一次計劃執行，都是一次新的實例
14         }
15 
16         public Task Execute(IJobExecutionContext context)
17         {
18             return Task.Run(() =>
19              {
20                  Console.WriteLine($"******************************");
21                  Console.WriteLine($"測試信息{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff")}");
22                  Console.WriteLine($"******************************");
23                  Console.WriteLine();
24              });
25         }
26     }
27 }

2. 創建時間軸Scheduler

時間軸也是任務執行的載體，可以通過StdSchedulerFactory進行獲取，如下所示：

1 //創建計劃單元（時間軸，載體）
2 StdSchedulerFactory schedulerFactory = new StdSchedulerFactory();
3 var scheduler = await schedulerFactory.GetScheduler();
4 await scheduler.Start();

3. 創建觸發規則Trigger

觸發規則就是那些時間點執行任務，可通過TriggerBuilder進行構建，如下所示：

1 //Trigger時間觸發機制
2 var trigger = TriggerBuilder.Create()
3     .WithIdentity("TestTrigger","TestGroup")
4     //.StartNow() //立即執行
5     .WithSimpleSchedule(w=>w.WithIntervalInSeconds(5).WithRepeatCount(5))//.RepeatForever()//無限迴圈
6     //.WithCronSchedule("5/10 * * * * ?") //通過Cron表達式定製時間觸發規則, 示例表示從5開始，每隔10秒一次
7     .Build();

4. 創建任務描述

任務描述定義了具體的任務名稱，分組等內容。可通過JobBuilder進行構建，如下所示：

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

5. 建立三者聯繫

通過載體，將規則和工作單元串聯起來，如下所示：

1 //把時間和任務通過載體關聯起來
2 await scheduler.ScheduleJob(jobDetail, trigger);

6. 簡單示例測試

通過運行程式，示例結果如下所示：

傳遞參數

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

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

trigger.JobDataMap, 時間觸發時通過JobDataMap傳遞參數。

在Job工作單元中，可以通過Context中對應的JobDataMap獲取參數。

傳遞參數，如下所示：

 1 //傳遞參數
 2 jobDetail.JobDataMap.Add("name", "Alan");
 3 jobDetail.JobDataMap.Add("age", 20);
 4 jobDetail.JobDataMap.Add("sex", true);
 5 
 6 
 7 //trigger同樣可以傳遞參數
 8 trigger.JobDataMap.Add("like1", "meimei");
 9 trigger.JobDataMap.Add("like2", "football");
10 trigger.JobDataMap.Add("like3", "sing");

獲取參數，如下所示：

 1 //獲取參數
 2 var name = context.JobDetail.JobDataMap.GetString("name");
 3 var age = context.JobDetail.JobDataMap.GetInt("age");
 4 var sex = context.JobDetail.JobDataMap.GetBoolean("sex") ? "男" : "女";
 5 
 6 var like1 = context.Trigger.JobDataMap.GetString("like1");
 7 var like2 = context.Trigger.JobDataMap.GetString("like2");
 8 var like3 = context.Trigger.JobDataMap.GetString("like3");
 9 
10 //context.MergedJobDataMap.GetString("aa");//註意如果使用MergedJobDataMap，JobDetail和Trigger中用到相同的Key，則後面設置的會覆蓋前面設置的。

註意：如果使用MergedJobDataMap，JobDetail和Trigger中用到相同的Key，則後面設置的會覆蓋前面設置的。

任務特性

假如我們的定時任務，執行一次需要耗時比較久，而且後一次執行需要等待前一次完成，並且需要前一次執行的結果作為參考，那麼就需要設置任務的任性。因為預設情況下，工作單元在每一次運行都是一個新的實例，相互之間獨立運行，互不幹擾。所以如果需要存在一定的關聯，就要設置任務的特性，主要有兩個，如下所示：

[PersistJobDataAfterExecution]//在執行完成後，保留JobDataMap數據
[DisallowConcurrentExecution]//不允許併發執行，即必須等待上次完成後才能執行下一次

以上兩個特性，只需要標記在任務對應的類上即可。標記上後，只需要往對應的JobDataMap中添加值即可。

監聽器

在Quartz框架下，有三種監聽器，分別是：時間軸監聽器ISchedulerListener，觸發規則監聽器ITriggerListener，任務監聽器IJobListener。要實現對應監聽器，實現對應介面即可。實現監聽器步驟：

1. 創建監聽器

根據不同的需要，可以創建不同的監聽器，如下所示：

時間軸監聽器SchedulerListener

  1 public class TestSchedulerListener : ISchedulerListener
  2 {
  3     public Task JobAdded(IJobDetail jobDetail, CancellationToken cancellationToken = default)
  4     {
  5         return Task.Run(() => {
  6             Console.WriteLine("Test Job is added.");
  7         });
  8     }
  9 
 10     public Task JobDeleted(JobKey jobKey, CancellationToken cancellationToken = default)
 11     {
 12         return Task.Run(() => {
 13             Console.WriteLine("Test Job is deleted.");
 14         });
 15     }
 16 
 17     public Task JobInterrupted(JobKey jobKey, CancellationToken cancellationToken = default)
 18     {
 19         return Task.Run(() => {
 20             Console.WriteLine("Test Job is Interrupted.");
 21         });
 22     }
 23 
 24     public Task JobPaused(JobKey jobKey, CancellationToken cancellationToken = default)
 25     {
 26         return Task.Run(() => {
 27             Console.WriteLine("Test Job is paused.");
 28         });
 29     }
 30 
 31     public Task JobResumed(JobKey jobKey, CancellationToken cancellationToken = default)
 32     {
 33         return Task.Run(() => {
 34             Console.WriteLine("Test Job is resumed.");
 35         });
 36     }
 37 
 38     public Task JobScheduled(ITrigger trigger, CancellationToken cancellationToken = default)
 39     {
 40         return Task.Run(() => {
 41             Console.WriteLine("Test Job is scheduled.");
 42         });
 43     }
 44 
 45     public Task JobsPaused(string jobGroup, CancellationToken cancellationToken = default)
 46     {
 47         return Task.Run(() => {
 48             Console.WriteLine("Test Jobs is paused.");
 49         });
 50     }
 51 
 52     public Task JobsResumed(string jobGroup, CancellationToken cancellationToken = default)
 53     {
 54         return Task.Run(() => {
 55             Console.WriteLine("Test Jobs is resumed.");
 56         });
 57     }
 58 
 59     public Task JobUnscheduled(TriggerKey triggerKey, CancellationToken cancellationToken = default)
 60     {
 61         return Task.Run(() => {
 62             Console.WriteLine("Test Jobs is un schedulered.");
 63         });
 64     }
 65 
 66     public Task SchedulerError(string msg, SchedulerException cause, CancellationToken cancellationToken = default)
 67     {
 68         return Task.Run(() => {
 69             Console.WriteLine("Test scheduler is error.");
 70         });
 71     }
 72 
 73     public Task SchedulerInStandbyMode(CancellationToken cancellationToken = default)
 74     {
 75         return Task.Run(() => {
 76             Console.WriteLine("Test scheduler is standby mode.");
 77         });
 78     }
 79 
 80     public Task SchedulerShutdown(CancellationToken cancellationToken = default)
 81     {
 82         return Task.Run(() => {
 83             Console.WriteLine("Test scheduler is shut down.");
 84         });
 85     }
 86 
 87     public Task SchedulerShuttingdown(CancellationToken cancellationToken = default)
 88     {
 89         return Task.Run(() => {
 90             Console.WriteLine("Test scheduler is shutting down.");
 91         });
 92     }
 93 
 94     public Task SchedulerStarted(CancellationToken cancellationToken = default)
 95     {
 96         return Task.Run(() => {
 97             Console.WriteLine("Test scheduleer is started.");
 98         });
 99     }
100 
101     public Task SchedulerStarting(CancellationToken cancellationToken = default)
102     {
103         return Task.Run(() => {
104             Console.WriteLine("Test scheduler is starting.");
105         });
106     }
107 
108     public Task SchedulingDataCleared(CancellationToken cancellationToken = default)
109     {
110         return Task.Run(() => {
111             Console.WriteLine("Test scheduling is cleared.");
112         });
113     }
114 
115     public Task TriggerFinalized(ITrigger trigger, CancellationToken cancellationToken = default)
116     {
117         return Task.Run(() => {
118             Console.WriteLine("Test trigger is finalized.");
119         });
120     }
121 
122     public Task TriggerPaused(TriggerKey triggerKey, CancellationToken cancellationToken = default)
123     {
124         return Task.Run(() => {
125             Console.WriteLine("Test trigger is paused.");
126         });
127     }
128 
129     public Task TriggerResumed(TriggerKey triggerKey, CancellationToken cancellationToken = default)
130     {
131         return Task.Run(() => {
132             Console.WriteLine("Test trigger is resumed.");
133         });
134     }
135 
136     public Task TriggersPaused(string? triggerGroup, CancellationToken cancellationToken = default)
137     {
138         return Task.Run(() => {
139             Console.WriteLine("Test triggers is paused.");
140         });
141     }
142 
143     public Task TriggersResumed(string? triggerGroup, CancellationToken cancellationToken = default)
144     {
145         return Task.Run(() => {
146             Console.WriteLine("Test triggers is resumed.");
147         });
148     }
149 }

觸發規則監聽器TriggerListener

 1 /// <summary>
 2 /// 觸發器監聽
 3 /// </summary>
 4 public class TestTriggerListener : ITriggerListener
 5 {
 6     public string Name => "TestTriggerListener";
 7 
 8     public Task TriggerComplete(ITrigger trigger, IJobExecutionContext context, SchedulerInstruction triggerInstructionCode, CancellationToken cancellationToken = default)
 9     {
10         //任務完成
11         return Task.Run(() => {
12             Console.WriteLine("Test trigger is complete.");
13         
14         });
15     }
16 
17     public Task TriggerFired(ITrigger trigger, IJobExecutionContext context, CancellationToken cancellationToken = default)
18     {
19         return Task.Run(() => {
20             Console.WriteLine("Test trigger is fired.");
21 
22         });
23     }
24 
25     public Task TriggerMisfired(ITrigger trigger, CancellationToken cancellationToken = default)
26     {
27         return Task.Run(() => {
28             Console.WriteLine("Test trigger is misfired.");
29 
30         });
31     }
32 
33     public Task<bool> VetoJobExecution(ITrigger trigger, IJobExecutionContext context, CancellationToken cancellationToken = default)
34     {
35         return Task.Run(() => {
36             Console.WriteLine("Test trigger is veto.");
37             return false;//是否終止
38         });
39     }
40 }

JobListener任務監聽器

 1 /// <summary>
 2 /// TestJob監聽器
 3 /// </summary>
 4 public class TestJobListener : IJobListener
 5 {
 6     public string Name => "TestJobListener";
 7 
 8     public Task JobExecutionVetoed(IJobExecutionContext context, CancellationToken cancellationToken = default)
 9     {
10         //任務被終止時
11         return Task.Run(() => {
12             Console.WriteLine("Test Job is vetoed.");
13         });
14     }
15 
16     public Task JobToBeExecuted(IJobExecutionContext context, CancellationToken cancellationToken = default)
17     {
18         //任務被執行時
19         return Task.Run(() => {
20             Console.WriteLine("Test Job is to be executed.");
21         });
22     }
23 
24     public Task JobWasExecuted(IJobExecutionContext context, JobExecutionException? jobException, CancellationToken cancellationToken = default)
25     {
26         //任務已經執行
27         return Task.Run(() => {
28             Console.WriteLine("Test Job was executed.");
29         });
30     }
31 }

2. 添加監聽

在時間軸上的監聽管理器中進行添加，如下所示：

1 //增加監聽
2 scheduler.ListenerManager.AddJobListener(new TestJobListener());
3 scheduler.ListenerManager.AddTriggerListener(new TestTriggerListener());
4 scheduler.ListenerManager.AddSchedulerListener(new TestSchedulerListener());

日誌管理

在Quartz框架中，創建之前會進行日誌創建檢測，所以如果需要獲取框架中的日誌信息，可以進行創建實現ILogProvider，如下所示：

 1 public class TestLogProvider : ILogProvider
 2 {
 3     public Logger GetLogger(string name)
 4     {
 5         return (level, func, exception, parameters) =>
 6         {
 7             if (level >= Quartz.Logging.LogLevel.Info && func != null)
 8             {
 9                 Console.WriteLine("[" + DateTime.Now.ToLongTimeString() + "] [" + level + "] " + func(), parameters);
10             }
11             return true;
12         };
13     }
14 
15     public IDisposable OpenMappedContext(string key, object value, bool destructure = false)
16     {
17         throw new NotImplementedException();
18     }
19 
20     public IDisposable OpenNestedContext(string message)
21     {
22         throw new NotImplementedException();
23     }
24 }

然後在當前的Scheduler中，添加日誌即可，如下所示：

1 //日誌
2 LogProvider.SetCurrentLogProvider(new TestLogProvider());

完整示例

在添加了監聽器，日誌，參數傳遞，任務特性後，完整的目錄結構，如下所示：

示例截圖

以上就是.Net6.0+Quartz開發控制台定時任務調度的全部內容。以上任務都是硬編碼的固定程式，包括任務的啟停，那麼如果能通過可視化界面來創建以及管理任務，是不是一件很爽的事情呢，這也是後續需要探討的內容。

作者：小六公子
出處：http://www.cnblogs.com/hsiang/
本文版權歸作者和博客園共有，寫文不易，支持原創，歡迎轉載【點贊】，轉載請保留此段聲明，且在文章頁面明顯位置給出原文連接，謝謝。
關註個人公眾號，定時同步更新技術及職場文章