Quartz.NET Windows 服务示例

想必大家在项目中处理简单的后台持续任务或者定时触发任务的时候均使用 Thread 或者 Task 来完成，但是项目中的这种需求一旦多了的话就得将任务调度引入进来了，那今天就简单的介绍一下 Quartz.NET 基于 Windows 服务宿主是怎样配置使用的。

Quartz.NET 是一个优秀的任务调度框架，移植于 Java 版的 Quartz 。

官网：http://www.quartz-scheduler.net

Github：https://github.com/quartznet/quartznet

示例环境

- .Net 4.5.2

- Quartz 2.4.1

- Common.Logging 3.3.1

- log4net 2.0.5

- Common.Logging.Log4Net1213 3.3.1

源码地址：https://github.com/Wlitsoft/QuartzNETWinServiceSample

配置

1. quartz.config

这个配置文件需要放在服务运行根目录下，用于指定 quartz 的一些运行配置，比如调度名称、线程池实现组件、线程池大小、任务配置文件路径等。

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

 quartz.scheduler.instanceName = QuartzNETWinServiceScheduler

 # 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 = ~/Conf/jobs.config

暂时需求需要修改的只有一处，看最后一行 quartz.plugin.xml.fileNames = ~/Conf/jobs.config 指定任务的配置文件路径。

2. 任务配置文件

 <?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>
     <job>
       <name>Job1</name>
       <group>Jobs</group>
       <description>任务1</description>
       <job-type>Wlitsoft.ProjectSample.QuartzNETWinService.Job.Job1,QuartzNETWinService</job-type>
       <durable>true</durable>
       <recover>false</recover>
     </job>
     <trigger>
       <simple>
         <name>Job1Trigger</name>
         <group>Jobs</group>
         <description>每 30 秒执行一次</description>
         <job-name>Job1</job-name>
         <job-group>Jobs</job-group>
         <repeat-count>-1</repeat-count>
         <repeat-interval>30000</repeat-interval>
       </simple>
     </trigger>
   </schedule>
 </job-scheduling-data>

以下为配置文件属性：

- 任务 （job 节点）

job 节点项说明
名称	类型	是否必填	默认值	描述
name	string	Y		任务名称
group	string	N	默认组名	任务组名称
description	string	N		任务描述
job-type	string	Y		任务的类型全名称，一般实现 IJob 接口
durable	boolean	N	false	任务完成后是否依然保存到数据库
recover	boolean	N	false	应用或服务重启之后是否忽略过期任务

- 触发器 （trigger 节点）

下面说下最常用的两种触发器：

1）简单触发器（simple 节点）用于触发定时轮训执行的任务。

simple 节点项说明
名称	类型	是否必填	默认值	描述
name	string	Y		触发器名称
group	string	N	默认组名	触发器名称
description	string	N		触发器描述
job-name	string	Y		要触发的任务的名称
job-group	string	Y		要触发的任务的组名称
repeat-count	int	Y	0	重复次数（0：不执行；-1：不限次数）
repeat-interval	long	Y	0	间隔时间（单位：毫秒）
start-time	date	N	当前时间	开始时间
end-time	date	N		结束时间（如果不指定则一直执行直到重复次数）

2）Cron 触发器（cron 节点）根据 cron 表达式触发任务。

cron 节点项说明
名称	类型	是否必填	默认值	描述
name	string	Y		触发器名称
group	string	N	默认组名	触发器名称
description	string	N		触发器描述
job-name	string	Y		要触发的任务的名称
job-group	string	Y		要触发的任务的组名称
cron	string	Y		规则表达式
start-time	date	N	当前时间	开始时间
end-time	date	N		结束时间

注：cron 表达式在线生成：http://cron.qqe2.com

3. 日志配置文件

1） app.config

- configSctions

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

- commong.logging 配置

 <common>
     <logging>
       <factoryAdapter type="Common.Logging.Log4Net.Log4NetLoggerFactoryAdapter, Common.Logging.Log4Net1213">
         <arg key="configType" value="FILE-WATCH" />
         <arg key="configFile" value="~/Conf/log4net.config" />
         <arg key="level" value="INFO" />
       </factoryAdapter>
     </logging>
 </common>

- configType : 用于指定日子配置文件类型，取值：INLINE - 在当前配置文件总；FILE-WATCH - 配置文件中。

- configFile：配置文件路径。

- level：日子输出级别。

