.Net Core中使用Quartz.NET

一、概述

Quartz.Net是根据Java的Quartz用C#改写而来,Quartz.NET是一个开源的作业调度框架,非常适合在平时的工作中,定时轮询数据库同步,定时邮件通知,定时处理数据等。 Quartz.NET允许开发人员根据时间间隔来调度作业。它有很多特征如:数据库支持,集群,插件,支持cron-like表达式等等。

二、参考

Quartz.Net源码:https://github.com/quartznet/quartznet

官方学习文档:http://www.quartz-scheduler.net/documentation/index.html

三、Quartz.Net说明

Quartz主要有三部分组成任务(Job)、触发器(Trigger)和调度器(Schedule)。

1、任务

Job就是执行的作业,Job需要继承IJob接口,实现Execute方法。Job中执行的参数从Execute方法的参数中获取。

2、触发器

触发器常用的有两种:SimpleTrigger触发器和CronTrigger触发器。

(1)SimpleTrigger

  实现简单业务,如每隔几分钟,几小时触发执行,并限制执行次数。

  • 重复执行:WithRepeatCount()/RepeatForever()
  • 设置间隔时间:WithInterval()
  • 定时执行:StartAt()/StartNow()
  • 设定优先级:WithPriority(),默认为5
var trigger = TriggerBuilder.Create()
                       .WithSimpleSchedule(x => x.WithIntervalInSeconds(2).WithRepeatCount(5))//间隔2秒 执行6次
                       .UsingJobData("key1", 321)
                       .WithIdentity("trigger", "group")
                       .Build();

(2)CronTrigger

  Cron表达式包含7个字段,秒 分 时 月内日期 月 周内日期 年(可选)。corn在线生成https://qqe2.com/cron

 

 var trigger = TriggerBuilder.Create()
                       .WithCronSchedule("0 0 0 1 1 ?")// 每年元旦1月1日 0 点触发
                       .UsingJobData("key1", 321)
                       .UsingJobData("key2", "trigger-key2")
                       .WithIdentity("trigger2", "group2")
                       .Build();

3、调度器

调度器就是将任务和触发器绑定,让触发器触发的时候去执行任务。

4、参数说明

  • SetJobData:设置JobData

  • StoreDurably:孤立存储,指即使该JobDetail没有关联的Trigger,也会进行存储

  • RequestRecovery:请求恢复,指应用崩溃后再次启动,会重新执行该作业

  • WithIdentity:作业的唯一标识

  • WithDescription:作业的描述信息

除此之外,Quartz.Net还支持两个非常有用的特性:

  • DisallowConcurrentExecution:禁止并行执行,该特性是针对JobDetail生效的

  • PersistJobDataAfterExecution:在执行完成后持久化JobData,该特性是针对Job类型生效的,意味着所有使用该Job的JobDetail都会在执行完成后持久化JobData。

四、示例

  • 使用Vs2019创建Quartz.NET的示例 core web 项目

  • 在NuGet包管理器引用Quartz.AspNetCore

  •  在Startup文件中注入ISchedulerFactory的实例
public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews();
    services.AddMvc();
    services.AddSingleton<ISchedulerFactory, StdSchedulerFactory>();//注册ISchedulerFactory的实例。
}
  • 使用注入的服务
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using Quartz;
using QuartzDemo.Models;
using System.Threading.Tasks;

namespace QuartzDemo.Controllers
{
    public class HomeController : Controller
    {private readonly ISchedulerFactory _schedulerFactory;
        private IScheduler _scheduler;
        public HomeController(ISchedulerFactory schedulerFactory)
        {
            this._schedulerFactory = schedulerFactory;
        }

        public async Task<IActionResult> Index()
        {
            //通过调度工厂获得调度器
            _scheduler = await _schedulerFactory.GetScheduler();
            //开启调度器
            await _scheduler.Start();
            //创建一个触发器
            var trigger = TriggerBuilder.Create()
                            .WithSimpleSchedule(x => x.WithIntervalInSeconds(2).RepeatForever())//每两秒执行一次
                            .Build();
            //创建任务
            var jobDetail = JobBuilder.Create<MyJob>()
                            .WithIdentity("job", "group")
                            .Build();
            //将触发器和任务器绑定到调度器中
            await _scheduler.ScheduleJob(jobDetail, trigger);         
            return View();
        }
    }
}
using Quartz;
using System;
using System.IO;
using System.Text;
using System.Threading.Tasks;

