Quartz總結

Quartz.NET 入門

概述

Quartz.NET是一個開源的做業調度框架,很是適合在平時的工做中,定時輪詢數據庫同步,定時郵件通知,定時處理數據等。 Quartz.NET容許開發人員根據時間間隔(或天)來調度做業。它實現了做業和觸發器的多對多關係,還能把多個做業與不一樣的觸發器關聯。
整合了 Quartz.NET的應用程序能夠重用來自不一樣事件的做業,還能夠爲一個事件組合多個做業。數據庫

快速搭建一個Quartz

第一步:安裝

Install-Package Quartz
Install-Package Common.Logging.Log4Net1211
Install-Package log4net
Install-Package Topshelf
Install-Package Topshelf.Log4Net

Quartz依賴Common.Logging和Common.Logging.Log4Net1211,又由於Log4Net是比較標準的日誌工具,所以咱們通常都會安裝log4net,
另外定時做業通常都容許在後臺服務中,所以咱們也安裝了Topshelf。express

第二步:實現IJob

TestJob.cs 實現IJob,在Execute方法裏編寫要處理的業務邏輯,系統就會按照Quartz的配置,定時處理。c#

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

namespace QuartzDemo.QuartzJobs
{
    public sealed class TestJob : IJob
    {
        private readonly ILog _logger = LogManager.GetLogger(typeof(TestJob));

        public void Execute(IJobExecutionContext context)
        {
            _logger.InfoFormat("TestJob測試");
        }
    }
}

第三步:使用Topshelf調度任務

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

namespace QuartzDemo
{
    public sealed class ServiceRunner : ServiceControl, ServiceSuspend
    {
        private readonly IScheduler scheduler;

        public ServiceRunner()
        {
            scheduler = StdSchedulerFactory.GetDefaultScheduler();
        }

        public bool Start(HostControl hostControl)
        {
            scheduler.Start();
            return true;
        }

        public bool Stop(HostControl hostControl)
        {
            scheduler.Shutdown(false);
            return true;
        }

        public bool Continue(HostControl hostControl)
        {
            scheduler.ResumeAll();
            return true;
        }

        public bool Pause(HostControl hostControl)
        {
            scheduler.PauseAll();
            return true;
        }
    }
}

第四步:程序入口

namespace QuartzDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            log4net.Config.XmlConfigurator.ConfigureAndWatch(new FileInfo(AppDomain.CurrentDomain.BaseDirectory + "log4net.config"));
            HostFactory.Run(x =>
            {
                x.UseLog4Net();

                x.Service<ServiceRunner>();

                x.SetDescription("QuartzDemo服務描述");
                x.SetDisplayName("QuartzDemo服務顯示名稱");
                x.SetServiceName("QuartzDemo服務名稱");

                x.EnablePauseAndContinue();
            });
        }
    }
}

第五步:配置quartz.config、quartz_jobs.xml、log4net.config

quartz.config

因格式緣由在#前加了/,使用時去掉便可windows

/# You can configure your scheduler in either <quartz> configuration section
    /# or in quartz properties file
    /# Configuration section has precedence

    quartz.scheduler.instanceName = QuartzTest

    /# configure thread pool info
    quartz.threadPool.type = Quartz.Simpl.SimpleThreadPool, Quartz
    quartz.threadPool.threadCount = 10
    quartz.threadPool.threadPriority = Normal

    /# job initialization plugin handles our xml reading, without it defaults are used
    quartz.plugin.xml.type = Quartz.Plugin.Xml.XMLSchedulingDataProcessorPlugin, Quartz
    quartz.plugin.xml.fileNames = ~/quartz_jobs.xml

    /# export this server to remoting context
    /#quartz.scheduler.exporter.type = Quartz.Simpl.RemotingSchedulerExporter, Quartz
    /#quartz.scheduler.exporter.port = 555
    /#quartz.scheduler.exporter.bindName = QuartzScheduler
    /#quartz.scheduler.exporter.channelType = tcp
    /#quartz.scheduler.exporter.channelName = httpQuartz

quartz_jobs.xml

