Quartz.Net實現作業定時調度詳解

1、Quartz.NET介紹

Quartz.NET是一個強大、開源、輕量的作業調度框架,你能夠用它來爲執行一個作業而創建簡單的或複雜的作業調度。它有很多特徵,如:數據庫支持,集羣,插件,支持cron-like表達式等等。非常適合在平時的工作中,定時輪詢數據庫同步,定時郵件通知,定時處理數據等。

Quartz.NET允許開發人員根據時間間隔(或天)來調度作業。它實現了作業和觸發器的多對多關係,還能把多個作業與不同的觸發器關聯。整合了 Quartz.NET的應用程序可以重用來自不同事件的作業,還可以爲一個事件組合多個作業。

官網:http://www.quartz-scheduler.net/

源碼:https://github.com/quartznet/quartznet

示例:https://www.quartz-scheduler.net/documentation/quartz-3.x/quick-start.html

Quartz.NET是一個強大、開源、輕量的作業調度框架,是 OpenSymphony 的 Quartz API 的.NET移植,用C#改寫,可用於winform和Web應用中。它靈活而不復雜,你能夠用它來爲執行一個作業而創建簡單的或複雜的作業調度。Quartz.NET 3.0 已經開始支持 .NET Core/.NET Standard 2.0。

Job 爲作業的接口,JobDetail 用來描述 Job 的實現類及其它相關的靜態信息;Trigger 作爲作業的定時管理工具,一個 Trigger 只能對應一個作業實例,而一個作業實例可對應多個 Trigger ;Scheduler 做爲定時任務容器,它包含了所有觸發器和作業,每個 Scheduler 都存有 JobDetail 和 Trigger
的註冊,一個 Scheduler 中可以註冊多個 JobDetail 和多個 Trigger 。

2、依賴框架

引入框架的方法非常簡單你可以直接用nuget管理包也可以在項目中添加引用。爲了滿足不同客戶的需求,本文以最簡單的方式來講解在Visual Studio中如何正確使用Quartz.NET

2.1、使用Nuget添加使用

2.1.0、創建一個項目

創建一個新項目,可以是ASP.NET MVC、WebForms、Winforms、.NET Core等多種.Net項目,這裏使用的是VS2017,創建了一個控制檯應用項目。

要使用Quartz.NET我們需要安裝Quartz.NET包,最簡單的方式就是從Quartz.NET管網下載dll文件引用即可。本文我們使用Nuget進行dll文件的引用與管理。要使用Nuget必須確保已經安裝過,最簡單的方式是通過VS“工具”菜單查看是否有程序包管理控制檯,如果有說明已經安裝過,如下圖所示。

如果沒有找到那我們就要進行安裝。

2.1.2、安裝Nuget

新版本的Visual Studio默認情況是安裝了Nuget的,如Visual Studio 2015+,如果沒有安裝,打開VS菜單“工具”->“擴展與更新”。

在擴展與更新中搜索“nuget”,可以新安裝或卸載後升級。

2.1.3、使用nuget安裝Quartz.NET

點擊“工具”->“NuGet包管理器”->“程序包管理器控制檯”

輸入安裝包的命令:

Install-Package Quartz

安裝結果如下:
在這裏插入圖片描述

時包管理器中就下載了需要的程序集與相關文件,同時程序中也添加了引用。

3、Quartz.NET應用

假定要實現每隔5秒鐘向控制檯記錄當前時間。

因爲這是一個控制檯應用,我想一啓動時就開始該項工作,這裏我們需要將代碼寫在static void Main(string[] args)方法中。

3.1、定義要執行的任務

定義一個類,實現Quartz.IJob接口,實現方法Execute,TimeJob.cs文件的代碼如下:

using System;
using System.Threading.Tasks;

namespace QuartzTest
{
    using Quartz;

    public class TimeJob : IJob
    {
        /// <summary>
        /// 作業調度定時執行的方法
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public async Task Execute(IJobExecutionContext context)
        {
            await Console.Out.WriteLineAsync("Hello QuartzNet..." + DateTime.Now + Environment.NewLine);           
        }
    }
}

3.2、創建一個調度器

調度器負責管理與控制任務的執行,在Main方法中添加如下代碼:

//調度器
IScheduler scheduler;
//調度器工廠
ISchedulerFactory factory;

