当初有了一个官网包Quartz.Extensions.Hosting实现应用Quartz.Net运行后台任务，所以把Quartz.Net增加到ASP.NET Core或Worker Service要简略得多。
我将展现如何把Quartz.Net HostedService增加到你的利用，如何创立一个简略的IJob，以及如何注册它与trigger。
简介——什么是Quartz.Net
Quartz.Net是一个功能齐全的开源作业调度零碎，能够在最小规模的应用程序到大型企业零碎应用。
有许多ASP.NET的钉子户，他们以一种牢靠的、集群的形式在定时器上运行后台任务。应用在ASP.NET Core中应用的Quartz.Net反对了.NET Standar 2.0，因而你能够轻松地在应用程序中应用它。
Quartz.Net有三个次要概念:
- job。这是你想要运行的后台任务。
- trigger。trigger管制job何时运行，通常按某种调度规定触发。
- scheduler。它负责协调job和trigger，依据trigger的要求执行job。
ASP.NET Core很好地反对通过hosted services（托管服务）运行“后台任务”。当你的ASP.NET Core应用程序启动，托管服务也启动，并在应用程序的生命周期中在后盾运行。Quartz.Net 3.2.0通过Quartz.Extensions.Hosting引入了对该模式的间接反对。Quartz.Extensions.Hosting即能够用在ASP.NET Core应用程序，也能够用在基于“通用主机”的Worker Service。
尽管能够创立一个“定时”后盾服务(例如，每10分钟运行一个工作)，但Quartz.NET提供了一个更加强壮的解决方案。通过应用Cron trigger，你能够确保工作只在一天的特定工夫(例如凌晨2:30)运行，或者只在特定的日子运行，或者这些工夫的任意组合运行。Quartz.Net还容许你以集群的形式运行应用程序的多个实例，以便在任何时候只有一个实例能够运行给定的工作。
Quartz.Net托管服务负责Quartz的调度。它将在应用程序的后盾运行，查看正在执行的触发器，并在必要时运行相干的作业。你须要配置调度程序，但不须要放心启动或进行它，IHostedService会为你治理。
在这篇文章中，我将展现创立Quartz.Net job的基础知识。并将其调度到托管服务中的定时器上运行。
装置Quartz.Net
Quartz.Net是一个.NET Standar 2.0的NuGet包，所以它很容易装置在你的应用程序中。对于这个测试，我创立了一个Worker Service我的项目。你能够通过应用dotnet add package Quartz.Extensions.Hosting命令装置Quartz.Net托管包。如果你查看我的项目的.csproj，它应该是这样的:
<Project Sdk="Microsoft.NET.Sdk.Worker"> <PropertyGroup> <TargetFramework>net5.0</TargetFramework> <UserSecretsId>dotnet-QuartzWorkerService-9D4BFFBE-BE06-4490-AE8B-8AF1466778FD</UserSecretsId> </PropertyGroup> <ItemGroup> <PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.0" /> <PackageReference Include="Quartz.Extensions.Hosting" Version="3.2.3" /> </ItemGroup></Project>这将增加托管服务包，从而引入Quartz.Net。接下来，咱们须要在应用程序中注册Quartz.Net的服务和 IHostedService。
增加Quartz.Net托管服务
注册Quartz.Net须要做两件事：
- 注册Quartz.Net须要的DI容器服务。
- 注册托管服务。
在ASP.NET Core中，通常会在Startup.ConfigureServices()办法中实现这两项操作。Worker Services不应用Startup类，所以咱们在Program.cs中的IHostBuilder的ConfigureServices办法中注册它们:
public class Program{ public static void Main(string[] args) { CreateHostBuilder(args).Build().Run(); } public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureServices((hostContext, services) => { // Add the required Quartz.NET services services.AddQuartz(q => { // Use a Scoped container to create jobs. I'll touch on this later q.UseMicrosoftDependencyInjectionScopedJobFactory(); }); // Add the Quartz.NET hosted service services.AddQuartzHostedService( q => q.WaitForJobsToComplete = true); // other config });}这里有几个乏味的点:
- UseMicrosoftDependencyInjectionScopedJobFactory:它通知Quartz.NET注册一个IJobFactory，该IJobFactory通过从DI容器中创立job。办法中的Scoped局部意味着你的作业能够应用scoped服务，而不仅仅是single或transient服务。
- WaitForJobsToComplete:此设置确保当申请敞开时，Quartz.NET在退出之前期待作业优雅地完结。
如果你当初运行应用程序，将看到Quartz服务启动，并将大量日志转储到控制台:
info: Quartz.Core.SchedulerSignalerImpl[0] Initialized Scheduler Signaller of type: Quartz.Core.SchedulerSignalerImplinfo: Quartz.Core.QuartzScheduler[0] Quartz Scheduler v.3.2.3.0 created.info: Quartz.Core.QuartzScheduler[0] JobFactory set to: Quartz.Simpl.MicrosoftDependencyInjectionJobFactoryinfo: Quartz.Simpl.RAMJobStore[0] RAMJobStore initialized.info: Quartz.Core.QuartzScheduler[0] Scheduler meta-data: Quartz Scheduler (v3.2.3.0) 'QuartzScheduler' with instanceId 'NON_CLUSTERED' Scheduler class: 'Quartz.Core.QuartzScheduler' - running locally. NOT STARTED. Currently in standby mode. Number of jobs executed: 0 Using thread pool 'Quartz.Simpl.DefaultThreadPool' - with 10 threads. Using job-store 'Quartz.Simpl.RAMJobStore' - which does not support persistence. and is not clustered.info: Quartz.Impl.StdSchedulerFactory[0] Quartz scheduler 'QuartzScheduler' initializedinfo: Quartz.Impl.StdSchedulerFactory[0] Quartz scheduler version: 3.2.3.0info: Quartz.Core.QuartzScheduler[0] Scheduler QuartzScheduler_$_NON_CLUSTERED started.info: Microsoft.Hosting.Lifetime[0] Application started. Press Ctrl+C to shut down....此时，你曾经让Quartz作为托管服务在你的应用程序中运行，然而没有任何job让它运行。在下一节中，咱们将创立并注册一个简略的job。
创立job
对于咱们正在调度的理论后盾工作，咱们将应用一个"hello world"实现它写入一个ILogger<T>。你应该实现Quartz.NET的接口IJob，它蕴含一个异步的Execute()办法。留神，咱们在这里应用依赖注入将日志程序注入到构造函数中。
using Microsoft.Extensions.Logging;using Quartz;using System.Threading.Tasks;[DisallowConcurrentExecution]public class HelloWorldJob : IJob{ private readonly ILogger<HelloWorldJob> _logger; public HelloWorldJob(ILogger<HelloWorldJob> logger) { _logger = logger; } public Task Execute(IJobExecutionContext context) { _logger.LogInformation("Hello world!"); return Task.CompletedTask; }}我还用[DisallowConcurrentExecution]属性装璜了job。此属性避免Quartz.NET试图同时运行雷同的作业。
当初咱们曾经创立了作业，咱们须要将它与trigger一起注册到DI容器中。
配置job
Quartz.NET为运行job提供了一些简略的schedule，但最常见的办法之一是应用Quartz.NET Cron表达式。Cron表达式容许简单的计时器调度，所以你能够设置规定，比方“每个月的5号和20号，在早上8点到10点之间每半小时触发一次”。应用时请确保查看示例文档，因为不同零碎应用的所有Cron表达式都是可调换的。
上面的示例展现了如何应用每5秒运行一次的trggier来注册HelloWorldJob:
public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureServices((hostContext, services) => { services.AddQuartz(q => { q.UseMicrosoftDependencyInjectionScopedJobFactory(); // Create a "key" for the job var jobKey = new JobKey("HelloWorldJob"); // Register the job with the DI container q.AddJob<HelloWorldJob>(opts => opts.WithIdentity(jobKey)); // Create a trigger for the job q.AddTrigger(opts => opts .ForJob(jobKey) // link to the HelloWorldJob .WithIdentity("HelloWorldJob-trigger") // give the trigger a unique name .WithCronSchedule("0/5 * * * * ?")); // run every 5 seconds }); services.AddQuartzHostedService(q => q.WaitForJobsToComplete = true); // ... });在本代码中，咱们:
- 为job创立惟一的JobKey。这用于将job与其trggier连贯在一起。还有其余连贯job和trggier的办法，但我认为这和其余办法一样好。
- 用AddJob<T>注册HelloWorldJob。这做了两件事—它将HelloWorldJob增加到DI容器中，这样就能够创立它;它在外部向Quartz注册job。
- 增加一个触发器，每5秒运行一次作业。咱们应用JobKey将trigger与一个job关联起来，并为trigger提供惟一的名称(在本例中不是必须的，但如果你在集群模式下运行quartz，这很重要)。最初，咱们为trigger设置了Cron调度，使作业每5秒运行一次。
这就实现了性能!不再须要创立自定义的IJobFactory，也不必放心是否反对scoped的服务。
默认的包为你解决所有这些问题——你能够在IJob中应用scoped的服务，它们将在job实现时被删除。
如果你当初运行你的应用程序，你会看到和以前一样的启动音讯，而后每5秒你会看到HelloWorldJob写入控制台:
这就是启动和运行所需的全部内容，然而依据我的爱好，在ConfigureServices办法中增加了太多内容。你也不太可能想在应用程序中硬编码作业调度。例如，如果将其提取到配置中，能够在每个环境中应用不同的调度。
最起码，咱们心愿将Cron调度提取到配置中。例如，你能够在appsettings.json中增加以下内容:
{ "Quartz": { "HelloWorldJob": "0/5 * * * * ?" } }而后，你能够轻松地在不同环境中笼罩HelloWorldJob的触发器调度。
为了不便注册，咱们能够创立一个扩大办法来封装在Quartz上注册IJob，并设置它的trigger调度。这段代码与后面的示例基本相同，然而它应用job的名称在IConfiguration中加载Cron调度。
public static class ServiceCollectionQuartzConfiguratorExtensions{ public static void AddJobAndTrigger<T>( this IServiceCollectionQuartzConfigurator quartz, IConfiguration config) where T : IJob { // Use the name of the IJob as the appsettings.json key string jobName = typeof(T).Name; // Try and load the schedule from configuration var configKey = $"Quartz:{jobName}"; var cronSchedule = config[configKey]; // Some minor validation if (string.IsNullOrEmpty(cronSchedule)) { throw new Exception($"No Quartz.NET Cron schedule found for job in configuration at {configKey}"); } // register the job as before var jobKey = new JobKey(jobName); quartz.AddJob<T>(opts => opts.WithIdentity(jobKey)); quartz.AddTrigger(opts => opts .ForJob(jobKey) .WithIdentity(jobName + "-trigger") .WithCronSchedule(cronSchedule)); // use the schedule from configuration }}当初咱们能够应用扩大办法清理应用程序的Program.cs:
public class Program{ public static void Main(string[] args) => CreateHostBuilder(args).Build().Run(); public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureServices((hostContext, services) => { services.AddQuartz(q => { q.UseMicrosoftDependencyInjectionScopedJobFactory(); // Register the job, loading the schedule from configuration q.AddJobAndTrigger<HelloWorldJob>(hostContext.Configuration); }); services.AddQuartzHostedService(q => q.WaitForJobsToComplete = true); });}这实质上与咱们的配置雷同，然而咱们曾经使增加新job和调度的细节移到配置中变得更容易。
再次运行应用程序会给出雷同的输入:job每5秒写一次输入。
总结
在这篇文章中，我介绍了Quartz.NET并展现了如何应用新的Quartz.Extensions.Hosting轻松增加一个ASP.NET Core托管服务运行Quartz调度器。我展现了如何应用trigger实现一个简略的job，以及如何将其注册到应用程序中，以便托管的服务按计划运行它。
欢送关注我的公众号，如果你有喜爱的外文技术文章，能够通过公众号留言举荐给我。