<job-scheduling-data xmlns="http://quartznet.sourceforge.net/JobSchedulingData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.0">
  <processing-directives>
    <overwrite-existing-data>true</overwrite-existing-data>
  </processing-directives>
  <schedule>
    <!--任務-->
    <job>
      <!--任務名稱,同一個group中多個job的name不能相同-->
      <name>SimpleJob</name>
      <!--任務分組-->
      <group>sampleGroup</group>
      <!--任務描述-->
      <description>Sample job for Quartz Server</description>
      <!--完整命名空間的類名及所屬程序集名稱-->
      <job-type>WindowsService.Job.SimpleJob, WindowsService</job-type>
      <durable>true</durable>
      <recover>false</recover>
    </job>
    <!--任務觸發器-->
    <trigger>
      <!--簡單任務的觸發器,能夠調度用於重複執行的任務-->
      <!--<simple>
        --><!--觸發器名稱,同一個分組中的名稱必須不一樣--><!--
        <name>sampleSimpleTrigger</name>
        --><!--觸發器組--><!--
        <group>sampleGroup</group>
        --><!--描述--><!--
        <description>Simple trigger to simply fire sample job</description>
        --><!--要調度的任務名稱,該job-name必須和對應job節點中的name徹底相同--><!--
        <job-name>SimpleJob</job-name>
        --><!--調度任務(job)所屬分組,該值必須和job中的group徹底相同--><!--
        <job-group>sampleGroup</job-group>
        --><!--任務開始時間--><!--
        --><!--<start-time>2017-08-21T11:10:00+08:00</start-time>--><!--
        <misfire-instruction>SmartPolicy</misfire-instruction>
        --><!--任務執行次數  -1 爲無限次執行--><!--
        <repeat-count>-1</repeat-count>
        --><!--任務觸發間隔(毫秒)--><!--
        <repeat-interval>1000</repeat-interval>
        --><!--每3秒中執行一次--><!--
      </simple>-->
      <cron>
        <name>JobTrigger</name>
        <group>JobTriggers</group>
        <description>cron trigger</description>
        <job-name>SimpleJob</job-name>
        <job-group>sampleGroup</job-group>
        <!--<start-time>2015-11-26T22:19:00+08:00</start-time>-->
        <cron-expression>0/2 * * * * ?</cron-expression>
      </cron>
    </trigger>
  </schedule>
</job-scheduling-data>
job 任務:用來定義每一個具體的任務的,多個任務請建立多個job節點便可

    + name(必填) 任務名稱,同一個group中多個job的name不能相同,若未設置group則全部未設置group的job爲同一個分組
    + group(選填) 任務所屬分組,用於標識任務所屬分組
    + description(選填) 任務描述,用於描述任務具體內容
    + job-type(必填) 任務類型,任務的具體類型及所屬程序集,格式:實現了IJob接口的包含完整命名空間的類名,程序集名稱
    + durable(選填) 具體做用不知,官方示例中默認爲true
    + recover(選填) 具體做用不知,官方示例中默認爲false