//創建一個調度器
factory = new StdSchedulerFactory();
scheduler = factory.GetScheduler();
scheduler.Start();

3.3、創建一個任務對象

這個任務對象就是我們將要執行的工作,job1是名稱,group1是組名。
//2、創建一個任務
IJobDetail job = JobBuilder.Create().WithIdentity(“job1”, “group1”).Build();

3.4、創建一個觸發器

觸發器定義了什麼時間任務開始或每隔多久執行一次。

//3、創建一個觸發器
//DateTimeOffset runTime = DateBuilder.EvenMinuteDate(DateTimeOffset.UtcNow);
ITrigger trigger = TriggerBuilder.Create()
	.WithIdentity("trigger1", "group1")
	.WithCronSchedule("0/5 * * * * ?")     //5秒執行一次
	.Build();

3.5、將任務與觸發器添加到調度器中並執行

//4、將任務與觸發器添加到調度器中
scheduler.ScheduleJob(job, trigger);
//5、開始執行
scheduler.Start();

3.6、運行結果

3.7 Main方法完整代碼

using Quartz;
using Quartz.Impl;
using System;

namespace QuartzTest
{
    class Program
    {
        static void Main(string[] args)
        {
            //1、調度器
            ISchedulerFactory sf = new StdSchedulerFactory();
            IScheduler sched = sf.GetScheduler();
            //2、創建一個任務
            IJobDetail job = JobBuilder.Create<TimeJob>()
              .WithIdentity("job1", "group1")
              .Build();

            //3、創建一個觸發器
            //DateTimeOffset runTime = DateBuilder.EvenMinuteDate(DateTimeOffset.UtcNow);
            ITrigger trigger = TriggerBuilder.Create()
                .WithIdentity("trigger1", "group1")
                .WithCronSchedule("0/5 * * * * ?")     //5秒執行一次                                                      
                .Build();

            sched.ScheduleJob(job, trigger);
            //啓動任務
            sched.Start();
        }
    }
}

4、Quartz的cron表達式

Cron表達式是一個字符串,字符串以5或6個空格隔開,分爲6或7個域,每一個域代表一個含義,Cron有如下兩種語法格式:

(1) Seconds Minutes Hours DayofMonth Month DayofWeek Year

(2)Seconds Minutes Hours DayofMonth Month DayofWeek

結構

corn從左到右(用空格隔開):秒 分 小時 月份中的日期 月份 星期中的日期 年份(可爲空)

例 “0 0 12 ? * WED” 在每星期三下午12:00 執行(年份通常 省略)

Cron各字段的含義

通配符說明

星號(*):可用在所有字段中,表示對應時間域的每一個時刻,例如, 在分鐘字段時,表示“每分鐘”;

問號(?):該字符只在日期和星期字段中使用,它通常指定爲“無意義的值”,相當於點位符;

減號(-):表達一個範圍,如在小時字段中使用“10-12”,則表示從10到12點,即10,11,12;

逗號(,):表達一個列表值,如在星期字段中使用“MON,WED,FRI”,則表示星期一,星期三和星期五;

斜槓(/):x/y表達一個等步長序列,x爲起始值,y爲增量步長值。如在分鐘字段中使用0/15,則表示爲0,15,30和45秒,而5/15在分鐘字段中表示5,20,35,50,你也可以使用*/y,它等同於0/y;

L:該字符只在日期和星期字段中使用,代表“Last”的意思,但它在兩個字段中意思不同。L在日期字段中,表示這個月份的最後一天,如一月的31號,非閏年二月的28號;如果L用在星期中,則表示星期六,等同於7。但是,如果L出現在星期字段裏,而且在前面有一個數值X,則表示“這個月的最後X天”,例如,6L表示該月的最後星期五;

W:該字符只能出現在日期字段裏,是對前導日期的修飾,表示離該日期最近的工作日。例如15W表示離該月15號最近的工作日,如果該月15號是星期六,則匹配14號星期五;如果15日是星期日,則匹配16號星期一;如果15號是星期二,那結果就是15號星期二。但必須注意關聯的匹配日期不能夠跨月,如你指定1W,如果1號是星期六,結果匹配的是3號星期一,而非上個月最後的那天。W字符串只能指定單一日期,而不能指定日期範圍;

