乐趣区

关于c#:在-ASPNET-Core和Worker-Service中使用QuartzNet

jiezi

当初有了一个官网包 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 有三个次要概念:

  1. job。这是你想要运行的后台任务。
  2. trigger。trigger 管制 job 何时运行，通常按某种调度规定触发。
  3. 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 须要做两件事：

  1. 注册 Quartz.Net 须要的 DI 容器服务。
  2. 注册托管服务。

在 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
            });
}

这里有几个乏味的点:

  1. UseMicrosoftDependencyInjectionScopedJobFactory: 它通知 Quartz.NET 注册一个 IJobFactory，该 IJobFactory 通过从 DI 容器中创立 job。办法中的 Scoped 局部意味着你的作业能够应用 scoped 服务，而不仅仅是 single 或 transient 服务。
  2. WaitForJobsToComplete: 此设置确保当申请敞开时，Quartz.NET 在退出之前期待作业优雅地完结。

如果你当初运行应用程序，将看到 Quartz 服务启动，并将大量日志转储到控制台:

info: Quartz.Core.SchedulerSignalerImpl[0]
      Initialized Scheduler Signaller of type: Quartz.Core.SchedulerSignalerImpl
info: Quartz.Core.QuartzScheduler[0]
      Quartz Scheduler v.3.2.3.0 created.
info: Quartz.Core.QuartzScheduler[0]
      JobFactory set to: Quartz.Simpl.MicrosoftDependencyInjectionJobFactory
info: 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' initialized
info: Quartz.Impl.StdSchedulerFactory[0]
      Quartz scheduler version: 3.2.3.0
info: 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);
            // ...
        });

在本代码中，咱们:

  1. 为 job 创立惟一的 JobKey。这用于将 job 与其 trggier 连贯在一起。还有其余连贯 job 和 trggier 的办法，但我认为这和其余办法一样好。
  2. 用 AddJob<T> 注册 HelloWorldJob。这做了两件事—它将 HelloWorldJob 增加到 DI 容器中，这样就能够创立它; 它在外部向 Quartz 注册 job。
  3. 增加一个触发器，每 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，以及如何将其注册到应用程序中，以便托管的服务按计划运行它。

 欢送关注我的公众号，如果你有喜爱的外文技术文章，能够通过公众号留言举荐给我。

退出移动版