淺談Quartz.Net 從無到有創建實例

一、Quartz.Net介紹

　　Quartz.NET是一個開源的作業調度框架，非常適合在平時的工作中，定時輪詢數據庫同步，定時郵件通知，定時處理數據等。 Quartz.NET允許開發人員根據時間間隔（或天）來調度作業。它實現了作業和觸發器的多對多關系，還能把多個作業與不同的觸發器關聯。整合了 Quartz.NET的應用程序可以重用來自不同事件的作業，還可以為一個事件組合多個作業。在我平時的工作中對於Quartz的使用比較頻繁，正好利用空閑時間把這個做一個記錄。

二、快速搭建

1.利用VS創建一個控制台的項目

2.利用NuGet工具包安裝所需要的依賴包

3.首先安裝：Quartz，這里選擇我的項目一直在用的2.6的版本，目前為止最新的已經到了3.x

安裝完成之后在引用里面會多了一些新的引用

 

4.安裝我們的日志依賴包：log4net

5.安裝搭建服務用的：Topshelf 以及其所依賴的 Topshelf.Log4Net

 

至此，所用到的包基本已經安裝完畢，下面是添加三個程序文件和三個配置文件。

6.添加我們的測試程序文件：JobTest.cs，該文件實現Quartz的IJob接口

using System;
using log4net;
using Quartz;

namespace JobTest
{
    public class TestJob : IJob
    {
        private readonly ILog _logger = LogManager.GetLogger(typeof(TestJob));
        public void Execute(IJobExecutionContext context)
        {
            _logger.InfoFormat("測試輸出");
        }
    }
}

7.添加用於Topshelf調度的文件：ServiceRunner.cs

using Quartz;
using Quartz.Impl;
using Topshelf;

namespace JobTest
{
    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;
        }
    }
}

8.添加程序的入口文件：Program.cs

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Topshelf;

namespace JobTest
{
    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("定時作業");
                x.SetDisplayName("JobTest");
                x.SetServiceName("JobTest");

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

9.添加配置文件：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\JobTest\"/>
      <!--是否是向文件中追加日志-->
      <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>

10.添加配置文件：quartz.config

# 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

11.添加配置文件：quartz_jobs.xml

<?xml version="1.0" encoding="UTF-8"?>

<!-- This file contains job definitions in schema version 2.0 format -->

<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>

    <!--TestJob測試 任務配置-->
    <job>
      <name>TestJob</name>
      <group>Test</group>
      <description>TestJob測試</description>
      <job-type>JobTest.TestJob,JobTest</job-type>
      <durable>true</durable>
      <recover>false</recover>
    </job>
    <trigger>
      <cron>
        <name>TestJobTrigger</name>
        <group>Test</group>
        <job-name>TestJob</job-name>
        <job-group>Test</job-group>
        <start-time>2015-01-22T00:00:00+08:00</start-time>
        <cron-expression>0/3 * * * * ?</cron-expression>
      </cron>
    </trigger>
  </schedule>
</job-scheduling-data>

注意：在這個xml文件中，job-type節點的配置容易出錯，我總結了一下，逗號之前的是我們將要運行的程序命名空間的地址

 

逗號之前：JobTest.TestJob

逗號之后是整個項目的命名空間，我們這里就是這個    JobTest

12.需要將三個配置文件的屬性設置為始終復制，或者如果較新則復制，應該也是沒問題的

 

13.啟動項目，就可以看到如下效果

 

三、搭建服務

1.將項目的生成方式切換成Release，至於Release和Debug的區別，可自行百度啦

然后重新生成項目

2.找到項目生成的文件夾，此時會發現一個JobTest.exe的文件，也是我們搭建服務所用的主文件

3.以管理員的身份運行cmd，並切換到上面程序生成的路徑，之后輸入JobTest.exe install 安裝服務：

 

4.啟動服務

 

5.此時，在我們的服務里就已經能看到我們創建的JobTest的服務了，並且已經啟動了：

 

6.此時，在我們之前的配置文件log4net.config中找到服務生成的日志文件的路徑，並切換到該路徑就可以看到生成的日志文件：

7.最后，友情提示，將服務關閉並卸載服務（JobTest.exe uninstall）：

 

四、總結

　　一個簡單的Quartz項目已經創建完成並生成了服務，可以定時去完成你指定的任何作業了。但是Quartz中還有一些問題非常重要。

　　首先就是quartz_jobs.xml文件中cron-expression節點的配置，該節點的配置內容決定了服務的定時循環作業的頻率，詳情可見博客：https://blog.csdn.net/lu_wei_wei/article/details/51251337

　　其次就是每次服務啟動，程序都會去運行一次，然后才會根據你設置的時間定時去運行，這樣很多時候是會有一些問題在里面的，具體的會在項目里面，遇到，到時候就需要用一些這種的方法去解決這些問題。

 

最后，盡情體驗Quartz.Net給你帶來的實現定時作業的快感吧！๑乛◡乛๑