ASP.NET Core托管运行Quartz.NET作业调度详解

Quartz.NET这么NB的作业调度系统,不会还行?

今天介绍一下Quartz.NET的托管运行,官网传送门。

一、前言

Quartz.NET,按官网上的说法,是一款功能齐全的任务调度系统,从小型应用到大型企业级系统都能适用。在众多项目中,Quartz.NET以可靠、集群的方式,被用作在定时器上运行后台任务的一种方式。

Quartz.NET主要完成两个方面的内容:

  1. 基于时间计划的后台作业;

  2. 基于因时间计划的触发的任务运行。

ASP.NET Core本身对于通过托管服务运行后台任务就支持的很好。当ASP.NET启动托管服务时,应用程序启动,并在生命周期内在后台运行。通过创建Quartz.NET托管服务,可以使用标准的.Net Core托管服务,在后台运行任务。

Quartz.NET可以创建定时的任务,例如每十分钟运行一个任务。除此之外,Quartz.NET还可以通过Cron触发器,定义任务在特定的日子或特定的时间运行,例如每天凌晨两点执行一个任务。它还允许以集群的方式运行应用程序的多个实例,以便在任何时间确保只有一个实例运行给定的任务。

下面,就针对这些特性和功能,进行详细的说明。

二、安装Quartz.NET

Quartz.NET提供了NuGet包,所以安装很简单:

% dotnet add package quartz

这是个司机就知道,不详说了。

看一下安装后的.csproj文件内容:

<Project Sdk="Microsoft.NET.Sdk.Web"><PropertyGroup><TargetFramework>netcoreapp3.1</TargetFramework></PropertyGroup><ItemGroup><PackageReference Include="quartz" Version="3.2.2" /></ItemGroup>
</Project>

三、通过IJob创建任务类

我们用个例子来说明 - 创建一个Demo的实现。它将写入ILogger<>。我们会使用Quartz.NET的接口IJob来实现,并使用依赖注入将日志注入到构造函数中。

[DisallowConcurrentExecution]
public class DemoJob : IJob
{private readonly ILogger<DemoJob> _logger;public DemoJob(ILogger<DemoJob> logger){_logger = logger;}public Task Execute(IJobExecutionContext context){_logger.LogInformation("Demo !");return Task.CompletedTask;}
}

在类的前面,我用了一个DisallowConcurrentExecution属性。这个属性可以防止Quartz.NET同时运行相同的作业。

四、通过IJobFactory创建任务工厂

通常情况下,Quartz.NET会使用Activator.CreateInstance来创建作业的实例。

在我们这个例子里,我们换一种方式。使用IJobFactory实现,并与ASP.NET Core的依赖注入容器挂钩。

public class SingletonJobFactory : IJobFactory
{private readonly IServiceProvider _serviceProvider;public SingletonJobFactory(IServiceProvider serviceProvider){_serviceProvider = serviceProvider;}public IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler){return _serviceProvider.GetRequiredService(bundle.JobDetail.JobType) as IJob;}public void ReturnJob(IJob job){}
}

这个IJobFactory的实现,在构造函数中引入IServiceProvider,并实现接口。

接口中,最重要的是NewJob()方法。这个方法需要返回Quartz.NET调度器请求的IJob。在我们的例子中,我们直接委托给IServiceProvider,并让DI容器找到所需的实例。

ReturnJob()方法是调度程序返回和销毁IJobFactory创建的作业的地方。不过,因为我们使用了IServiceProvider,而它没有提供这样的处理。所以,从安全的角度,应该使用单例作业。

五、配置作业

在第三节中,我们创建了一个IJob的实现。这个实现直接使用就可以。

但是,我们这儿要加点内容。我们把Quartz的托管服务做成一个通用实现,来调度任意的作业。因此,我们创建一个简单的DTO,并使用它来定义一个给定作业类型的时间器调度:

public class JobSchedule
{public JobSchedule(Type jobType, string cronExpression){JobType = jobType;CronExpression = cronExpression;}public Type JobType { get; }public string CronExpression { get; }
}

在这个类中,JobType是一个作业的类型,例如本例子中的DemoJobCronExpression是一个Cron的表达式。

Cron表达式允许复杂的计时器调度,所以可以设置规则,比如每个月的5号和20号,在早上8点到10点之间每半小时触发一次。