trigger 任務觸發器:用於定義使用何種方式出發任務(job),同一個job能夠定義多個trigger ,多個trigger 各自獨立的執行調度,
        每一個trigger 中必須且只能定義一種觸發器類型(calendar-interval、simple、cron)
    + simple 簡單任務的觸發器類型,能夠調度用於重複執行的任務
        * name(必填) 觸發器名稱,同一個分組中的名稱必須不一樣
        * group(選填) 觸發器組
        * description(選填) 觸發器描述
        * job-name(必填) 要調度的任務名稱,該job-name必須和對應job節點中的name徹底相同
        * job-group(選填) 調度任務(job)所屬分組,該值必須和job中的group徹底相同
        * start-time(選填) 任務開始執行時間utc時間,北京時間須要+08:00,
                如:<start-time>2012-04-01T08:00:00+08:00</start-time>表示北京時間2012年4月1日上午8:00開始執行,
                注意服務啓動或重啓時都會檢測此屬性,若沒有設置此屬性或者start-time設置的時間比當前時間較早,
                則服務啓動後會當即執行一次調度,若設置的時間比當前時間晚,服務會等到設置時間相同後纔會第一次執行任務,通常若無特殊須要請不要設置此屬性
        * repeat-count(必填)  任務執行次數,如:<repeat-count>-1</repeat-count>表示無限次執行,<repeat-count>10</repeat-count>表示執行10次
        * repeat-interval(必填) 任務觸發間隔(毫秒),如:<repeat-interval>10000</repeat-interval> 每10秒執行一次
    + cron:複雜任務觸發器--使用cron表達式定製任務調度
        * name(必填) 觸發器名稱,同一個分組中的名稱必須不一樣
        * group(選填) 觸發器組
        * escription(選填) 觸發器描述
        * job-name(必填) 要調度的任務名稱,該job-name必須和對應job節點中的name徹底相同
        * job-group(選填) 調度任務(job)所屬分組,該值必須和job中的group徹底相同
        * start-time(選填) 任務開始執行時間utc時間,北京時間須要+08:00,
                如:<start-time>2012-04-01T08:00:00+08:00</start-time>表示北京時間2012年4月1日上午8:00開始執行,
                注意服務啓動或重啓時都會檢測此屬性,若沒有設置此屬性,服務會根據cron-expression的設置執行任務調度;若start-time設置的時間比當前時間較早,則服務啓動後會忽略掉cron-expression設置,當即執行一次調度,以後再根據cron-expression執行任務調度;若設置的時間比當前時間晚,則服務會在到達設置時間相同後纔會應用cron-expression,
                根據規則執行任務調度,通常若無特殊須要請不要設置此屬性
        * cron-expression(必填) cron表達式,如:<cron-expression>0/10 * * * * ?</cron-expression>每10秒執行一次

log4net.config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
  </configSections>

  <log4net>
    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
      <!--日誌路徑-->
      <param name= "File" value= "D:\App_Log\servicelog\"/>
      <!--是不是向文件中追加日誌-->
      <param name= "AppendToFile" value= "true"/>
      <!--log保留天數-->
      <param name= "MaxSizeRollBackups" value= "10"/>
      <!--日誌文件名是不是固定不變的-->
      <param name= "StaticLogFileName" value= "false"/>
      <!--日誌文件名格式爲:2008-08-31.log-->
      <param name= "DatePattern" value= "yyyy-MM-dd&quot;.read.log&quot;"/>
      <!--日誌根據日期滾動-->
      <param name= "RollingStyle" value= "Date"/>
      <layout type="log4net.Layout.PatternLayout">
        <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n %loggername" />
      </layout>
    </appender>

    <!-- 控制檯前臺顯示日誌 -->
    <appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender">
      <mapping>
        <level value="ERROR" />
        <foreColor value="Red, HighIntensity" />
      </mapping>
      <mapping>
        <level value="Info" />
        <foreColor value="Green" />
      </mapping>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%n%date{HH:mm:ss,fff} [%-5level] %m" />
      </layout>

      <filter type="log4net.Filter.LevelRangeFilter">
        <param name="LevelMin" value="Info" />
        <param name="LevelMax" value="Fatal" />
      </filter>
    </appender>

    <root>
      <!--(高) OFF > FATAL > ERROR > WARN > INFO > DEBUG > ALL (低) -->
      <level value="all" />
      <appender-ref ref="ColoredConsoleAppender"/>
      <appender-ref ref="RollingLogFileAppender"/>
    </root>
  </log4net>
</configuration>

Quartz任務調度

泛型數組批量job(可用數據庫)+服務日誌+log4net打印日誌+製做windows服務數組

安裝

Install-Package Quartz(2.6.2)
Install-Package Common.Logging.Log4Net1211(3.0)
Install-Package Topshelf(3.2)
Install-Package Topshelf.Log4Net(3.2)

配置文件

