在ASP.NET Core中建立內部使用Scoped服務的Quartz.NET宿主服務

在個人上一篇文章中，我展現瞭如何使用ASP.NET Core建立Quartz.NET託管服務並使用它來按計劃運行後臺任務。不幸的是，因爲Quartz.NET API的工做方式，在Quartz做業中使用Scoped依賴項注入服務有些麻煩。說明下這篇文章部分採用機翻。

做者：依樂祝

譯文地址：http://www.javashuo.com/article/p-oulvehus-eq.html

原文地址：https://andrewlock.net/using-scoped-services-inside-a-quartz-net-hosted-service-with-asp-net-core/

在這篇文章中，我將展現一種簡化工做中使用Scoped服務的方法。您可使用相同的方法來管理EF Core的工做單元模式和其餘面向切面的模型。

這篇文章是上篇文章引伸出來的，所以，若是您尚未閱讀的話，建議您先閱讀上篇文章。

回顧-自定義JobFactory和單例的IJob

在上篇博客的最後，咱們有一個實現了IJob接口並向控制檯簡單輸出信息的HelloWorldJob。

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

咱們還有一個IJobFactory的實現，以便咱們在須要時從DI容器中檢索做業的實例：

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) { }
}

這些服務都在Startup.ConfigureServices()中以單例形式註冊：

services.AddSingleton<IJobFactory, SingletonJobFactory>();
services.AddSingleton<HelloWorldJob>();

對於這個很是基本的示例來講，這很好，可是若是您須要在IJob內部使用一些範圍服務呢？例如，也許您須要使用EF Core DbContext遍歷全部客戶，並向他們發送電子郵件，並更新客戶記錄。咱們假設這個任務爲EmailReminderJob。

權宜之計

我在上一篇文章中展現的解決方案是將IServiceProvider注入到您的IJob的文檔中，手動建立一個範圍，並從中檢索必要的服務。例如：

public class EmailReminderJob : IJob
{
    private readonly IServiceProvider _provider;
    public EmailReminderJob( IServiceProvider provider)
    {
        _provider = provider;
    }
    public Task Execute(IJobExecutionContext context)
    {
        using(var scope = _provider.CreateScope())
        {
            var dbContext = scope.ServiceProvider.GetService<AppDbContext>();
            var emailSender = scope.ServiceProvider.GetService<IEmailSender>();
            // fetch customers, send email, update DB
        }
        return Task.CompletedTask;
    }
}

在許多狀況下，這種方法絕對能夠。若是不是將實現直接放在工做內部（如我上面所作的那樣），而是使用中介者模式來處理諸如工做單元或消息分發之類的跨領域問題，則尤爲如此。

若是不是這種狀況，您可能會受益於建立一個能夠爲您管理這些工做的幫助類。

QuartzJobRunner

要解決這些問題，您能夠建立一個IJob的「中間」 實現，這裏咱們命名爲QuartzJobRunner，該實現位於IJobFactory和要運行的IJob之間。我將很快介紹做業實現，可是首先讓咱們更新現有的IJobFactory實現以不管請求哪一個做業，始終返回QuartzJobRunner的實例，：

using Microsoft.Extensions.DependencyInjection;
using Quartz;
using Quartz.Spi;
using System;
public class JobFactory : IJobFactory
{
    private readonly IServiceProvider _serviceProvider;
    public JobFactory(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }
    public IJob NewJob(TriggerFiredBundle bundle, IScheduler scheduler)
    {
        return _serviceProvider.GetRequiredService<QuartzJobRunner>();
    }
    public void ReturnJob(IJob job) { }
}

如您所見，該NewJob()方法始終返回QuartzJobRunner的實例。咱們將在Startup.ConfigureServices()中將QuartzJobRunner註冊爲單例模式，所以咱們沒必要擔憂它沒有被明確釋放。

services.AddSingleton<QuartzJobRunner>();

咱們將在QuartzJobRunner中建立實際所需的IJob實例。QuartzJobRunner中的job會建立範圍，實例化IJob的請求並執行它：

using Microsoft.Extensions.DependencyInjection;
using Quartz;
using System;
using System.Threading.Tasks;
public class QuartzJobRunner : IJob
{
    private readonly IServiceProvider _serviceProvider;
    public QuartzJobRunner(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }
    public async Task Execute(IJobExecutionContext context)
    {
        using (var scope = _serviceProvider.CreateScope())
        {
            var jobType = context.JobDetail.JobType;
            var job = scope.ServiceProvider.GetRequiredService(jobType) as IJob;
            await job.Execute(context);
        }
    }
}

在這一點上，您可能想知道，經過添加這個額外的間接層，咱們得到了什麼好處？主要有如下兩個主要優勢：