namespace QuartzDemo.Models
{
    /// <summary>
    /// 创建IJob的实现类,并实现Excute方法
    /// </summary>
    public class MyJob : IJob
    {
        public Task Execute(IJobExecutionContext context)
        {
            return Task.Run(() =>
            {
                using (StreamWriter sw = new StreamWriter(@"C:\Users\lenovo\Desktop\1.txt", true, Encoding.UTF8))
                {
                    sw.WriteLine(DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss"));
                }
            });
        }
    }
}

执行结果:


五、传参取参

上面这种执行的Job没有参数,当需要参数可以通过下面两种方法传递参数:

1、传参方式一:在Trigger中添加参数值 

//创建一个触发器
var trigger = TriggerBuilder.Create()
                        .WithSimpleSchedule(x =>x.WithIntervalInSeconds(2).RepeatForever())//间隔2秒 一直执行
                        .UsingJobData("key1", 321)  //通过在Trigger中添加参数值
                        .UsingJobData("key2", "123")
                        .WithIdentity("trigger", "group")
                        .Build();

2、传参方式二:在Job中添加参数值

IJobDetail job = JobBuilder.Create<MyJob>()
                                .UsingJobData("key1", 123)//通过Job添加参数值
                                .UsingJobData("key2", "123")
                                .WithIdentity("job", "group")
                                .Build();

3、取参:通过下面方法在Job中获取参数值

using Quartz;
using System;
using System.IO;
using System.Text;
using System.Threading.Tasks;

namespace QuartzDemo.Models
{
    /// <summary>
    /// 创建IJob的实现类,并实现Excute方法
    /// </summary>
    public class MyJob : IJob
    {
        public Task Execute(IJobExecutionContext context)
        {
            //var jobData = context.JobDetail.JobDataMap;//获取Job中的参数

            var triggerData = context.Trigger.JobDataMap;//获取Trigger中的参数

            var data = context.MergedJobDataMap;//获取Job和Trigger中合并的参数
            var value1 = triggerData.GetInt("key1");
            var value2 = triggerData.GetString("key2");

            return Task.Run(() =>
            {
                using (StreamWriter sw = new StreamWriter(@"C:\Users\lenovo\Desktop\1.txt", true, Encoding.UTF8))
                {
                    sw.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss")}-{value1}-{value2}");
                }
            });
        }
    }
}
View Code

当Job中的参数和Trigger中的参数名称一样时,用 context.MergedJobDataMap获取参数时,Trigger中的值会覆盖Job中的值。

4、上面那种情况只能适应参数值不变的情况。如每两秒实现累加一操作,现在初始值是0,如果按照上面那种获取值的操作,一直都是0+1,返回值一直都是1。为了满足这个情况,只需要加一个特性[PersistJobDataAfterExecution]

  [PersistJobDataAfterExecution]//更新JobDetail的JobDataMap的存储副本,以便下一次执行这个任务接收更新的值而不是原始存储的值
    public class MyJob : IJob
    {
        public Task Execute(IJobExecutionContext context)
        {
            var jobData = context.JobDetail.JobDataMap;
            var triggerData = context.Trigger.JobDataMap;
            var data = context.MergedJobDataMap;

            var value1 = jobData.GetInt("key1");
            var value2 = jobData.GetString("key2");
            var value3 = data.GetString("key2");

            var dateString = DateTime.Now.ToString("yyyy-MM-dd HH-mm-ss");
            Random random = new Random();

            jobData["key1"] = random.Next(1, 20);//这里面给key赋值,下次再进来执行的时候,获取的值为更新的值,而不是原始值
            jobData["key2"] = dateString;

            return Task.Run(() =>
            {
                using (StreamWriter sw = new StreamWriter(@"C:\Users\Administrator\Desktop\error.log", true, Encoding.UTF8))
                {
                    sw.WriteLine($"{dateString} value1:{value1} value2:{value2}");
                }
            });
        }
    }

六、总结

通过演示可以看出,要执行一个定时任务,一般需要四步:

  1. 创建任务调度器。调度器通常在应用程序启动时创建,一个应用程序实例通常只需要一个调度器即可。
  2. 创建Job和JobDetail。Job是作业的类型,描述了作业是如何执行的,这个类是由我们定义的;JobDetail是Quartz对作业的封装,它包含Job类型,以及Job在执行时用到的数据,还包括是否要持久化、是否覆盖已存在的作业等选项。
  3. 创建触发器。触发器描述了在何时执行作业。
  4. 添加调度。当完成以上三步以后,就可以对作业进行调度了。

示例代码:https://github.com/qiuxianhu/EFCoreDemo

posted @ 2020-09-08 17:37  搬砖滴  阅读(5083)  评论(2编辑  收藏  举报