Quartz.NET這么NB的作業調度系統，不會還行？

?

今天介紹一下Quartz.NET的托管運行，官網傳送門。

一、前言

Quartz.NET，按官網上的說法，是一款功能齊全的任務調度系統，從小型應用到大型企業級系統都能適用。在眾多項目中，Quartz.NET以可靠、集群的方式，被用作在定時器上運行后臺任務的一種方式。

Quartz.NET主要完成兩個方面的內容：

基于時間計劃的后臺作業；

基于因時間計劃的觸發的任務運行。

?

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是一個作業的類型，例如本例子中的DemoJob。CronExpression是一個Cron的表達式。

Cron表達式允許復雜的計時器調度，所以可以設置規則，比如每個月的5號和20號，在早上8點到10點之間每半小時觸發一次。

關于Quartz.NET的Cron表達式，可以在這兒查到。

注意：不同操作系統使用的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添加了四個單例對象：

SingletonJobFactory，第四節的類，用于創建作業實例；

ISchedulerFactory的一個實現，是內置的StdSchedulerFactory，用于處理調度和管理作業；

DemoJob作業本身；

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()中注入的ISchedulerFactory和IJobFactory，以及一個IEnumerable。在第五節的代碼中，我們只向DI添加了一個JobSchedule，就是DemoJob。我們也可以添加多個JobSchedule，他們都會在這個IEnumerable中被注入到托管服務中。

StartAsync在應用程序啟動時被調用，它是我們配置Quartz的地方。我們首先創建IScheduler的一個實例，為它分配一個屬性供以后使用，并將調度程序的JobFactory設置為注入的實例：

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

然后，循環注入的作業調度，并在類的最后使用CreateJob和CreateTrigger方法為每個作業創建一個IJobDetail和ITrigger。實際應用中如果有別的需要，也可以通過擴展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

喜歡就來個三連，讓更多人因你而受益

創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎

總結

以上是生活随笔為你收集整理的ASP.NET Core托管运行Quartz.NET作业调度详解的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。