关于Quartz.NETCron表达式,可以在这儿查到。

注意:不同操作系统使用的Cron表达式有一定的区别,写表达式的时候一定要注意这一点。

然后,我们把作业添加到Startup.ConfigureServices()中:

public void ConfigureServices(IServiceCollection services)
{services.AddControllers();services.AddSingleton<IJobFactory, SingletonJobFactory>();services.AddSingleton<ISchedulerFactory, StdSchedulerFactory>();services.AddSingleton<DemoJob>();services.AddSingleton(new JobSchedule(jobType: typeof(DemoJob),cronExpression: "0/5 * * * * ?")); // 每5秒运行一次
}

这段代码向DI添加了四个单例对象:

  1. SingletonJobFactory,第四节的类,用于创建作业实例;

  2. ISchedulerFactory的一个实现,是内置的StdSchedulerFactory,用于处理调度和管理作业;

  3. DemoJob作业本身;

  4. DemoJob的一个JobSchedule实例,该实例具有每5秒运行一次的Cron表达式。

现在,主要代码已经完成,就差Quartz托管服务了。

六、创建Quartz托管服务

QuartzHostedService是自己创建的Quartz托管服务,继承于IHostedService,用于设置Quartz调度器,并在后台启动它。

先看一下完整的代码:

public class QuartzHostedService : IHostedService
{private readonly ISchedulerFactory _schedulerFactory;private readonly IJobFactory _jobFactory;private readonly IEnumerable<JobSchedule> _jobSchedules;public QuartzHostedService(ISchedulerFactory schedulerFactory, IJobFactory jobFactory, IEnumerable<JobSchedule> jobSchedules){_schedulerFactory = schedulerFactory;_jobSchedules = jobSchedules;_jobFactory = jobFactory;}public IScheduler Scheduler { get; set; }public async Task StartAsync(CancellationToken cancellationToken){Scheduler = await _schedulerFactory.GetScheduler(cancellationToken);Scheduler.JobFactory = _jobFactory; foreach (var jobSchedule in _jobSchedules){var job = CreateJob(jobSchedule);var trigger = CreateTrigger(jobSchedule);await Scheduler.ScheduleJob(job, trigger, cancellationToken);}await Scheduler.Start(cancellationToken);}public async Task StopAsync(CancellationToken cancellationToken){await Scheduler?.Shutdown(cancellationToken);}private ITrigger CreateTrigger(JobSchedule schedule){return TriggerBuilder.Create().WithIdentity($"{schedule.JobType.FullName}.trigger").WithCronSchedule(schedule.CronExpression).WithDescription(schedule.CronExpression).Build();}private IJobDetail CreateJob(JobSchedule schedule){var jobType = schedule.JobType;return JobBuilder.Create(jobType).WithIdentity(jobType.FullName).WithDescription(jobType.Name).Build();}
}

解释一下这段代码:

这段代码中,QuartzHostedService有三个依赖项:Startup.ConfigureServices()中注入的ISchedulerFactoryIJobFactory,以及一个IEnumerable。在第五节的代码中,我们只向DI添加了一个JobSchedule,就是DemoJob。我们也可以添加多个JobSchedule,他们都会在这个IEnumerable中被注入到托管服务中。

StartAsync在应用程序启动时被调用,它是我们配置Quartz的地方。我们首先创建IScheduler的一个实例,为它分配一个属性供以后使用,并将调度程序的JobFactory设置为注入的实例:

public async Task StartAsync(CancellationToken cancellationToken)
{Scheduler = await _schedulerFactory.GetScheduler(cancellationToken);Scheduler.JobFactory = _jobFactory; //... 
}

然后,循环注入的作业调度,并在类的最后使用CreateJobCreateTrigger方法为每个作业创建一个IJobDetailITrigger。实际应用中如果有别的需要,也可以通过扩展JobSchedule DTO来定制它。

最后,在调度了所有作业之后,调用Scheduler.Start()来实际在后台启动Quartz.NET调度器。当应用程序关闭时,框架将调用StopAsync(),此时可以调用Scheduler.Shutdown()来安全地关闭调度程序进程。

全部完成后,我们启动QuartzHostedService

public void ConfigureServices(IServiceCollection services)
{// ...services.AddHostedService<QuartzHostedService>();
}