• 咱們能夠將EmailReminderJob註冊爲範圍服務，並直接將任何依賴項注入其構造函數中
• 咱們能夠將其餘橫切關注點轉移到QuartzJobRunner類中。

做業能夠直接使用做用域服務

因爲做業實例是從IServiceProvder做用域中解析來的，所以您能夠在做業實現的構造函數中安全地使用做用域服務。這使的EmailReminderJob的實現更加清晰，並遵循構造函數注入的典型模式。若是您不熟悉DI範圍界定問題，則可能很難理解它們，所以任何對您不利的事情在我看來都是一個好主意：

[DisallowConcurrentExecution]
public class EmailReminderJob : IJob
{
    private readonly AppDbContext _dbContext;
    private readonly IEmailSender _emailSender;
    public EmailReminderJob(AppDbContext dbContext, IEmailSender emailSender)
    {
        _dbContext = dbContext;
        _emailSender = emailSender;
    }
    public Task Execute(IJobExecutionContext context)
    {
        // fetch customers, send email, update DB
        return Task.CompletedTask;
    }
}

這些IJob的實現可使用如下任何生存期（做用域或瞬態）來在Startup.ConfigureServices()中註冊（JobSchedule仍然能夠是單例）：

services.AddScoped<EmailReminderJob>();
services.AddSingleton(new JobSchedule(
    jobType: typeof(EmailReminderJob),
    cronExpression: "0 0 12 * * ?")); // every day at noon

QuartzJobRunner能夠處理橫切關注點

QuartzJobRunner處理正在執行的IJob的整個生命週期：它從容器中獲取，執行並釋放它（在釋放範圍時）。所以，它很適合處理其餘跨領域問題。

例如，假設您有一個須要更新數據庫並將事件發送到消息總線的服務。您能夠在每一個單獨的IJob實現中處理全部這些問題，也能夠將跨領域的「提交更改」和「調度消息」操做移到QuartzJobRunner中。

這個例子顯然是很是基礎的。若是這裏的代碼適合您，我建議您觀看吉米·博加德（Jimmy Bogard）的「六小段失敗線」演講，其中描述了一些問題！

public class QuartzJobRunner : IJob
{
    private readonly IServiceProvider _serviceProvider;
    public QuartzJobRunner(IServiceProvider serviceProvider)
    {
        _serviceProvider = serviceProvider;
    }
    public async Task Execute(IJobExecutionContext context)
    {
        using (var scope = _serviceProvider.CreateScope())
        {
            var jobType = context.JobDetail.JobType;
            var job = scope.ServiceProvider.GetRequiredService(jobType) as IJob;
            var dbContext = _serviceProvider.GetRequiredService<AppDbContext>();
            var messageBus = _serviceProvider.GetRequiredService<IBus>();
            await job.Execute(context);
            // job completed, save dbContext changes
            await dbContext.SaveChangesAsync();
            // db transaction succeeded, send messages
            await messageBus.DispatchAsync();
        }
    }
}

這裏的QuartzJobRunner實現與上一個很是類似，可是在執行的咱們請求的IJob以前，咱們從DI容器中解析了DbContext和消息總線服務。看成業成功執行後（即未拋出異常），咱們將全部未提交的更改保存在中DbContext，並在消息總線上調度事件。

將這些方法移到QuartzJobRunner中應該能夠減小IJob實現中的重複代碼，而且能夠更容易地移到更正式的管道和其餘模式（若是您但願之後這樣作的話）。

可替代解決方案

我喜歡本文中顯示的方法（使用中間QuartzJobRunner類），主要有兩個緣由：

• 您的其餘IJob實現不須要任何有關建立做用域的基礎結構的知識，只需完成標準構造函數注入便可
• 在IJobFactory中不須要作作任何特殊處理工做。該QuartzJobRunner經過建立和處理做用域隱式地處理這個問題。

可是，此處顯示的方法並非在工做中使用範圍服務的惟一方法。馬修·阿伯特（Matthew Abbot） 在這個文章中演示了一種方法，該方法旨在以正確處理運行後的做業的方式實現IJobFactory。它有點笨拙，由於你必須匹配接口API，但能夠說它更接近你應該實現它的方式！我我的認爲我會堅持使用這種QuartzJobRunner方法，可是你能夠選擇最適合您的方法🙂

總結

在本文中，我展現瞭如何建立中間層IJob，該中間層QuartzJobRunner在調度程序須要執行做業時建立。該運行程序負責建立一個DI範圍，實例化請求的做業並執行它，所以最終IJob實現能夠在其構造函數中使用做用域中的服務。您也可使用此方法在QuartzJobRunner中配置基本管道，儘管對此有更好的解決方案，例如裝飾器或MediatR庫中的行爲。