<configSections>
    <sectionGroup name="common">
      <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" />
    </sectionGroup>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
  </configSections>

  <common>
    <logging>
      <factoryAdapter type="Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter, Common.Logging.Log4Net1211">
        <arg key="configType" value="INLINE" />
      </factoryAdapter>
    </logging>
  </common>

  <log4net>
    <!--錯誤日誌-->
    <!--自定義錯誤異常-->
    <appender name="CustomExAppender" type="log4net.Appender.RollingFileAppender">
      <param name="File" value="Log\\LogCustomEx\\" />
      <param name="AppendToFile" value="true" />
      <param name="MaxFileSize" value="10240" />
      <param name="MaxSizeRollBackups" value="100" />
      <param name="StaticLogFileName" value="false" />
      <param name="DatePattern" value="yyyy\\yyyyMM\\yyyyMMdd'.txt'" />
      <param name="RollingStyle" value="Date" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%newline %n記錄時間:%date %n線程ID:[%thread] %n日誌級別:  %-5level %n日誌描述:%message%newline %n" />
      </layout>
    </appender>

    <appender name="ErrorExAppender" type="log4net.Appender.RollingFileAppender">
      <param name="File" value="Log\\LogErrorEx\\" />
      <param name="AppendToFile" value="true" />
      <param name="MaxFileSize" value="10240" />
      <param name="MaxSizeRollBackups" value="100" />
      <param name="StaticLogFileName" value="false" />
      <param name="DatePattern" value="yyyy\\yyyyMM\\yyyyMMdd'.txt'" />
      <param name="RollingStyle" value="Date" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%newline %n記錄時間:%date %n線程ID:[%thread] %n日誌級別:  %-5level %n日誌描述:%message%newline %n" />
      </layout>
    </appender>

    <!--CustomEx日誌-->
    <logger name="LogCustomEx">
      <level value="INFO" />
      <appender-ref ref="CustomExAppender" />
    </logger>
    <!--Error日誌-->
    <logger name="LogErrorEx">
      <level value="ERROR" />
      <appender-ref ref="ErrorExAppender" />
    </logger>

    <!--服務執行日誌-->
    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
      <param name="File" value="Log\\ServerLog\\" />
      <param name="AppendToFile" value="true" />
      <param name="MaxFileSize" value="10240" />
      <param name="MaxSizeRollBackups" value="100" />
      <param name="StaticLogFileName" value="false" />
      <param name="DatePattern" value="yyyy\\yyyyMM\\yyyyMMdd'.txt'" />
      <param name="RollingStyle" value="Date" />
      <layout type="log4net.Layout.PatternLayout">
        <param name="ConversionPattern" value="%n%date{HH:mm:ss,fff} [%-5level] %m" />
      </layout>
    </appender>

    <!-- 控制檯前臺顯示日誌 -->
    <appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender">
      <mapping>
        <level value="ERROR" />
        <foreColor value="Red, HighIntensity" />
      </mapping>
      <mapping>
        <level value="Info" />
        <foreColor value="Green" />
      </mapping>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%n%date{HH:mm:ss,fff} [%-5level] %m" />
      </layout>
      <filter type="log4net.Filter.LevelRangeFilter">
        <param name="LevelMin" value="Info" />
        <param name="LevelMax" value="Fatal" />
      </filter>
    </appender>

    <root>
      <!--(高) OFF > FATAL > ERROR > WARN > INFO > DEBUG > ALL (低) -->
      <level value="all" />
      <appender-ref ref="ColoredConsoleAppender" />
      <appender-ref ref="RollingLogFileAppender" />
    </root>

  </log4net>

相關Job類

JobInfo對象(任務信息),JobType類型

