首页 > 代码库 > 定时调度框架：Quartz.net

定时调度框架：Quartz.net

2024-10-22 03:20:02   211人阅读

Quartz.net相关概念

经常出现场景：定时轮询数据库同步，定时邮件通知，定时处理数据等

  • Scheduler （计划者或调度器）
  • Job （工作对象）：将要定时执行的任务代码写到实现Ijob接口的Execute方法中即可
  • Trigger（触发器）：什么条件情况下触发

其中常用的触发器有：

  1. SimpleTrigger <普通的Trigger> -- SimpleScheduleBuilder
  2. CronTrigger <带Cron Like 表达式的Trigger> -- CronScheduleBuilder

基于代码形式实现

一、实现IJob，在Execute方法里编写要处理的业务逻辑，系统就会按照Quartz的配置，定时处理。

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

namespace QuarztDemo1
{
    public class TestJob:IJob
    {
        public void Execute(IJobExecutionContext context)
        {
            Console.WriteLine(DateTime.Now.ToString());
        }
    }
}

二、调度任务

  1、创建调度工厂();    //工厂模式
   2、根据工厂取得调度器实例();  //工厂模式
   3、Builder模式构建子组件<Job,Trigger>  // builder模式, 如JobBuilder、TriggerBuilder、DateBuilder
   4、通过调度器组装子组件   调度器.组装<子组件1,子组件2...>  //工厂模式
   5、调度器.start(); //工厂模式
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Quartz;
using Quartz.Impl;

namespace QuarztDemo1
{
    class Program
    {
        static void Main(string[] args)
        {
            //1.首先创建一个作业调度池
            ISchedulerFactory schedf = new StdSchedulerFactory();
            IScheduler sched = schedf.GetScheduler();
            //2.创建出来一个具体的作业
            IJobDetail job = JobBuilder.Create<TestJob>().Build();
            //3.创建并配置一个触发器

            #region（使用ISimpleTrigger触发器，每次3秒执行一次，无上限）
            //ISimpleTrigger trigger = (ISimpleTrigger)TriggerBuilder.Create().WithSimpleSchedule(x => x.WithIntervalInSeconds(3).WithRepeatCount(int.MaxValue)).Build();
            #endregion

            #region 每3秒执行一次 总共5次 ，开始执行时间设定在当前时间，结束时间我设定在2小时后，不过5次执行完没2小时候都不再执行。
            //-------NextGivenSecondDate：如果第一个参数为null则表名当前时间往后推迟2秒的时间点。
            //DateTimeOffset startTime = DateBuilder.NextGivenSecondDate(DateTime.Now.AddSeconds(5), 2);
            //DateTimeOffset endTime = DateBuilder.NextGivenSecondDate(DateTime.Now.AddHours(2), 3);
            //ISimpleTrigger trigger = (ISimpleTrigger)TriggerBuilder.Create().StartAt(startTime).EndAt(endTime)
            //                            .WithSimpleSchedule(x => x.WithIntervalInSeconds(3).WithRepeatCount(5))
            //                            .Build();
            #endregion

            #region （使用CronTrigger 触发器）在每小时的第10，20，25，26，33，54分钟，每分钟的第1，10，14秒执行一次
            DateTimeOffset startTime = DateBuilder.NextGivenSecondDate(DateTime.Now.AddSeconds(1), 2);
            DateTimeOffset endTime = DateBuilder.NextGivenSecondDate(DateTime.Now.AddYears(2), 3);
            ICronTrigger trigger = (ICronTrigger)TriggerBuilder.Create().StartAt(startTime).EndAt(endTime)
                                        .WithCronSchedule("1,10,59 10,20,21,26,33,54 * * * ? ")
                                        .Build();
            #endregion
           //4.加入作业调度池中
            sched.ScheduleJob(job, trigger);
            //5.开始运行
            sched.Start();
            Console.ReadKey();
        }
    }
}

 基于配置文件形式

配置app.config或web.config 文件

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="quartz" type="System.Configuration.NameValueSectionHandler, System, Version=1.0.5000.0,Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
    <sectionGroup name="common">
      <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging"/>
    </sectionGroup>
  </configSections>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>
  
  <quartz>
    <add key="quartz.scheduler.instanceName" value="http://www.mamicode.com/ExampleDefaultQuartzScheduler"/>
    <add key="quartz.threadPool.type" value="http://www.mamicode.com/Quartz.Simpl.SimpleThreadPool, Quartz"/>
    <add key="quartz.threadPool.threadCount" value="http://www.mamicode.com/10"/>
    <add key="quartz.threadPool.threadPriority" value="http://www.mamicode.com/2"/>
    <add key="quartz.jobStore.misfireThreshold" value="http://www.mamicode.com/60000"/>
    <add key="quartz.jobStore.type" value="http://www.mamicode.com/Quartz.Simpl.RAMJobStore, Quartz"/>
    <!--******************************Plugin配置********************************************* -->
    <add key="quartz.plugin.xml.type" value="http://www.mamicode.com/Quartz.Plugin.Xml.XMLSchedulingDataProcessorPlugin, Quartz" />
    <add key="quartz.plugin.xml.fileNames" value="http://www.mamicode.com/~/quartz_jobs.xml"/> <!--指向指定的jobs.xml -->
  </quartz> 
</configuration>

 quartz_jobs.xml文件

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

<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>jobName1</name>
      <group>jobGroup1</group>
      <description>jobDesciption1</description>
      <job-type>QuarztDemo1.TestJob, QuarztDemo1</job-type>
      <durable>true</durable>
      <recover>false</recover>
    </job>
   
    <trigger>
      <simple>　　<!--SimpleTrigger触发器--> 
        <name>simpleName</name>
        <group>simpleGroup</group>
        <description>SimpleTriggerDescription</description>
        <job-name>jobName1</job-name>
        <job-group>jobGroup1</job-group>
        <start-time>1982-06-28T18:15:00.0Z</start-time>
        <end-time>2020-05-04T18:13:51.0Z</end-time>
        <repeat-count>10</repeat-count>
        <repeat-interval>3000</repeat-interval>
      </simple>
    </trigger>

  </schedule>
  
</job-scheduling-data>

其中触发器也可以是Cron复杂任务触发器，代码如下

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

节点释义：

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)

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


联系
我们