在我的上一篇文章《在ASP.NET Core中創(chuàng)建基于Quartz.NET托管服務(wù)輕松實現(xiàn)作業(yè)調(diào)度》，我展示了如何使用ASP.NET Core創(chuàng)建Quartz.NET托管服務(wù)并使用它來按計劃運行后臺任務(wù)。不幸的是，由于Quartz.NET API的工作方式，在Quartz作業(yè)中使用Scoped依賴項注入服務(wù)有些麻煩。說明下這篇文章部分采用機翻。

作者：依樂祝

譯文地址：https://www.cnblogs.com/yilezhu/p/12757411.html

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

在這篇文章中，我將展示一種簡化工作中使用Scoped服務(wù)的方法。您可以使用相同的方法來管理EF Core的工作單元模式和其他面向切面的模型。

這篇文章是上篇文章引申出來的，因此，如果您還沒有閱讀的話，建議您先閱讀上篇文章。

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

在上篇博客的最后，我們有一個實現(xiàn)了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的實現(xiàn)，以便我們在需要時從DI容器中檢索作業(yè)的實例：

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

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

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

對于這個非常基本的示例來說，這很好，但是如果您需要在IJob內(nèi)部使用一些范圍服務(wù)呢？例如，也許您需要使用EF Core DbContext遍歷所有客戶，并向他們發(fā)送電子郵件，并更新客戶記錄。我們假設(shè)這個任務(wù)為EmailReminderJob。

權(quán)宜之計

我在上一篇文章中展示的解決方案是將IServiceProvider注入到您的IJob的文檔中，手動創(chuàng)建一個范圍，并從中檢索必要的服務(wù)。例如：

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

在許多情況下，這種方法絕對可以。如果不是將實現(xiàn)直接放在工作內(nèi)部（如我上面所做的那樣），而是使用中介者模式來處理諸如工作單元或消息分發(fā)之類的跨領(lǐng)域問題，則尤其如此。

如果不是這種情況，您可能會受益于創(chuàng)建一個可以為您管理這些工作的幫助類。

QuartzJobRunner

要解決這些問題，您可以創(chuàng)建一個IJob的“中間” 實現(xiàn)，這里我們命名為QuartzJobRunner，該實現(xiàn)位于IJobFactory和要運行的IJob之間。我將很快介紹作業(yè)實現(xiàn)，但是首先讓我們更新現(xiàn)有的IJobFactory實現(xiàn)以無論請求哪個作業(yè)，始終返回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注冊為單例模式，因此我們不必擔(dān)心它沒有被明確釋放。

services.AddSingleton<QuartzJobRunner>();

我們將在QuartzJobRunner中創(chuàng)建實際所需的IJob實例。QuartzJobRunner中的job會創(chuàng)建范圍，實例化IJob的請求并執(zhí)行它：

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

在這一點上，您可能想知道，通過添加這個額外的間接層，我們獲得了什么好處？主要有以下兩個主要優(yōu)點：

• 我們可以將EmailReminderJob注冊為范圍服務(wù)，并直接將任何依賴項注入其構(gòu)造函數(shù)中

• 我們可以將其他橫切關(guān)注點轉(zhuǎn)移到QuartzJobRunner類中。

作業(yè)可以直接使用作用域服務(wù)

由于作業(yè)實例是從IServiceProvder作用域中解析來的，因此您可以在作業(yè)實現(xiàn)的構(gòu)造函數(shù)中安全地使用作用域服務(wù)。這使的EmailReminderJob的實現(xiàn)更加清晰，并遵循構(gòu)造函數(shù)注入的典型模式。如果您不熟悉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 DBreturn Task.CompletedTask;} }

這些IJob的實現(xiàn)可以使用以下任何生存期（作用域或瞬態(tài)）來在Startup.ConfigureServices()中注冊（JobSchedule仍然可以是單例）：

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

QuartzJobRunner可以處理橫切關(guān)注點

QuartzJobRunner處理正在執(zhí)行的IJob的整個生命周期：它從容器中獲取，執(zhí)行并釋放它（在釋放范圍時）。因此，它很適合處理其他跨領(lǐng)域問題。

例如，假設(shè)您有一個需要更新數(shù)據(jù)庫并將事件發(fā)送到消息總線的服務(wù)。您可以在每個單獨的IJob實現(xiàn)中處理所有這些問題，也可以將跨領(lǐng)域的“提交更改”和“調(diào)度消息”操作移到QuartzJobRunner中。

這個例子顯然是非常基礎(chǔ)的。如果這里的代碼適合您，我建議您觀看吉米·博加德（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 changesawait dbContext.SaveChangesAsync();// db transaction succeeded, send messagesawait messageBus.DispatchAsync();}} }

這里的QuartzJobRunner實現(xiàn)與上一個非常相似，但是在執(zhí)行的我們請求的IJob之前，我們從DI容器中解析了DbContext和消息總線服務(wù)。當(dāng)作業(yè)成功執(zhí)行后（即未拋出異常），我們將所有未提交的更改保存在中DbContext，并在消息總線上調(diào)度事件。

將這些方法移到QuartzJobRunner中應(yīng)該可以減少IJob實現(xiàn)中的重復(fù)代碼，并且可以更容易地移到更正式的管道和其他模式（如果您希望以后這樣做的話）。

可替代解決方案

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

• 您的其他IJob實現(xiàn)不需要任何有關(guān)創(chuàng)建作用域的基礎(chǔ)結(jié)構(gòu)的知識，只需完成標準構(gòu)造函數(shù)注入即可

• 在IJobFactory中不需要做做任何特殊處理工作。該QuartzJobRunner通過創(chuàng)建和處理作用域隱式地處理這個問題。

但是，此處顯示的方法并不是在工作中使用范圍服務(wù)的唯一方法。馬修·阿伯特（Matthew Abbot） 在這個文章中演示了一種方法，該方法旨在以正確處理運行后的作業(yè)的方式實現(xiàn)IJobFactory。它有點笨拙，因為你必須匹配接口API，但可以說它更接近你應(yīng)該實現(xiàn)它的方式！我個人認為我會堅持使用這種QuartzJobRunner方法，但是你可以選擇最適合您的方法????

總結(jié)

在本文中，我展示了如何創(chuàng)建中間層IJob，該中間層QuartzJobRunner在調(diào)度程序需要執(zhí)行作業(yè)時創(chuàng)建。該運行程序負責(zé)創(chuàng)建一個DI范圍，實例化請求的作業(yè)并執(zhí)行它，因此最終IJob實現(xiàn)可以在其構(gòu)造函數(shù)中使用作用域中的服務(wù)。您也可以使用此方法在QuartzJobRunner中配置基本管道，盡管對此有更好的解決方案，例如裝飾器或MediatR庫中的行為。

總結(jié)

以上是生活随笔為你收集整理的【半译】在ASP.NET Core中创建内部使用作用域服务的Quartz.NET宿主服务的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。