Quartz.NET作业调度框架的简单应用

概述

Quartz.NET是一个开源的作业调度框架，非常适合在平时的工作中，定时轮询数据库同步，定时邮件通知，定时处理数据等。 Quartz.NET允许开发人员根据时间间隔（或天）来调度作业。它实现了作业和触发器的多对多关系，还能把多个作业与不同的触发器关联。整合了 Quartz.NET的应用程序可以重用来自不同事件的作业，还可以为一个事件组合多个作业。

参考

https://www.quartz-scheduler.net/

案例

第一步:安装
新建一个QuartzDemo项目后,安装下面的程序包

> Install-Package Quartz
> Install-Package log4net
> Install-Package Topshelf
> Install-Package Topshelf.Log4Net
Quartz依赖Common.Logging，又因为Log4Net是比较标准的日志工具，因此我们一般都会安装log4net，另外定时作业一般都允许在后台服务中，因此我们也安装了Topshelf。

第二步:实现IJob

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调度任务
ServiceRunner.cs

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

# 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 =
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 =
#quartz.scheduler.exporter.bindName = QuartzScheduler
#quartz.scheduler.exporter.channelType = tcp
#quartz.scheduler.exporter.channelName = httpQuartz

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>
<job>
<!--任务名称，同一个group中多个job的name不能相同，若未设置group则所有未设置group的job为同一个分组（必须设置）-->
<name>UserCount</name>
<!--任务所属分组，用于标识任务所属分组-->
<group>UserCount</group>
<!--工作任务的描述，用于描述任务具体内容-->
<description>私募版用户统计</description>
<!--任务类型，任务的具体类型及所属程序集，格式：实现了IJob接口的包含完整命名空间的类名,程序集名称-->
<job-type>Trumgu_BI_PF.UserCountJob,Trumgu_BI_PF</job-type>
<durable>true</durable>
<!--<durable>（持久性）-如果一个Job是不持久的， 一旦没有触发器与之关联，它就会被从scheduler 中自动删除-->
<recover>false</recover>
</job>

<!--trigger 任务触发器，用于定义使用何种方式触发任务(job)，同一个job可以定义多个trigger ，多个trigger 各自独立的执行调度，每个trigger 中必须且只能定义一种触发器类型(calendar-interval、simple、cron)
calendar-interval 一种触发器类型，使用较少，此处略过-->
<trigger>
<!--cron复杂任务触发器使用cron表达式定制任务调度-->
<cron>
<!--触发器名称，同一个分组中的名称必须不同-->
<name>UserCountTrigger</name>
<!--触发器组-->
<group>UserCount</group>
<!--触发器描述-->
<description>每周六14:00触发</description>
<!--要调度的任务名称，该job-name必须和对应job节点中的name完全相同-->
<job-name>UserCount</job-name>
<!--调度任务(job)所属分组，该值必须和job中的group完全相同-->
<job-group>UserCount</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，根据规则执行任务调度，一般若无特殊需要请不要设置此属性-->
<!-- <start-time>2018-04-26T15:30:00+08:00</start-time>-->
<!--cron表达式-->
<cron-expression>0 0 14 ? * 7</cron-expression>
</cron>
</trigger>

<job>
<!--任务名称，同一个group中多个job的name不能相同，若未设置group则所有未设置group的job为同一个分组（必须设置）-->
<name>Mass</name>
<!--任务所属分组，用于标识任务所属分组-->
<group>Mass</group>
<!--工作任务的描述，用于描述任务具体内容-->
<description>脚本执行并群发邮件</description>
<!--任务类型，任务的具体类型及所属程序集，格式：实现了IJob接口的包含完整命名空间的类名,程序集名称-->
<job-type>Trumgu_BI_PF.MassHair,Trumgu_BI_PF</job-type>
<durable>true</durable>
<!--<durable>（持久性）-如果一个Job是不持久的， 一旦没有触发器与之关联，它就会被从scheduler 中自动删除-->
<recover>false</recover>
</job>

<!--trigger 任务触发器，用于定义使用何种方式触发任务(job)，同一个job可以定义多个trigger ，多个trigger 各自独立的执行调度，每个trigger 中必须且只能定义一种触发器类型(calendar-interval、simple、cron)
calendar-interval 一种触发器类型，使用较少，此处略过-->
<trigger>
<!--cron复杂任务触发器使用cron表达式定制任务调度-->
<cron>
<!--触发器名称，同一个分组中的名称必须不同-->
<name>MassTrigger</name>
<!--触发器组-->
<group>Mass</group>
<!--触发器描述-->
<description>每周六14:30触发</description>
<!--要调度的任务名称，该job-name必须和对应job节点中的name完全相同-->
<job-name>Mass</job-name>
<!--调度任务(job)所属分组，该值必须和job中的group完全相同-->
<job-group>Mass</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，根据规则执行任务调度，一般若无特殊需要请不要设置此属性-->
<!-- <start-time>2018-04-26T15:30:00+08:00</start-time>-->
<!--cron表达式-->
<cron-expression>0 30 14 ? * 7</cron-expression>
</cron>
</trigger>
</schedule>
</job-scheduling-data>

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>

第六步:安装服务
cmd进入项目目录

安装：TopshelfDemo.exe install
启动：TopshelfDemo.exe start
卸载：TopshelfDemo.exe uninstall

搞定
============