MVC 使用Quartz.Net組件實現定時計划任務

          最近，項目中需要執行一個計划任務，組長就讓我了解一下Quartz.net 這個組件，挺簡單的一個組件，實現起來特別的方便，靈活，值得推薦給大家一起學習一下這個小工具。以前我有的時候是使用定時器Timer，還有數據庫中的 計划任務，后來發現這些真的太不好用了。下面我介紹一下這個組件的使用步驟和注意事項，僅供參考，有什么不對的地方，希望大家多多見諒並幫我指出來，大家 相互學習嘛。

        首先，簡述一下Quartz.net 組件的基本概念：它是一個簡單的執行任務計划的組件，基本包括這三部分：Job(作業)、Trigger(觸發器)、scheduler(調度器)。

        1.Job 作業：需要在任務計划中執行的具體邏輯操作

        2.Trigger 觸發器：需要什么時間什么規則來去執行Job 作業

        3.scheduler 調度器 ：將Job 和 Trigger 注冊到 scheduler 調度器中，主要負責協調Job、Trigger 的運行

 

    第一步：下載Quartz.net 組件

      在VS 中 工具 > NuGet 程序包管理器 > 程序包管理控制台   點擊打開  在控制台上輸入 Install-Package Quartz  就可以成功下載下來了，詳見如圖所示：

    

第二步：在VS 中我們創建一個類庫，這樣方便我們移植程序，也方便我們代碼的分離；一個Job 創建一個實例類，下面我會創建兩個實例類一個是UpdateCompleteJob.cs、UpdateAutoCancelStateJob.cs (之所以創建兩個Job是為了能方便大家了解這個組件可以同時執行多個任務)

 (1) UpdateCompleteJob.cs 代碼如下： 

using Quartz;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WechatMall.Application.BLL;
using WechatMall.Application.Data;
using WechatMall.Model.ExpressModel;

namespace WechatMallJobLibrary
{
    public class UpdateCompleteJob : IJob
    {
        /// <summary>
        ///在Job 中我們必須實現IJob接口中的Execute 這個方法，才能正確的使用Job
        /// </summary>
        public void Execute(IJobExecutionContext context)
        {
            using (var _ctx = new BtDbContext())
            {
                List<string> expressCode = new List<string>();

                var query = _ctx.Orders.Where(c => c.OrderStatus ==  WechatMall.Common.EnumHelper.OrderStatus.Sended 
                                                && c.PayStatus == WechatMall.Common.EnumHelper.PayStatus.Paid).OrderBy(c => c.CreateTime).ToList().Take(20);

                foreach (var item in query)
                {
                    if (!string.IsNullOrEmpty(item.ExpressCode))
                    {
                        ExpressModel model = ExpressAPI._GetExpress(item.ExpressCode);
                        
                        //確定 快遞已簽收  修改訂單狀態 已完成
                        if (model.state == "3" && model.ischeck == "1")
                        {
                            var order = _ctx.Orders.FirstOrDefault( c => c.OrderId == item.OrderId);

                            order.OrderStatus = WechatMall.Common.EnumHelper.OrderStatus.Over;
                            order.FlowStatus  = WechatMall.Common.EnumHelper.FlowStatus.Over;
                            order.UpdateTime  = DateTime.Now;

                            _ctx.SaveChanges();
                        }
                    }
                  
                }

            }
        }
    }
}

(2) UpdateAutoCancelStateJob.cs 代碼如下：

using Quartz;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WechatMall.Application.Data;

namespace WechatMallJobLibrary
{
   public class UpdateAutoCancelStateJob:IJob
    {
       public void Execute(IJobExecutionContext context)
       {
           using (var _ctx = new BtDbContext())
           {
               var order = _ctx.Orders.FirstOrDefault(c => c.OrderStatus == WechatMall.Common.EnumHelper.OrderStatus.UnSend 
                                                        && c.PayStatus == WechatMall.Common.EnumHelper.PayStatus.UnPaid);

               if (this.DateDiff(DateTime.Now,order.CreateTime) > 30)
               {
                   order.OrderStatus = WechatMall.Common.EnumHelper.OrderStatus.Cancel;
                   order.FlowStatus  = WechatMall.Common.EnumHelper.FlowStatus.Cancel;
                   order.UpdateTime  = DateTime.Now;

                   _ctx.SaveChanges();
               }
           }
       }