运行程序,可以看到结果:

demo.DemoJob: Information: Demo !
info: demo.DemoJob[0]Demo !
demo.DemoJob: Information: Demo !
info: demo.DemoJob[0]Demo !
demo.DemoJob: Information: Demo !
info: demo.DemoJob[0]Demo !
demo.DemoJob: Information: Demo !
info: demo.DemoJob[0]Demo !

本文的代码,在https://github.com/humornif/Demo-Code/tree/master/0029/demo

喜欢就来个三连,让更多人因你而受益

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/307246.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

asp.net core监控—引入Prometheus(四)

上一篇博文中说到Prometheus有四种指标类型&#xff1a;Counter&#xff08;计数器&#xff09;、Gauge&#xff08;仪表盘&#xff09;、Histogram&#xff08;直方图&#xff09;、Summary&#xff08;摘要&#xff09;&#xff0c;并且我们做了一个Counter的Demo&#xff0c…

[开源] .Net ORM FreeSql 1.10.0 稳步向前

写在开头FreeSql 是 .NET 开源生态下的 ORM 轮子&#xff0c;转眼快两年了&#xff0c;说真的开源不容易&#xff08;只有经历过才明白&#xff09;。今天带点干货和湿货给大家&#xff0c;先说下湿货。认识我的人&#xff0c;知道 CSRedisCore 是我写的另外一个开源组件&#…

CAP-微服务间通信实践

微服务间通信常见的两种方式由于微服务架构慢慢被更多人使用后&#xff0c;迎面而来的问题是如何做好微服务间通信的方案。我们先分析下目前最常用的两种服务间通信方案。gRPC&#xff08;rpc远程调用&#xff09;gRPC-微服务间通信实践场景&#xff1a;A服务主动发起请求到B服…

软件构造学习笔记-第二周

本周课程把第六章测试的内容提前讲了一部分&#xff0c;主要为实验1服务&#xff0c;讲了有关测试的概念、作用和基本方法。“测试优先”的思想是非常重要的&#xff0c;根据spec写出简单而全面的测试&#xff0c;在方法/类完成后第一时间对其进行测试&#xff0c;保证每个方法…

T-SQL | 你需要了解的执行计划

【T-SQL】| 作者 / Edison Zhou这是EdisonTalk的第297篇学习分享T-SQL是ANSI和ISO SQL标准的MS SQL扩展&#xff0c;其正式名称为Transact-SQL&#xff0c;但一般程序员都称其为T-SQL。本文是我学习《T-SQL查询》一书的读书笔记&#xff0c;为你讲解执行计划是个什么鬼。1关于执…

软件构造学习笔记-实验1

记录一下做实验1时遇到的问题。 准备工作 1.GitHub的注册和配置 由于之前没有接触过GitHub&#xff0c;所以碰到了一些问题。GitHub是什么&#xff1f;怎么建立GitHub远程仓库与本地仓库的连接&#xff1f;怎么在GitHub上传和下载文件&#xff1f; 实验完成后我可以简单回答上…

好的自我介绍,面试成功一大半

大家好&#xff0c;我是Z哥。关于面试时的自我介绍&#xff0c;我想大家遇到的情况都差不多&#xff0c;大部分面试的第一个环节基本都是这个。每个人也都知道留下好的第一印象很重要&#xff0c;但我估计很多人对这件事的解决方式&#xff0c;也就在网上找个自我介绍的模版就完…

软件构造学习笔记-第三周

本周介绍了软件开发的几种模型&#xff0c;并重点介绍了Git。Git是分布式版本控制系统&#xff0c;可以通过SSH key建立远程与本地的连接&#xff0c;通过Git Bash中的命令进行文件的上传和下载。对于这门课程&#xff0c;Git的主要作用就是向TA提交实验代码。 软件开发生命周…

log4net直切ElasticSearch,小步快跑首选

很多小步快跑的公司&#xff0c;开发人员可能就3-4个&#xff0c;面对巨大业务压力&#xff0c;日连夜的赶着上线&#xff0c;快速试错&#xff0c;自然就没时间搭建一些基础设施&#xff0c;比如说logCenter&#xff0c;但初期项目不稳定&#xff0c;bug又多&#xff0c;每次都…

软件构造学习笔记-第四周

