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

時間 2019-11-17

標籤 quartz.net quartz 實現定時調度詳解欄目 Quartz 简体版

原文原文鏈接

一、Quartz.NET介紹

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

Quartz.NET容許開發人員根據時間間隔（或天）來調度做業。它實現了做業和觸發器的多對多關係，還能把多個做業與不一樣的觸發器關聯。整合了 Quartz.NET的應用程序能夠重用來自不一樣事件的做業，還能夠爲一個事件組合多個做業。git

官網：www.quartz-scheduler.net/github

源碼：github.com/quartznet/q…數據庫

示例：www.quartz-scheduler.net/documentati…微信

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 。框架

二、依賴框架

引入框架的方法很是簡單你能夠直接用nuget管理包也能夠在項目中添加引用。爲了知足不一樣客戶的需求，本文以最簡單的方式來說解在Visual Studio中如何正確使用Quartz.NET。jsp

2.一、使用Nuget添加使用

2.1.0、建立一個項目

建立一個新項目，能夠是ASP.NET MVC、WebForms、Winforms、.NET Core等多種.Net項目，這裏使用的是VS2017，建立了一個控制檯應用項目。async

要使用Quartz.NET咱們須要安裝Quartz.NET包，最簡單的方式就是從Quartz.NET管網下載dll文件引用便可。本文咱們使用Nuget進行dll文件的引用與管理。要使用Nuget必須確保已經安裝過，最簡單的方式是經過VS「工具」菜單查看是否有程序包管理控制檯，若是有說明已經安裝過，以下圖所示。分佈式

若是沒有找到那咱們就要進行安裝。

2.1.二、安裝Nuget

新版本的Visual Studio默認狀況是安裝了Nuget的，如Visual Studio 2015+，若是沒有安裝，打開VS菜單「工具」->"擴展與更新"。

在擴展與更新中搜索「nuget」，能夠新安裝或卸載後升級。

2.1.三、使用nuget安裝Quartz.NET

點擊「工具」->"NuGet包管理器"->「程序包管理器控制檯」

輸入安裝包的命令：

Install-Package Quartz
複製代碼

安裝結果以下：

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

三、Quartz.NET應用

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

由於這是一個控制檯應用，我想一啓動時就開始該項工做，這裏咱們須要將代碼寫在static void Main(string[] args)方法中。

3.一、定義要執行的任務

定義一個類，實現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.二、建立一個調度器

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

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

//建立一個調度器
factory = new StdSchedulerFactory();
scheduler = factory.GetScheduler();
scheduler.Start();
複製代碼

3.三、建立一個任務對象

這個任務對象就是咱們將要執行的工做，job1是名稱，group1是組名。 //二、建立一個任務 IJobDetail job = JobBuilder.Create().WithIdentity("job1", "group1").Build();

3.四、建立一個觸發器

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

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

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

//四、將任務與觸發器添加到調度器中
scheduler.ScheduleJob(job, trigger);
//五、開始執行
scheduler.Start();
複製代碼

3.六、運行結果

3.7 Main方法完整代碼

using Quartz;
using Quartz.Impl;
using System;

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

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

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

四、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。