      //計算時間差的方法
       private int DateDiff(DateTime DateTime1, DateTime DateTime2)
       {
           int dateDiff = 0;
           TimeSpan ts1 = new TimeSpan(DateTime1.Ticks);
           TimeSpan ts2 = new
           TimeSpan(DateTime2.Ticks);
           TimeSpan ts = ts1.Subtract(ts2).Duration();
          // dateDiff = ts.Days.ToString()+"天"+ ts.Hours.ToString()+"小時"+ ts.Minutes.ToString()+"分鍾"+ ts.Seconds.ToString()+"秒";
            dateDiff =  ts.Minutes;
          
           return dateDiff;
       }
    }
}

 備注：解釋一下上面兩個類中的方法中的IJobExecutionContext  參數是什么意思，在Execute方法有一個IJobExecutionContext的接口對象作為參數，這個參數包含了定義這個類的job(作業)的配置信息。作為實例在這里我就沒有展示是怎么使用的，有時間我會補充上去的。

 

第三步：就該設置Trigger 觸發器，在實際中我是將Trigger和Job 直接注冊到 scheduler 調度器中；在這里其實還有一小步沒有指出來就是需要將類庫生成的DLL 拷貝到你的需要執行的項目的文件中.詳見3.1 中的圖

   3.1  下面標紅的是dll 所放文件的名字，在下面的代碼中需要使用的，小伙伴們多注意一下

   

具體的代碼如下：

using Quartz;
using Quartz.Impl;
using Quartz.Impl.Triggers;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Web;
using System.Xml.Linq;

namespace WechatMall.SysManage.JobAutoUpdateState
{
    public class JobManage
    {
        private static ISchedulerFactory sf = new StdSchedulerFactory();

        //調度器
        private static IScheduler scheduler;

        /// <summary>
        /// 讀取調度器配置文件的開始時間
        /// </summary>
        public static void StartScheduleFromConfig()
        {
            string currentDir = AppDomain.CurrentDomain.BaseDirectory;

            try
            {
                XDocument xDoc = XDocument.Load(Path.Combine(currentDir, "JobScheduler.config"));
                var jobScheduler = from x in xDoc.Descendants("JobScheduler") select x;

                var jobs = jobScheduler.Elements("Job");
                XElement jobDetailXElement, triggerXElement;

                //獲取調度器
                scheduler = sf.GetScheduler();

                //聲明觸發器
                CronTriggerImpl cronTrigger;

                foreach (var job in jobs)
                {
                    //加載程序集joblibaray  
                    Assembly ass = Assembly.LoadFrom(Path.Combine(currentDir+ "JobAutoUpdateState\\", job.Element("DllName").Value));

                    //獲取任務名字
                    jobDetailXElement = job.Element("JobDetail");
                    //獲取任務觸發的時間
                    triggerXElement = job.Element("Trigger");

                    JobDetailImpl jobDetail = new JobDetailImpl(jobDetailXElement.Attribute("job").Value,
                                                            jobDetailXElement.Attribute("group").Value,
                                                            ass.GetType(jobDetailXElement.Attribute("jobtype").Value));


                    if (triggerXElement.Attribute("type").Value.Equals("CronTrigger"))
                    {
                        cronTrigger = new CronTriggerImpl(triggerXElement.Attribute("name").Value,
                                                        triggerXElement.Attribute("group").Value,
                                                        triggerXElement.Attribute("expression").Value);
                        //添加定時器
                        scheduler.ScheduleJob(jobDetail, cronTrigger);
                    }
                }

                //開始執行定時器
                scheduler.Start();

            }
            catch (Exception)
            {


            }

        }

        /// <summary>
        /// 關閉定時器
        /// </summary>
        public static void ShutDown()
        {
            if (scheduler != null && !scheduler.IsShutdown)
            {
                scheduler.Shutdown();
            }
        }  
    }
}

 

第四步：配置文件，主要是控制任務執行的時間和Job 的加載

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <JobScheduler>
    <Job Description="作業1">
      <DllName>WechatMallJobLibrary.dll</DllName>
      <JobDetail job="test1" group="test1Group" jobtype="WechatMallJobLibrary.UpdateCompleteJob" />
      <Trigger name="test1" group="test1Group" type="CronTrigger" expression="0 0/30 * * * ?" />
    </Job>
    <Job Description="作業2">
      <DllName>WechatMallJobLibrary.dll</DllName>
      <JobDetail job="test2" group="test2Group" jobtype="WechatMallJobLibrary.UpdateAutoCancelStateJob" />
      <Trigger name="test2" group="test2Group" type="CronTrigger" expression="0/30 * * * * ?" />
    </Job>
  </JobScheduler>  

</configuration>

備注：下面解析一下配置中重要的幾個屬性 <DllName>WechatMallJobLibrary.dll</DllName> dll的名字 ；jobtype 屬性是dll名字+實例類的名字；expression 這個是設置執行的時間，后續我介紹這個時間的設置

