Quartz.NET简介

Quartz.NET作业调度框架是伟大组织OpenSymphony开发的quartz scheduler项目的.net延伸移植版本。

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

下载项目官网 https://www.quartz-scheduler.net/

Quartz.NET使用入门

我的demo下载： https://github.com/yx09041/MyQuartz.git

现介绍一个简单的示例，做一个定时任务每隔三秒输出“我的定时任务测试”，如下：

运行结果：

创建控制台程序，并安装相关包

通过包管理器安装如下包

• Quartz
• Common.Logging.Log4Net1211
• log4net
• Topshelf
• Topshelf.Log4Net

项目整体结构

定义任务

定义任务实现IJob来执行对应的任务逻辑，在Execute方法里编写要处理的业务逻辑，系统就会按照Quartz的配置，定时处理。

如这里任务执行的是输出日志“我的定时任务测试”，如有多个任务可再这里添加多个任务类（注意要实现IJob）

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

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

        public void Execute(IJobExecutionContext context)
        {

            _logger.InfoFormat("我的定时任务测试");
        }
    }
}

使用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 MyQuartzJobs
{
    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;
        }
    }
}

程序入口

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

namespace MyQuartzJobs
{
    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("MyService");
                x.SetServiceName("我的通用定时服务");
                x.EnablePauseAndContinue();
            });
        }
    }
}

配置配置文件

quartz.config、quartz_jobs.xml、log4net.config

设置三个文件的属性为始终复制

quartz.config配置

quartz_jobs.xml配置   如下设置为每隔3秒执行一次

具体配置参数说明参考 quartz_jobs.xml配置

log4net.config是常用的日志组件，配置这里就不再介绍了

服务运行查看效果

运行exe程序可看到运行效果

安装为windows服务

用管理员模式运行cmd命令行切换到对应的程序的目录下运行如下命令可进行服务的安装/启动和卸载/;

安装：MyQuartzJobs.exe install

启动：MyQuartzJobs.exe start

卸载：MyQuartzJobs.exe uninstall

打开windows服务查看如下，启用即可运行

其它

quartz_jobs.xml配置

job 任务

其实就是1.x版本中的<job-detail>，这个节点是用来定义每个具体的任务的，多个任务请创建多个job节点即可

• name(必填) 任务名称，同一个group中多个job的name不能相同，若未设置group则所有未设置group的job为同一个分组，如:<name>sampleJob</name>
• group(选填) 任务所属分组，用于标识任务所属分组，如:<group>sampleGroup</group>
• description(选填) 任务描述，用于描述任务具体内容，如:<description>Sample job for Quartz Server</description>
• job-type(必填) 任务类型，任务的具体类型及所属程序集，格式：实现了IJob接口的包含完整命名空间的类名,程序集名称，如:<job-type>Quartz.Server.SampleJob, Quartz.Server</job-type>
• durable(选填) 具体作用不知，官方示例中默认为true，如:<durable>true</durable>
• recover(选填) 具体作用不知，官方示例中默认为false，如:<recover>false</recover>

trigger 任务触发器

用于定义使用何种方式出发任务(job)，同一个job可以定义多个trigger ，多个trigger 各自独立的执行调度，每个trigger 中必须且只能定义一种触发器类型(calendar-interval、simple、cron)

calendar-interval 一种触发器类型，使用较少，此处略过

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(选填) 触发器组d
• 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秒执行一次

Quartz的cron表达式

官方英文介绍地址：http://www.quartz-scheduler.net/documentation/quartz-2.x/tutorial/crontrigger.html

cron expressions 整体上还是非常容易理解的，只有一点需要注意："?"号的用法，看下文可以知道“？”可以用在 day of month 和 day of week中，他主要是为了解决如下场景，如：每月的1号的每小时的31分钟，正确的表达式是：* 31 * 1 * ？，而不能是：* 31 * 1 * *，因为这样代表每周的任意一天。

由7段构成：秒 分 时 日 月 星期 年（可选）
"-" ：表示范围  MON-WED表示星期一到星期三
"," ：表示列举 MON,WEB表示星期一和星期三
"*" ：表是“每”，每月，每天，每周，每年等
"/" :表示增量：0/15（处于分钟段里面） 每15分钟，在0分以后开始，3/20 每20分钟，从3分钟以后开始
"?" :只能出现在日，星期段里面，表示不指定具体的值
"L" :只能出现在日，星期段里面，是Last的缩写，一个月的最后一天，一个星期的最后一天（星期六）
"W" :表示工作日，距离给定值最近的工作日
"#" :表示一个月的第几个星期几，例如："6#3"表示每个月的第三个星期五（1=SUN...6=FRI,7=SAT）

官方

参考文章：

Quartz.net开源作业调度框架使用详解

使用Topshelf创建Windows服务

Quartz.NET 入门