ASP.NET Core託管執行Quartz.NET作業排程詳解

老王Plus發表於2020-10-23
ASP.NETquartz

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觸發器，定義任務在特定的日子或特定的時間執行，例如每天凌晨兩點執行一個任務。它還允許以叢集的方式執行應用程式的多個例項，以便在任何時間確保只有一個例項執行給定的任務。

 

下面，就針對這些特性和功能，進行詳細的說明。

    為防止非授權轉發，這兒給出本文的原文連結：https://www.cnblogs.com/tiger-wang/p/13861121.html

二、安裝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新增了四個單例物件：

  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()中注入的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

 

 

微信公眾號：老王Plus

掃描二維碼，關注個人公眾號，可以第一時間得到最新的個人文章和內容推送

本文版權歸作者所有，轉載請保留此宣告和原文連結

相關文章