第五步：需要將scheduler 調度器注冊到程序中；在程序中Global.asax.cs 中文件中添加注冊，在這里啟動執行任務。

        protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas();
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);

            //執行的任務
            JobManage.StartScheduleFromConfig();


        }

 

OK，上面的就是Quartz.Net 組件執行定時任務的全部流程了，有什么問題希望大家批評指出；下面就來說明一下設置執行任務的時間的設置：

下面的任務執行時間是參考http://blog.csdn.net/foamflower/article/details/4260645 中的，請詳見

CronTrigger 配置設置格式：

1.格式: [秒] [分] [小時] [日] [月] [周] [年]

   列入:0 0/30 * * * ?  時隔 30 分鍾執行一次

         0/30 * * * * ?   時隔 30 秒執行一次

 

序號

說明	是否必填	允許填寫的值	允許的通配符
1	秒	是	0-59	, - * /
2	分	是	0-59	, - * /
3	小時	是	0-23	, - * /
4	日	是	1-31	, - * ? / L W
5	月	是	1-12 or JAN-DEC	, - * /
6	周	是	1-7 or SUN-SAT	, - * ? / L #
7	年	否	empty 或 1970-2099	, - * /

2.通配符

 

* ：表示所有值. 例如:在分的字段上設置 "*",表示每一分鍾都會觸發。
? ：表示不指定值。使用的場景為不需要關心當前設置這個字段的值。例如:要在每月的10號觸發一個操作，但不關心是周幾，所以需要周位置的那個字段設置為"?" 具體設置為 0 0 0 10 * ?
- ：表示區間。例如 在小時上設置 "10-12",表示 10,11,12點都會觸發。
, ：表示指定多個值，例如在周字段上設置 "MON,WED,FRI" 表示周一，周三和周五觸發
/ ：用於遞增觸發。如在秒上面設置"5/15" 表示從5秒開始，每增15秒觸發(5,20,35,50)。 在月字段上設置'1/3'所示每月1號開始，每隔三天觸發一次。
L ：表示最后的意思。在日字段設置上，表示當月的最后一天(依據當前月份，如果是二月還會依據是否是潤年[leap]), 在周字段上表示星期六，相當於"7"或"SAT"。如果在"L"前加上數字，則表示該數據的最后一個。

例如在周字段上設置"6L"這樣的格式,則表示“本月最后一個星期五"

W ：表示離指定日期的最近那個工作日(周一至周五). 例如在日字段上設置"15W"，表示離每月15號最近的那個工作日觸發。如果15號正好是周六，則找最近的周五(14號)觸發, 如果15號是周未，則找最近的下周一(16號)觸發.如果15號正好在工作日(周一至周五)，則就在該天觸發。如果指定格式為 "1W",它則表示每月1號往后最近的工作日觸發。如果1號正是周六，則將在3號下周一觸發。(注，"W"前只能設置具體的數字,不允許區間"-").

'L'和 'W'可以一組合使用。如果在日字段上設置"LW",則表示在本月的最后一個工作日觸發

 

# ：序號(表示每月的第幾周星期幾)，例如在周字段上設置"6#3"表示在每月的第三個周星期六.注意如果指定"6#5",正好第五周沒有星期六，則不會觸發該配置(用在母親節和父親節再合適不過了)

周字段的設置，若使用英文字母是不區分大小寫的 MON 與mon相同.

 

常用示例:

格式: [秒] [分] [小時] [日] [月] [周] [年]

0 0 12 * * ?           每天12點觸發
0 15 10 ? * *          每天10點15分觸發
0 15 10 * * ?          每天10點15分觸發 
0 15 10 * * ? *        每天10點15分觸發 
0 15 10 * * ? 2005     2005年每天10點15分觸發
0 * 14 * * ?           每天下午的 2點到2點59分每分觸發
0 0/5 14 * * ?         每天下午的 2點到2點59分(整點開始，每隔5分觸發) 
0 0/5 14,18 * * ?        每天下午的 18點到18點59分(整點開始，每隔5分觸發)

0 0-5 14 * * ?            每天下午的 2點到2點05分每分觸發
0 10,44 14 ? 3 WED        3月分每周三下午的 2點10分和2點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 2002-2005  從2002年到2005年每月最后一周的星期五的10點15分觸發

0 15 10 ? * 6#3           每月的第三周的星期五開始觸發
0 0 12 1/5 * ?            每月的第一個中午開始每隔5天觸發一次
0 11 11 11 11 ?           每年的11月11號 11點11分觸發(光棍節)