作业调度框架Quartz.NET-现学现用-01-快速入门

原文:作业调度框架Quartz.NET-现学现用-01-快速入门

前言

你需要应用执行一个任务吗？这个任务每天或每周星期二晚上11：30，或许仅仅每个月的最后一天执行。一个自动执行而无须干预的任务在执行过程中如果发生一个严重错误，应用能够知到其执行失败并尝试重新执行吗？你和你的团队是用.NET编程吗？如果这些问题中任何一个你回答是，那么你应该使用Quartz.NET调度器。 Quartz.NET允许开发人员根据时间间隔（或天）来调度作业。它实现了作业和触发器的多对多关系，还能把多个作业与不同的触发器关联。整合了 Quartz.NET的应用程序可以重用来自不同事件的作业，还可以为一个事件组合多个作业。

Quartz.NET 简介

Quartz.NET是一个用C＃编写的基于.NetCore的纯.Net库，是一个非常流行的开源Java作业调度框架Quartz的.Net版本。这个项目很大程度上归功于原始的Java项目。此项目已更新到3.0+版本，也是博主学习使用的版本。官方文档。

Quartz.NET 快速入门

Quartz.NET 关键接口和类

• IScheduler : - 与调度程序交互的主要API。
• IJob - 由您希望由调度程序执行的组件实现的接口。
• IJobDetail - 用于定义Jobs的实例。
• ITrigger - 一个触发器，用于定义执行给定作业的计划。
• JobBuilder - 用于定义/构建JobDetail实例，用于定义Jobs的实例。
• TriggerBuilder - 用于定义/构建触发器实例。

示例应用程序

using Quartz;
using Quartz.Impl;
using System;

namespace MGToastServer
{
    class Program
    {
        static void Main(string[] args)
        {
            StartUpJobs.StartUp().GetAwaiter().GetResult();
            Console.ReadKey();
        }
    }

    public static class StartUpJobs
    {
        public static async Task StartUp()
        {
            try
            {
                //第一步：从工厂中获取Scheduler实例
                NameValueCollection props = new NameValueCollection();
                StdSchedulerFactory factory = new StdSchedulerFactory(props);
                IScheduler scheduler = await factory.GetScheduler();
                //第二步：然后运行它
                await scheduler.Start();
                //第三步：定义作业并绑定到HelloJob类，HelloJob类继承IJob接口
                IJobDetail job = JobBuilder.Create<HelloJob>()
                        .WithIdentity("job1", "group1")
                        //UsingJobData 可以用来传参数
                        .UsingJobData("appKey", "123456QWE")
                        .UsingJobData("appName", "小熊猫")
                        .UsingJobData("api", "https://www.baidu.com")
                        .Build();

                //第四步：创建触发器。设定，每十秒执行一次作业。永远重复。
                ITrigger trigger = TriggerBuilder.Create()
                    .WithIdentity("trigger1", "group1") //指定唯一标识，触发器名字，和组名字
                                                        //这对于将作业和触发器组织成“报告作业”和“维护作业”等类别非常有用。
                                                        //作业或触发器的键的名称部分在组内必须是唯一的
                    .StartNow()                         //从现在开始执行
                    .WithSimpleSchedule(x => x
                        .WithIntervalInSeconds(10)      //每十秒执行一次
                        .RepeatForever())               //永远重复
                    .Build();

                //第五步：作业与触发器组合，安排任务
                await scheduler.ScheduleJob(job, trigger);

                //可以设置关闭该调度
                //await Task.Delay(TimeSpan.FromSeconds(5));
                //await scheduler.Shutdown();
            }
            catch (SchedulerException se)
            {
                Console.WriteLine(se);
            }
        }
    }

    public class HelloJob : IJob
    {
        private string appKey;
        private string appName;
        private string appApi;

        public async Task Execute(IJobExecutionContext context)
        {
            JobKey jkey = context.JobDetail.Key;
            TriggerKey tKey = context.Trigger.Key;

            JobDataMap dataMap = context.MergedJobDataMap;
            appKey = dataMap.GetString("appKey");   //通过键值获取数据
            appName = dataMap.GetString("appName");
            appApi = dataMap.GetString("api");

            await Console.Error.WriteLineAsync("[" + DateTime.Now.ToLongTimeString() + "]" + "开始推送：\n" + "JobKey:" + jkey + "\nTriggerKey:" + tKey + "\nAppKey:" + appKey + " appName: " + appName + ", and AppAPI: " + appApi);
        }
    }
}

实验效果

如截图所示，每十秒执行一次任务。并且可以接收到传入的参数。

下篇

下篇:作业调度框架Quartz.NET-02-任务监听

Thanks

Quartz.NET

张善友的博客