欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

C#中Quartz的简单易懂定时任务实现

程序员文章站 2023-04-06 20:53:57
作为一个优秀的开源调度框架,Quartz 具有以下特点: 另外,作为 Spring 默认的调度框架,Quartz 很容易与 Spring 集成实现灵活可配置的调度功能。 quartz调度核心元素: 我这里简单记录使用过程及代码: 1:首先引用Quartz组件 2:using Quartz;using ......

 作为一个优秀的开源调度框架,quartz 具有以下特点:

  1. 强大的调度功能,例如支持丰富多样的调度方法,可以满足各种常规及特殊需求;
  2. 灵活的应用方式,例如支持任务和调度的多种组合方式,支持调度数据的多种存储方式;
  3. 分布式和集群能力,terracotta 收购后在原来功能基础上作了进一步提升。

      另外,作为 spring 默认的调度框架,quartz 很容易与 spring 集成实现灵活可配置的调度功能。

    quartz调度核心元素:

  1. scheduler:任务调度器,是实际执行任务调度的控制器。在spring中通过schedulerfactorybean封装起来。
  2. trigger:触发器,用于定义任务调度的时间规则,有simpletrigger,crontrigger,dateintervaltrigger和nthincludeddaytrigger,其中crontrigger用的比较多,本文主要介绍这种方式。crontrigger在spring中封装在crontriggerfactorybean中。
  3. calendar:它是一些日历特定时间点的集合。一个trigger可以包含多个calendar,以便排除或包含某些时间点。
  4. jobdetail:用来描述job实现类及其它相关的静态信息,如job名字、关联监听器等信息。在spring中有jobdetailfactorybean和 methodinvokingjobdetailfactorybean两种实现,如果任务调度只需要执行某个类的某个方法,就可以通过methodinvokingjobdetailfactorybean来调用。
  5. job:是一个接口,只有一个方法void execute(jobexecutioncontext context),开发者实现该接口定义运行任务,jobexecutioncontext类提供了调度上下文的各种信息。job运行时的信息保存在jobdatamap实例中。实现job接口的任务,默认是无状态的,若要将job设置成有状态的,在quartz中是给实现的job添加@disallowconcurrentexecution注解(以前是实现statefuljob接口,现在已被deprecated),在与spring结合中可以在spring配置文件的job detail中配置concurrent参数。

我这里简单记录使用过程及代码:

1:首先引用quartz组件

2:using quartz;using quartz.impl;

注:在本地新建一个控制台项目,将以下代码copy过去即可用,只需要重写execute方法即可。quartz3.0及以上的版本是采用的异步,3.0以下的版本没有采用异步,使用方法是一样的

主函数入口文件:

using backgroundtask.job;
using log4net;
using quartz;
using quartz.impl;
using system;
using system.collections.generic;
using system.linq;
using system.text;
using system.threading.tasks;

namespace backgroundtask
{
    class program
    {
        private static readonly ilog _log = logmanager.getlogger(typeof(program));

        private static readonly string tiggername = "testjobtrigger";
        private static readonly string gropname = "testjobtriggergrop";
        private static readonly string jobname = "testjob";
        //从工厂中获取一个调度器实例化
        private static ischeduler scheduler = null;


        static void main(string[] args)
        {
            console.writeline("开始任务....");
            _log.debug("开始任务....");
            start();

        }

        private static async void start()
        {
            //从工厂中获取一个调度器实例化
            scheduler = await stdschedulerfactory.getdefaultscheduler();
            await scheduler.start();


            //创建一个作业
            ijobdetail job1 = jobbuilder.create<testjob>()
             .withidentity(jobname, gropname)
             .usingjobdata("key","value")// 传递参数 在execute方法中获取(以什么类型值传入,取值就用相应的类型方法取值)
             .build();

            // 创建触发器
            itrigger trigger1 = triggerbuilder.create()
                                        .withidentity(tiggername, gropname)
                                        .startnow()                        //现在开始
                                        .withsimpleschedule(x => x         //触发时间,10秒一次。
                                            .withintervalinseconds(10)
                                            .repeatforever())              //不间断重复执行
                                        .build();


            await scheduler.schedulejob(job1, trigger1);      //把作业,触发器加入调度器。

            console.readkey();

            // 清除任务和触发器
            clearjobtrigger();
        }

        /// <summary>
        /// 清除任务和触发器
        /// </summary>
        private static void clearjobtrigger()
        {
            triggerkey triggerkey = new triggerkey(tiggername, gropname);
            jobkey jobkey = new jobkey(jobname, gropname);
            if (scheduler != null)
            {
                scheduler.pausetrigger(triggerkey);
                scheduler.unschedulejob(triggerkey);
                scheduler.deletejob(jobkey);
                scheduler.shutdown();// 关闭
            }

        }

    }

}

  

实现ijob 接口的任务文件

using log4net;
using quartz;
using system;
using system.collections.generic;
using system.linq;
using system.text;
using system.threading.tasks;

namespace backgroundtask.job
{
    public class testjob : ijob
    {
        private readonly ilog _log = logmanager.getlogger(typeof(testjob));
        /// <summary>
        /// 测试作业
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public async task execute(ijobexecutioncontext context)
        { 

        jobdatamap datamap = context.jobdetail.jobdatamap;
        string k = datamap.getstring("key");//获取参数(可根据传递的类型使用getint、getfloat、getstring.....)

            _log.debug("run testjob debug");
            _log.error("run testjob error");
            _log.info("run testjob info");
            // 在这里处理你的任务
            
        }
    }
}