C#定时任务框架Quartz.NET

时间:2022-05-23 痕迹g 人气:20

什么是定时任务？

最近恰巧有类似的需求, 需要做一个应用程序服务, 每天定时给服务器上传采集的数据。

在没有任务框架的使用前提下, 如果我们想要实现类似的需求,可以自己写一个计时器, 然后24小时运行,达到指定的时间就运行。但是这样不仅扩展性差, 而且不易于维护。

在定时任务这块, 也有非常的多的框架支持,开箱即用, 那么下面将主要介绍一下Quartz.NET框架

Github

Quartz.NET介绍

Quartz.NET是一个Github开源项目，用于创建一个免费商业用途的作业调度框架。

注:支持 .NET Core/.NET Standard 2.0 和 .NET 框架 4.6.1 及更晚版本。

Quartz.NET入门

在我们使用定时任务框架的之前, 首先我们需要确定的是, 它大概具备哪些内容。

灵活的指定某项任务
灵活的启动时间配置
传递参数并且监听

了解了这些基础概念之后, 我们便开始学习如何在Quartz.NET当中使用这些功能。

1.创建一个任务

任务是一个抽象的概念, 实际来说它应该指的是某种任务, 例如: 想要每3秒输入一个字符串, 那么我们就可以这样做。

下面演示创建了一个类, 它继承于IJob接口, 实现了Execute方法, 任务就是输出一个字符串。

    public class TestJob : IJob
    {
        public async Task Execute(IJobExecutionContext context)
        {
            await Console.Out.WriteLineAsync($"{DateTime.Now}:Hello!");
        }
    }

创建任务

            //创建一个工作
            IJobDetail job = JobBuilder.Create<TestJob>()
             .WithIdentity("TestJob", "Test")
            .Build();

2.配置任务的参数

为任务配置一个触发条件及相关的参数。当该配置的参数一旦达到了条件, 上面的任务将被触发。

            //创建一个触发条件
            ITrigger trigger = TriggerBuilder.Create()
               .WithIdentity("TestJobTrigger", "Test")
               .WithSimpleSchedule(x =>
               {
                   x.WithIntervalInSeconds(3).RepeatForever();
               })
               .Build();

3.启动任务

创建一个任务调度器, 将任务和配置参数添加到调度器当中。

            StdSchedulerFactory factory = new StdSchedulerFactory();
            //创建任务调度器
            IScheduler scheduler = await factory.GetScheduler();
            //启动任务调度器
            scheduler.Start();  

            //将创建的任务和触发器条件添加到创建的任务调度器当中
            scheduler.ScheduleJob(job, trigger);

4.实际效果

在上面的代码中,我们创建了一个任务输出一段字符串, 然后为该任务创建了一个配置, 每3秒执行一次, 那么实际效果会每间隔3秒输出: