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

来源:https://www.cnblogs.com/yilezhu/archive/2020/04/23/12757411.html
-Advertisement-
Play Games

在我的 "上一篇文章中" ，我展示瞭如何使用ASP.NET Core創建Quartz.NET托管服務並使用它來按計劃運行後臺任務。不幸的是，由於Quartz.NET API的工作方式，在Quartz作業中使用Scoped依賴項註入服務有些麻煩。說明下這篇文章部分採用機翻。 作者：依樂祝 譯文地址：h ...


在我的上一篇文章中，我展示瞭如何使用ASP.NET Core創建Quartz.NET托管服務並使用它來按計劃運行後臺任務。不幸的是，由於Quartz.NET API的工作方式，在Quartz作業中使用Scoped依賴項註入服務有些麻煩。說明下這篇文章部分採用機翻。

作者：依樂祝

譯文地址：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服務的方法。您可以使用相同的方法來管理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方法，但是你可以選擇最適合您的方法

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Asp.Net Core 3.0 學習3、Web Api 文件上傳 Ajax請求以及跨域問題
    1、創建Api項目 我用的是VS2019 Core3.1 。打開Vs2019 創建Asp.Net Core Web應用程式命名CoreWebApi 創建選擇API 在Controller文件夾下麵添加一個Api控制器 FileUp，修改Api的路由 [Route("api/[controller]/ ...
  • LnskyDB 3.1版本已支持資料庫事務
    普通調用方法 調用方法如下 須通過'DBTool.BeginTransaction()'開啟事務調用'tran.Complete()'提交事務,不調用'tran.Complete()'當using結束會自動回滾 註意'DBTool.BeginTransaction()'必須使用using 事務嵌套調 ...
  • c# 類
    c 類 當你定義一個類時，你定義了一個數據類型的藍圖。這實際上並沒有定義任何的數據，但它定義了類的名稱意味著什麼，也就是說，類的對象由什麼組成及在這個對象上可執行什麼操作。對象是類的實例。構成類的方法和變數成為類的成員。 聲明類 創建對象 通過使用 new 關鍵字（後跟對象將基於的類的名稱）可以創建 ...
  • 用C#寫個小程式爬取漫畫
    這是要爬的地址 https://www.iqiyi.com/manhua/detail_18yzlq8jc5.html，F12 查看網路發現他是通過 https://www.iqiyi.com/manhua/catalog/18yzlq8jc5/ 這個介面獲取目錄信息的。 這是第一話的地址 http ...
  • c#方法
    c 方法 一個方法是把一些相關的語句組織在一起，用來執行一個任務的語句塊。 方法簽名 通過指定在 或 中聲明方法： 可選的訪問級別，如 或 。 預設值為 。 可選的修飾符，如 或 。 返回值，或 （如果該方法不具有）。 方法名。 任何方法參數。 方法參數在括弧內，並且用逗號分隔。 空括弧指示方法不需 ...
  • wpf開源控制項MahApps.Metro
    wpf開源控制項MahApps.Metro 安裝 您可以通過NuGet GUI（右鍵單擊您的項目，單擊 Manage NuGet Packages ，選擇 Online 並搜索 MahApps.Metro ）或使用Package Manager控制台安裝MahApps.Metro。 或使用軟體包管理器 ...
  • .Net Core Send Email
    1、安裝Nuget包MailKit，引用命名空間。 using MailKit.Net.Smtp; using MimeKit; 註意：引用MailKit對應最新版本 2、定義收發地址和標題 MimeMessage message = new MimeMessage(); MailboxAddres ...
  • Mobius 一個運行在 .NET Core 上的 .NET 運行時
    一個 .NET 應用僅僅只是一塊在 .NET 運行時上面運行的二進位代碼。而 .NET 運行時只是一個能執行這項任務的程式。當前的 .NET Framework 和 .NET Core 運行時採用 C++ 編寫，而 Mobius 是一個使用 C# 重寫的 .NET 運行時，重寫包括 JIT 編譯和 ... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類