- log4net 配置

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

     <logger name="job1" additivity="false" >
       <level value="ALL" />
       <appender-ref ref="Job1TxtAppender" />
     </logger>

     <appender name="Job1TxtAppender" type="log4net.Appender.RollingFileAppender">
       <file value="log/job1.txt" />
       <appendToFile value="true" />
       <param name="MaxSizeRollBackups" value="10"/>
       <param name="MaximumFileSize" value="10240KB"/>
       <param name="RollingStyle" value="Size"/>
       <param name="StaticLogFileName" value="true"/>
       <layout type="log4net.Layout.PatternLayout">
         <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
       </layout>
     </appender>

     <appender name="InfoFileAppender" type="log4net.Appender.RollingFileAppender">
       <file value="log/" />
       <appendToFile value="true" />
       <param name="DatePattern" value="yyyy-MM-dd'.txt'" />
       <rollingStyle value="Date" />
       <maxSizeRollBackups value="100" />
       <maximumFileSize value="1024KB" />
       <staticLogFileName value="false" />
       <Encoding value="UTF-8" />
       <filter type="log4net.Filter.LevelRangeFilter">
         <param name="LevelMin" value="INFO" />
         <param name="LevelMax" value="INFO" />
       </filter>
       <layout type="log4net.Layout.PatternLayout">
         <conversionPattern value="%date %-5level %logger  - %message%newline" />
       </layout>
     </appender>
     <appender name="ErrorFileAppender" type="log4net.Appender.RollingFileAppender">
       <file value="log/error.txt" />
       <appendToFile value="true" />
       <rollingStyle value="Size" />
       <maxSizeRollBackups value="100" />
       <maximumFileSize value="10240KB" />
       <staticLogFileName value="true" />
       <Encoding value="UTF-8" />
       <filter type="log4net.Filter.LevelRangeFilter">
         <param name="LevelMin" value="WARN" />
         <param name="LevelMax" value="FATAL" />
       </filter>
       <layout type="log4net.Layout.PatternLayout">
         <conversionPattern value="%date %-5level %logger - %message%newline" />
       </layout>
     </appender>
     <root>
       <level value="INFO" />
       <appender-ref ref="InfoFileAppender" />
       <appender-ref ref="ErrorFileAppender" />
     </root>
   </log4net>

 </configuration>

log4net.config

主程序代码：

 using System.ServiceProcess;
 using Common.Logging;
 using Quartz;
 using Quartz.Impl;

 namespace Wlitsoft.ProjectSample.QuartzNETWinService
 {
     public partial class MainService : ServiceBase
     {
         #region 私有属性

         //日志记录这。
         private readonly ILog _logger;

         //调度器。
         private readonly IScheduler _scheduler;

         #endregion

         #region 构造方法

         /// <summary>
         /// 初始化 <see cref="MainService"/> 类的新实例。
         /// </summary>
         public MainService()
         {
             InitializeComponent();
             this._logger = LogManager.GetLogger(this.GetType());
             StdSchedulerFactory factory = new StdSchedulerFactory();
             this._scheduler = factory.GetScheduler();
         }

         #endregion

         protected override void OnStart(string[] args)
         {
             this._scheduler.Start();
             this._logger.Info("服务启动");
         }

         protected override void OnStop()
         {
             if (!this._scheduler.IsShutdown)
                 this._scheduler.Shutdown();
             this._logger.Info("服务停止");
         }

         protected override void OnPause()
         {
             this._scheduler.PauseAll();
             base.OnPause();
         }

         protected override void OnContinue()
         {
             this._scheduler.ResumeAll();
             base.OnContinue();
         }
     }
 }

示例任务代码：

 using Common.Logging;
 using Quartz;

 namespace Wlitsoft.ProjectSample.QuartzNETWinService.Job
 {
     public class Job1 : IJob
     {
         //日志构造者。
         private static readonly ILog Logger = LogManager.GetLogger("job1");

         #region Implementation of IJob

         /// <summary>
         /// Called by the <see cref="T:Quartz.IScheduler" /> when a <see cref="T:Quartz.ITrigger" />
         /// fires that is associated with the <see cref="T:Quartz.IJob" />.
         /// </summary>
         /// <remarks>
         /// The implementation may wish to set a  result object on the
         /// JobExecutionContext before this method exits.  The result itself
         /// is meaningless to Quartz, but may be informative to
         /// <see cref="T:Quartz.IJobListener" />s or
         /// <see cref="T:Quartz.ITriggerListener" />s that are watching the job's
         /// execution.
         /// </remarks>
         /// <param name="context">The execution context.</param>
         public void Execute(IJobExecutionContext context)
         {
             string jobDes = context.JobDetail.Description;
             Logger.Info($"{jobDes}运行");
         }

         #endregion
     }
 }

源码地址：https://github.com/Wlitsoft/QuartzNETWinServiceSample

推荐阅读：一个技术汪的开源梦