C# Quartz结合控制台实现定时任务

前言：

Quartz一个开源的作业调度框架，是OpenSymphony 的 Quartz API的.NET移植，基于C#写成，可应用于winform、asp.net、asp.net core应用中。提供了巨大的灵活性，是一个更为强大，方便管理，集群部署的作业调度框架。

所以，有时候项目需要在不同时刻，执行一个或很多个不同的作业，你可以用它来完成执行创建简单或复杂的任务调度。

特性：

1：支持集群，作业分组，作业远程管理。

2：自定义精细的时间触发器，使用简单，作业和触发分离。

3：数据库支持，可以寄宿Windows服务，WebSite，winform等。

概念：

Scheduler 作业调度器

IJob 作业接口，继承并实现Execute，编写执行的具体作业逻辑。

JobBuilder 根据设置，生成一个详细作业信息(JobDetail)。

TriggerBuilder 根据规则，生产对应的Trigger，触发器可以规划执行任务

步骤：

1、创建一个ISchedulerFactory，然后并且获取 Scheduler

2、启动 Scheduler

3、创建 job 任务

4、创建 trigger 触发器

5、使用触发器规划执行任务

对应的API

1、IScheduler - 与 scheduler 进行交互的主要接口

2、IJob - 你希望被 scheduler 执行的组件的接口

3、IJobDetail - 用于定义 Jobs 实例

4、ITrigger - 定义将会在scheduler上执行的 job 上的组件

5、JobBuilder - 用于定义或建立(define/build) JobDetail 实例，JobDetail定义了Jobs实例

6、TriggerBuilder - 用于定义或建立 Trigger 实例

开始：

注意：

新建一个Quartz项目后,需要安装下面的程序包:

你可以用控制台命令的方式安装

Install-Package Quartz

也可以使用下面这种方式选择安装版本

一、创建一个scheduler的引用：

            ISchedulerFactory schedFact = new StdSchedulerFactory();
            IScheduler sched = await schedFact.GetScheduler();

二、启动 scheduler：

            await sched.Start();

三、实现IJob:

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

    /// <summary>
    /// 实现IJob,Execute方法里编写要处理的业务逻辑
    /// </summary>
    public class ConsoleJob : IJob
    {
        public Task Execute(IJobExecutionContext context)
        {
            return Console.Out.WriteLineAsync($"ConsoleJob执行工作 在当前时间{DateTime.Now}--上一次执行时间：{DateTime.Now.AddSeconds(-5)}");
        }
    }

四、创建trigger：（建立一个某个时间点的触发器，并且每5秒执行一次）

            ITrigger trigger = TriggerBuilder.Create()
                .WithIdentity("trigger1", "group1")  //触发器 组
                .WithSimpleSchedule(x => x.WithIntervalInSeconds(5).RepeatForever())
                .Build();

五、触发器执行任务：

            await sched.ScheduleJob(job, trigger);

将几个步骤整合后代码如下：

        /// <summary>
        /// 任务调度的使用过程
        /// </summary>
        /// <returns></returns>
        public async static Task Run()
        {
            // 1.创建scheduler的引用
            ISchedulerFactory schedFact = new StdSchedulerFactory();
            IScheduler sched = await schedFact.GetScheduler();
            

            //2.启动 scheduler
            await sched.Start();

            // 3.创建 job
            IJobDetail job = JobBuilder.Create<ConsoleJob>()
                    .WithIdentity("job1", "group1")
                    .Build();

            // 4.创建 trigger （创建 trigger 触发器）
            ITrigger trigger = TriggerBuilder.Create()
                .WithIdentity("trigger1", "group1")  //触发器 组
                .WithSimpleSchedule(x => x.WithIntervalInSeconds(5).RepeatForever())
                .Build();

            // 5.使用trigger规划执行任务job （使用触发器规划执行任务）
            await sched.ScheduleJob(job, trigger);
        }

运行：

间隔5秒执行一次后的效果：

附加：

这里使用的quartz为3.x 版本，整个版本相对于2.0版本进行了大量的修改，正式支持了.NET Core 和async/await

引用张队文章的内容：

3.x 版本的新功能：

支持 async/await 基于任务的作业，内部以async/await工作
支持.NET Core / netstandard 2.0和.NET Framework 4.5.2及更高版本
通过提供程序名称SQLite-Microsoft支持Microsoft.Data.Sqlite，旧的提供程序SQLite也仍然有效，还可以用
增加了对SQL Server内存优化表的初步支持和Quartz.Impl.AdoJobStore.UpdateLockRowSemaphoreMOT
从依赖关系中删除Common.Logging
删除C5 Collections，使用.NET框架内置的Collections
在插件启动时添加对作业调度XML文件的验证
在TimeZoneUtil中添加对额外自定义时区解析器功能的支持

API 不兼容

作业和插件分离到一个单独的程序集/ NuGet包里 Quartz.Jobs和Quartz.Plugins
ADO.NET提供程序名称已经简化，提供程序名称不带版本，例如SqlServer-20 => SqlServer
API方法已经被重新定义，主要使用IReadOnlyCollection，这隐藏了两个HashSets和List
LibLog已经隐藏到内部（ILog等），就像它本来打算的那样
SimpleThreadPool 消失了，用系统的线程池取代了
调度程序方法已经改为基于Task，记得要await 它们
IJob接口现在返回一个Task
一些IList属性已经更改为IReadOnlyList ，以正确反映意图
SQL Server CE支持已被删除
DailyCalendar现在使用日期时间排除日期，并具有ISet接口来访问它们
IObjectSerializer有新的方法，必须实现 void Initialize（）
IInterruptableJob取消了上下文的CancellationToken

总结：

1.其实在实际项目中，可以将上面的方法进行封装处理，形成不同的任务，特别是处理多任务的时候，在不同的job中调用不同的trigger，后续会继续完善开发

2.quartz还有更多的用法，可以参考资料：Quartz.Net官方文档和 Quartz.Net开源地址

C# Quartz结合控制台实现定时任务

猜你喜欢