本周重点介绍了mutable和immutable的概念&#xff0c;有些抽象。对于immutable的数据类型来说&#xff0c;想修改其引用指向的值&#xff0c;必须使其指向新的内存区域&#xff0c;而不能在原有的内存区域做修改。mutable数据类型相反&#xff0c;可以在原来指向的内存区域进行…

壹佰文章总结| 关于ASP.NETCore的分享之路

公众号不让放外网链接&#xff0c;点击【阅读原文】&#xff0c;去我的博客园&#xff0c;可以看对应的详细文章。&#xff08;关于学习ASP.NET Core需要了解和掌握的知识点图&#xff09;一言不合就来图&#xff0c;各位博客园小伙伴大家好&#xff0c;感觉好久没有写文章了&a…

软件构造学习笔记-第五周

本周讲了AF、RI、Safety from rep exposure、spec等概念。这些是辅助程序设计的重要部分&#xff0c;需要在代码中以注释的形式体现&#xff0c;可以显著提高代码可读性&#xff0c;明确设计的目的。必须要养成写的习惯&#xff01;&#xff01;&#xff01; 设计规约 1.规约…

EFCore之SQL扩展组件BeetleX.EFCore.Extension

EFCore是.NETCore团队开发的一个ORM组件&#xff0c;但这个组件在执行传统SQL的时候并不方便&#xff0c;因此BeetleX.EFCore.Extension的设计目的是让EFCore执行传统SQL更简单方便。引用在使用组件之前需要引用它&#xff0c;可以通过以下地址获取最新版本https://www.nuget.o…

软件构造学习笔记-第六周

这周的重点是重载和重写。重载要求两方法的签名必须不同&#xff0c;而重写则要求两方法的签名必须相同。重载可以发生在同一个类中&#xff0c;也可以发生在父类和子类中&#xff1b;重写必须发生在父类和子类中。接口/抽象类不具有构造方法&#xff0c;只有将内部的抽象方法全…

云原生时代,.NET5必将称王!

“ 随着互联网持续高歌猛进&#xff0c;相关技术名词也是层出不穷。微服务、容器化、DevOps、ServerLess、FaaS&#xff0c;这两年最火的&#xff0c;当属云原生Cloud Native&#xff01;当下大部分企业还在追逐微服务架构落地&#xff0c;而下一代的架构云原生已如火如荼。程序…

软件构造学习笔记-实验2

P1 1.设计目标 首先对图的ADT进行两种实现&#xff08;从边和顶点出发&#xff09;&#xff0c;然后选择一种实现的ADT&#xff0c;根据输入的文件构建语料库&#xff0c;再利用构建的语料库&#xff0c;对输入字符串进行插入操作&#xff0c;并返回修改后的字符串。 2.有关AF…

海棠读社小程序研发(.Net Core版)

今天这篇博文是介绍海棠读社小程序开发的技术博文&#xff0c;由于博主是技术出身&#xff0c;开发过小程序和公众号&#xff0c;所以从决定做海棠读社开始就写代码了。因为只有技术和文化相结合&#xff0c;更能使传统文化大放异彩&#xff0c;更好地传播、讲好中国故事。漓江…

软件构造学习笔记-第七周

本周只有一节课&#xff0c;内容较少。对于不可变类型的相等比较&#xff0c;需要重写equals和hashCode方法&#xff0c;实现观察等价性。对于可变类型&#xff0c;不建议重写以上两方法&#xff0c;按照默认比较方式&#xff08;比较内存地址&#xff09;即可。 可变类型的相…

asp.net core监控—引入Prometheus(五)

上一篇博文中说到Prometheus有四种指标类型&#xff1a;Counter&#xff08;计数器&#xff09;、Gauge&#xff08;仪表盘&#xff09;、Histogram&#xff08;直方图&#xff09;、Summary&#xff08;摘要&#xff09;&#xff0c;并且我们做了一个Counter的Demo&#xff0c…

软件构造学习笔记-第八周

本周重点是Liskov可替换原则。它要求父类和子类的行为一致性&#xff0c;子类要有更强的不变量、更弱的前置条件、更强的后置条件。在该原则的要求下&#xff0c;每个子类都可以对父类进行替换。这在开发过程中会带来极大的便利&#xff0c;在实验3中学习并运用该原则。 有关复…