C#中Quartz的簡單易懂定時任務實現

做爲一個優秀的開源調度框架,Quartz 具備如下特色:spring

  1. 強大的調度功能,例如支持豐富多樣的調度方法,能夠知足各類常規及特殊需求;
  2. 靈活的應用方式,例如支持任務和調度的多種組合方式,支持調度數據的多種存儲方式;
  3. 分佈式和集羣能力,Terracotta 收購後在原來功能基礎上做了進一步提高。

      另外,做爲 Spring 默認的調度框架,Quartz 很容易與 Spring 集成實現靈活可配置的調度功能。框架

    quartz調度核心元素:異步

  1. Scheduler:任務調度器,是實際執行任務調度的控制器。在spring中經過SchedulerFactoryBean封裝起來。
  2. Trigger:觸發器,用於定義任務調度的時間規則,有SimpleTrigger,CronTrigger,DateIntervalTrigger和NthIncludedDayTrigger,其中CronTrigger用的比較多,本文主要介紹這種方式。CronTrigger在spring中封裝在CronTriggerFactoryBean中。
  3. Calendar:它是一些日曆特定時間點的集合。一個trigger能夠包含多個Calendar,以便排除或包含某些時間點。
  4. JobDetail:用來描述Job實現類及其它相關的靜態信息,如Job名字、關聯監聽器等信息。在spring中有JobDetailFactoryBean和 MethodInvokingJobDetailFactoryBean兩種實現,若是任務調度只須要執行某個類的某個方法,就能夠經過MethodInvokingJobDetailFactoryBean來調用。
  5. Job:是一個接口,只有一個方法void execute(JobExecutionContext context),開發者實現該接口定義運行任務,JobExecutionContext類提供了調度上下文的各類信息。Job運行時的信息保存在JobDataMap實例中。實現Job接口的任務,默認是無狀態的,若要將Job設置成有狀態的,在quartz中是給實現的Job添加@DisallowConcurrentExecution註解(之前是實現StatefulJob接口,如今已被Deprecated),在與spring結合中能夠在spring配置文件的job detail中配置concurrent參數。

我這裏簡單記錄使用過程及代碼:async

1:首先引用Quartz組件分佈式

2:using Quartz;using Quartz.Impl;函數

注:在本地新建一個控制檯項目,將如下代碼copy過去便可用,只須要重寫Execute方法便可。Quartz3.0及以上的版本是採用的異步,3.0如下的版本沒有采用異步,使用方法是同樣的ui

主函數入口文件:spa

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using log4net;
using Quartz.Impl;

namespace Quartz
{
    class Program
    {
        private static readonly ILog _log = LogManager.GetLogger(typeof(Program));

        private static readonly string tiggerName = "TestJobTrigger";
        private static readonly string gropName = "TestJobTriggerGrop";
        private static readonly string jobName = "TestJob";
        //從工廠中獲取一個調度器實例化
        private static IScheduler scheduler = null;

        static void Main(string[] args)
        {
            Console.WriteLine("開始任務....");
            _log.Debug("開始任務....");
            Start();
        }

        private static async void Start()
        {
            //從工廠中獲取一個調度器實例化
            scheduler = await StdSchedulerFactory.GetDefaultScheduler();
            await scheduler.Start();


            //建立一個做業
            IJobDetail job1 = JobBuilder.Create<HelloJob>()
             .WithIdentity(jobName, gropName)
             .UsingJobData("key", "value")// 傳遞參數 在Execute方法中獲取(以什麼類型值傳入,取值就用相應的類型方法取值)
             .Build();

            // 建立觸發器
            ITrigger trigger1 = TriggerBuilder.Create()
                                        .WithIdentity(tiggerName, gropName)
                                        .StartNow()                        //如今開始
                                        .WithSimpleSchedule(x => x         //觸發時間,10秒一次。
                                            .WithIntervalInSeconds(10)
                                            .RepeatForever())              //不間斷重複執行
                                        .Build();


            await scheduler.ScheduleJob(job1, trigger1);      //把做業,觸發器加入調度器。

            Console.ReadKey();

            // 清除任務和觸發器
          //  ClearJobTrigger();
        }

        /// <summary>
        /// 清除任務和觸發器
        /// </summary>
        private static void ClearJobTrigger()
        {
            TriggerKey triggerKey = new TriggerKey(tiggerName, gropName);
            JobKey jobKey = new JobKey(jobName, gropName);
            if (scheduler != null)
            {
                scheduler.PauseTrigger(triggerKey);
                scheduler.UnscheduleJob(triggerKey);
                scheduler.DeleteJob(jobKey);
                scheduler.Shutdown();// 關閉
            }

        }


    }
}

 實現IJob 接口的任務文件.net

using System;
using System.Threading.Tasks;
using log4net;

namespace Quartz
{
    public class HelloJob : IJob
    {
        private readonly ILog _log = LogManager.GetLogger(typeof(HelloJob));
        public async Task Execute(IJobExecutionContext context)
        {
            JobDataMap dataMap = context.JobDetail.JobDataMap;
            string k = dataMap.GetString("key");//獲取參數(可根據傳遞的類型使用GetInt、GetFloat、GetString.....)

            _log.Debug("run TestJob debug");
            _log.Error("run TestJob error");
            _log.Info("run TestJob info");
            // 在這裏處理你的任務
            string dt = DateTime.Now.ToUniversalTime().ToString();
            Console.WriteLine(dt);
        }
    }
}

 源碼下載地址:https://download.csdn.net/upload/11091082debug

相關文章
相關標籤/搜索