任務信息:名稱、觸發器、羣組、類型(根據不一樣的類型執行不一樣的Job內容app

public class JobInfo
    {
        public JobInfo(string jobName, string group, string trigger, JobType jobType)
        {
            if (jobName == null || trigger == null || group == null)
            {
                throw new ArgumentNullException("jobName");
            }
            this.JobName = jobName;
            this.Trigger = trigger;
            this.Group = group;
            this.JobType = jobType;
        }

        /// <summary>
        /// 名稱
        /// </summary>
        public string JobName { get; set; }

        /// <summary>
        /// Job的觸發器  cron表達式
        /// </summary>
        public string Trigger { get; set; }

        /// <summary>
        /// 羣組
        /// </summary>
        public string Group { get; set; }

        /// <summary>
        /// Job類型
        /// </summary>
        public JobType JobType { get; set; }
    }

    /// <summary>
    /// Job類型枚舉
    /// </summary>
    public enum JobType
    {
        /// <summary>
        /// 任務1
        /// </summary>
        Job1 = 1,
        /// <summary>
        /// 任務2
        /// </summary>
        Job2 = 2
    }

JobInfoList任務集合

模擬的任務集合,實際應用中可固定,可從數據庫中獲取框架

public class JobInfoList
{
    /// <summary>
    /// 腳本服務組
    /// </summary>
    public static List<JobInfo> JobList_ZhongShanHos = new List<JobInfo>
    {
        new JobInfo("任務1", "測試腳本", "*/5 * * * * ?", JobType.Job1),
        new JobInfo("任務2", "測試腳本", "*/7 * * * * ?", JobType.Job2)
    };
}

Job內容

配置具體的Job內容與須要輸出的自定義日誌,這裏的日誌使用log4net做爲記錄tcp

using System;
using Quartz;

namespace T5.Jobs
{
    public class TestJob : IJob
    {
        private static readonly log4net.ILog LogInfo = log4net.LogManager.GetLogger("LogCustomEx");
        private static readonly log4net.ILog LogError = log4net.LogManager.GetLogger("LogError");

        public void Execute(IJobExecutionContext context)
        {
            var map = context.JobDetail.JobDataMap;
            var jobInfo = map["KEY"] as JobInfo;
            if (jobInfo == null) { return; }

            //記錄日誌
            LogInfo.Info("\n【服務已啓動】" + "\n【啓動組】:" + jobInfo.Group + "\n【啓動名稱】:" + jobInfo.JobName + "\n【啓動時間】:" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));

            try
            {
                switch (jobInfo.JobType)
                {
                    //基礎信息
                    case JobType.Job1: LogInfo.Info("這是任務1"); break;
                    case JobType.Job2: LogInfo.Info("這是任務2"); break;

                    default: break;
                }
            }
            catch (Exception ex)
            {
                //記錄日誌
                LogError.Error("\n【服務執行出錯】" +
                              "\n【啓動組】:" + jobInfo.Group +
                              "\n【啓動名稱】:" + jobInfo.JobName +
                              "\n【時間】:" + DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss") +
                              "\n【錯誤信息】:" + ex.Message);
                return;
            }
        }
    }

}

配置Job執行方法

using System.Collections.Generic;
using Quartz;
using Quartz.Impl;
using T5.Jobs;
using Topshelf;

namespace T5
{
    public sealed class ServerRunner : ServiceControl, ServiceSuspend
    {
        private readonly IScheduler scheduler;

        public ServerRunner()
        {
            scheduler = StdSchedulerFactory.GetDefaultScheduler();
        }

        public bool Start(HostControl hostControl)
        {
            var jobList = new List<JobInfo>();

            //配置JobList任務
            jobList.AddRange(JobInfoList.JobList_ZhongShanHos);

            jobList.ForEach(
                x =>
                {
                    var dic = new Dictionary<string, JobInfo> { { "KEY", x } };
                    var map = new JobDataMap(dic);
                    var job =
                        JobBuilder.Create<TestJob>()
                            .WithIdentity(x.JobName, x.Group)
                            .UsingJobData(map)
                            .RequestRecovery()
                            .Build();
                    var trigger =
                        TriggerBuilder.Create()
                            .WithIdentity(x.JobName, x.Group)
                            .WithCronSchedule(x.Trigger)
                            .Build();
                    scheduler.ScheduleJob(job, trigger);
                });
            scheduler.Start();
            return true;
        }

        public bool Stop(HostControl hostControl)
        {
            scheduler.Shutdown(false);
            return true;
        }

        public bool Continue(HostControl hostControl)
        {
            scheduler.ResumeAll();
            return true;
        }

        public bool Pause(HostControl hostControl)
        {
            scheduler.PauseAll();
            return true;
        }
    }
}

配置入口文件

using Topshelf;

namespace T5
{
    class Program
    {
        static void Main(string[] args)
        {
            //配置Log4日誌
            log4net.Config.XmlConfigurator.Configure();

            //Windows服務
            HostFactory.Run(x =>
            {
                x.UseLog4Net();

                x.Service<ServerRunner>();

                x.SetDescription("Quartz日誌記錄服務");
                x.SetDisplayName("Quartz");
                x.SetServiceName("QuartzLog");

                x.EnablePauseAndContinue();
            });
        }
    }
}
相關文章
相關標籤/搜索