LW組合:在日期字段可以組合使用LW,它的意思是當月的最後一個工作日;

井號(#):該字符只能在星期字段中使用,表示當月某個工作日。如6#3表示當月的第三個星期五(6表示星期五,#3表示當前的第三個),而4#5表示當月的第五個星期三,假設當月沒有第五個星期三,忽略不觸發;

C:該字符只在日期和星期字段中使用,代表“Calendar”的意思。它的意思是計劃所關聯的日期,如果日期沒有被關聯,則相當於日曆中所有日期。例如5C在日期字段中就相當於日曆5日以後的第一天。1C在星期字段中相當於星期日後的第一天。

Cron表達式對特殊字符的大小寫不敏感,對代表星期的縮寫英文大小寫也不敏感。

一些例子:

表示式 說明

0 0 12 * * ? 每天12點運行

0 15 10 ? * * 每天10:15運行

0 15 10 * * ? 每天10:15運行

0 15 10 * * ? * 每天10:15運行

0 15 10 * * ? 2008 在2008年的每天10:15運行

0 * 14 * * ? 每天14點到15點之間每分鐘運行一次,開始於14:00,結束於14:59。

0 0/5 14 * * ? 每天14點到15點每5分鐘運行一次,開始於14:00,結束於14:55。

0 0/5 14,18 * * ? 每天14點到15點每5分鐘運行一次,此外每天18點到19點每5鍾也運行一次。

0 0-5 14 * * ? 每天14:00點到14:05,每分鐘運行一次。

0 10,44 14 ? 3 WED 3月每週三的14:10分到14:44,每分鐘運行一次。

0 15 10 ? * MON-FRI 每週一,二,三,四,五的10:15分運行。

0 15 10 15 * ? 每月15日10:15分運行。

0 15 10 L * ? 每月最後一天10:15分運行。

0 15 10 ? * 6L 每月最後一個星期五10:15分運行。

0 15 10 ? * 6L 2007-2009 在2007,2008,2009年每個月的最後一個星期五的10:15分運行。

0 15 10 ? * 6#3 每月第三個星期五的10:15分運行。

注意:

(1)有些子表達式能包含一些範圍或列表

例如:子表達式(天(星期))可以爲 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”

“*”字符代表所有可能的值

因此,“”在子表達式(月)裏表示每個月的含義,“”在子表達式(天(星期))表示星期的每一天

“/”字符用來指定數值的增量
  例如:在子表達式(分鐘)裏的“0/15”表示從第0分鐘開始,每15分鐘
在子表達式(分鐘)裏的“3/20”表示從第3分鐘開始,每20分鐘(它和“3,23,43”)的含義一樣

“?”字符僅被用於天(月)和天(星期)兩個子表達式,表示不指定值
  當2個子表達式其中之一被指定了值以後,爲了避免衝突,需要將另一個子表達式的值設爲“?”

“L” 字符僅被用於天(月)和天(星期)兩個子表達式,它是單詞“last”的縮寫
  但是它在兩個子表達式裏的含義是不同的。
  在天(月)子表達式中,“L”表示一個月的最後一天
  在天(星期)自表達式中,“L”表示一個星期的最後一天,也就是SAT

如果在“L”前有具體的內容,它就具有其他的含義了

例如:“6L”表示這個月的倒數第6天,“FRIL”表示這個月的最一個星期五
  注意:在使用“L”參數時,不要指定列表或範圍,因爲這會導致問題

表達式生成器
有很多的cron表達式在線生成器,這裏給大家推薦幾款
http://www.pdtools.net/tools/becron.jsp
或者
http://cron.qqe2.com/

5、其他文章參考


一路走來數個年頭,感謝RDIFramework.NET框架的支持者與使用者,大家可以通過下面的地址瞭解詳情。

RDIFramework.NET官方網站:http://www.rdiframework.net/

RDIFramework.NET官方博客:http://blog.rdiframework.net/

同時需要說明的,以後的所有技術文章以官方網站爲準,歡迎大家收藏!

RDIFramework.NET框架由專業團隊長期打造、一直在更新、一直在升級,請放心使用!

歡迎關注RDIFramework.net框架官方公衆微信(微信號:guosisoft),及時瞭解最新動態。

掃描二維碼立即關注
微信號:guosisoft

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章