在 ASP.NET Core 中使用托管服务实现后台任务Background tasks with hosted services in ASP.NET Core

本文内容

作者：Jeow Li Huan

在 ASP.NET Core 中，后台任务作为托管服务实现 。托管服务是一个类，具有实现 IHostedService 接口的后台任务逻辑。本主题提供了三个托管服务示例：

查看或下载示例代码（如何下载）

辅助角色服务模板Worker Service template

ASP.NET Core 辅助角色服务模板可作为编写长期服务应用的起点。通过辅助角色服务模板创建的应用将在其项目文件中指定 Worker SDK：

  1. <Project Sdk="Microsoft.NET.Sdk.Worker">

要使用该模板作为编写托管服务应用的基础：

  • 创建新项目。
  • 选择“辅助角色服务”。选择“下一步”。
  • 在“项目名称”字段提供项目名称，或接受默认项目名称。选择“创建”。
  • 在“创建辅助角色服务”对话框中，选择“创建”。
  • 创建新项目。
  • 在侧栏中的“.NET Core”下，选择“应用”。
  • 在“ASP.NET Core”下，选择“辅助角色”。选择“下一步”。
  • 对于“目标框架”，选择“.NET Core 3.0”或更高版本。选择“下一步”。
  • 在“项目名称”字段中提供名称。选择“创建”。

将辅助角色服务 (worker) 模板用于命令行界面中的 dotnet new 命令。下面的示例中创建了名为 ContosoWorker 的辅助角色服务应用。执行命令时会自动为 ContosoWorker 应用创建文件夹。

  1. dotnet new worker -o ContosoWorker

PackagePackage

基于辅助角色服务模板的应用使用 Microsoft.NET.Sdk.Worker SDK，并且具有对 Microsoft.Extensions.Hosting 包的显式包引用。有关示例，请参阅示例应用的项目文件 (BackgroundTasksSample.csproj)。

对于使用 Microsoft.NET.Sdk.Web SDK 的 Web 应用，通过共享框架隐式引用 Microsoft.Extensions.Hosting 包。在应用的项目文件中不需要显式包引用。

IHostedService 接口IHostedService interface

IHostedService 接口为主机托管的对象定义了两种方法：

  • StartAsync(CancellationToken) – StartAsync 包含启动后台任务的逻辑。在以下操作之前调用 StartAsync ：

    • 已配置应用的请求处理管道 (Startup.Configure)。
    • 已启动服务器且已触发 IApplicationLifetime.ApplicationStarted。
      可以更改默认行为，以便在配置应用的管道并调用 ApplicationStarted 之后，运行托管服务的 StartAsync。若要更改默认行为，请在调用 ConfigureWebHostDefaults 后添加托管服务（以下示例中的 VideosWatcher）：
  1. using Microsoft.AspNetCore.Hosting;
  2. using Microsoft.Extensions.DependencyInjection;
  3. using Microsoft.Extensions.Hosting;
  5. public class Program
  6. {
  7.     public static void Main(string[] args)
  8.     {
  9.         CreateHostBuilder(args).Build().Run();
  10.     }
  12.     public static IHostBuilder CreateHostBuilder(string[] args) =>
  13.         Host.CreateDefaultBuilder(args)
  14.             .ConfigureWebHostDefaults(webBuilder =>
  15.             {
  16.                 webBuilder.UseStartup<Startup>();
  17.             })
  18.             .ConfigureServices(services =>
  19.             {
  20.                 services.AddHostedService<VideosWatcher>();
  21.             });
  22. }

默认情况下，取消令牌会有五秒超时，以指示关闭进程不再正常。在令牌上请求取消时：

  • 应中止应用正在执行的任何剩余后台操作。
  • StopAsync 中调用的任何方法都应及时返回。
    但是，在请求取消后，将不会放弃任务 — 调用方等待所有任务完成。

如果应用意外关闭（例如，应用的进程失败），则可能不会调用 StopAsync。因此，在 StopAsync 中执行的任何方法或操作都可能不会发生。

若要延长默认值为 5 秒的关闭超时值，请设置：

托管服务在应用启动时激活一次，在应用关闭时正常关闭。如果在执行后台任务期间引发错误，即使未调用 StopAsync，也应调用 Dispose。

BackgroundService 基类BackgroundService base class

BackgroundService 是用于实现长时间运行的 IHostedService 的基类。

调用 ExecuteAsync(CancellationToken) 来运行后台服务。实现返回一个 Task，其表示后台服务的整个生存期。在 ExecuteAsync 变为异步（例如通过调用 await）之前，不会启动任何其他服务。避免在 ExecuteAsync 中执行长时间的阻塞初始化工作。StopAsync(CancellationToken) 中的主机块等待完成 ExecuteAsync。

调用 IHostedService.StopAsync 时，将触发取消令牌。当激发取消令牌以便正常关闭服务时，ExecuteAsync 的实现应立即完成。否则，服务将在关闭超时后不正常关闭。有关更多信息，请参阅 IHostedService interface 部分。

计时的后台任务Timed background tasks

定时后台任务使用 System.Threading.Timer 类。计时器触发任务的 DoWork 方法。在 StopAsync 上禁用计时器，并在 Dispose 上处置服务容器时处置计时器：

  1. public class TimedHostedService : IHostedService, IDisposable
  2. {
  3.     private int executionCount = 0;
  4.     private readonly ILogger<TimedHostedService> _logger;
  5.     private Timer _timer;
  7.     public TimedHostedService(ILogger<TimedHostedService> logger)
  8.     {
  9.         _logger = logger;
  10.     }
  12.     public Task StartAsync(CancellationToken stoppingToken)
  13.     {
  14.         _logger.LogInformation("Timed Hosted Service running.");
  16.         _timer = new Timer(DoWork, null, TimeSpan.Zero, 
  17.             TimeSpan.FromSeconds(5));
  19.         return Task.CompletedTask;
  20.     }
  22.     private void DoWork(object state)
  23.     {
  24.         var count = Interlocked.Increment(ref executionCount);
  26.         _logger.LogInformation(
  27.             "Timed Hosted Service is working. Count: {Count}", count);
  28.     }
  30.     public Task StopAsync(CancellationToken stoppingToken)
  31.     {
  32.         _logger.LogInformation("Timed Hosted Service is stopping.");
  34.         _timer?.Change(Timeout.Infinite, 0);
  36.         return Task.CompletedTask;
  37.     }
  39.     public void Dispose()
  40.     {
  41.         _timer?.Dispose();
  42.     }
  43. }

Timer 不等待先前的 DoWork 执行完成，因此所介绍的方法可能并不适用于所有场景。使用 Interlocked.Increment 以原子操作的形式将执行计数器递增，这可确保多个线程不会并行更新 executionCount。

已使用 AddHostedService 扩展方法在 IHostBuilder.ConfigureServices (Program.cs) 中注册该服务：

  1. services.AddHostedService<TimedHostedService>();

在后台任务中使用有作用域的服务Consuming a scoped service in a background task

要在 BackgroundService 中使用有作用域的服务，请创建作用域。默认情况下，不会为托管服务创建作用域。

作用域后台任务服务包含后台任务的逻辑。如下示例中：

  • 服务是异步的。DoWork 方法返回 Task。出于演示目的，在 DoWork 方法中等待 10 秒的延迟。
  • ILogger 注入到服务中。
  1. internal interface IScopedProcessingService
  2. {
  3.     Task DoWork(CancellationToken stoppingToken);
  4. }
  6. internal class ScopedProcessingService : IScopedProcessingService
  7. {
  8.     private int executionCount = 0;
  9.     private readonly ILogger _logger;
  11.     public ScopedProcessingService(ILogger<ScopedProcessingService> logger)
  12.     {
  13.         _logger = logger;
  14.     }
  16.     public async Task DoWork(CancellationToken stoppingToken)
  17.     {
  18.         while (!stoppingToken.IsCancellationRequested)
  19.         {
  20.             executionCount++;
  22.             _logger.LogInformation(
  23.                 "Scoped Processing Service is working. Count: {Count}", executionCount);
  25.             await Task.Delay(10000, stoppingToken);
  26.         }
  27.     }
  28. }

托管服务创建一个作用域来解决作用域后台任务服务以调用其 DoWork 方法。DoWork 返回 ExecuteAsync 等待的 Task：

  1. public class ConsumeScopedServiceHostedService : BackgroundService
  2. {
  3.     private readonly ILogger<ConsumeScopedServiceHostedService> _logger;
  5.     public ConsumeScopedServiceHostedService(IServiceProvider services, 
  6.         ILogger<ConsumeScopedServiceHostedService> logger)
  7.     {
  8.         Services = services;
  9.         _logger = logger;
  10.     }
  12.     public IServiceProvider Services { get; }
  14.     protected override async Task ExecuteAsync(CancellationToken stoppingToken)
  15.     {
  16.         _logger.LogInformation(
  17.             "Consume Scoped Service Hosted Service running.");
  19.         await DoWork(stoppingToken);
  20.     }
  22.     private async Task DoWork(CancellationToken stoppingToken)
  23.     {
  24.         _logger.LogInformation(
  25.             "Consume Scoped Service Hosted Service is working.");
  27.         using (var scope = Services.CreateScope())
  28.         {
  29.             var scopedProcessingService = 
  30.                 scope.ServiceProvider
  31.                     .GetRequiredService<IScopedProcessingService>();
  33.             await scopedProcessingService.DoWork(stoppingToken);
  34.         }
  35.     }
  37.     public override async Task StopAsync(CancellationToken stoppingToken)
  38.     {
  39.         _logger.LogInformation(
  40.             "Consume Scoped Service Hosted Service is stopping.");
  42.         await Task.CompletedTask;
  43.     }
  44. }

已在 IHostBuilder.ConfigureServices (Program.cs) 中注册这些服务。已使用 AddHostedService 扩展方法注册托管服务：

  1. services.AddHostedService<ConsumeScopedServiceHostedService>();
  2. services.AddScoped<IScopedProcessingService, ScopedProcessingService>();

排队的后台任务Queued background tasks

后台任务队列基于 .NET 4.x QueueBackgroundWorkItem（暂定为 ASP.NET Core 内置版本）：

  1. public interface IBackgroundTaskQueue
  2. {
  3.     void QueueBackgroundWorkItem(Func<CancellationToken, Task> workItem);
  5.     Task<Func<CancellationToken, Task>> DequeueAsync(
  6.         CancellationToken cancellationToken);
  7. }
  9. public class BackgroundTaskQueue : IBackgroundTaskQueue
  10. {
  11.     private ConcurrentQueue<Func<CancellationToken, Task>> _workItems = 
  12.         new ConcurrentQueue<Func<CancellationToken, Task>>();
  13.     private SemaphoreSlim _signal = new SemaphoreSlim(0);
  15.     public void QueueBackgroundWorkItem(
  16.         Func<CancellationToken, Task> workItem)
  17.     {
  18.         if (workItem == null)
  19.         {
  20.             throw new ArgumentNullException(nameof(workItem));
  21.         }
  23.         _workItems.Enqueue(workItem);
  24.         _signal.Release();
  25.     }
  27.     public async Task<Func<CancellationToken, Task>> DequeueAsync(
  28.         CancellationToken cancellationToken)
  29.     {
  30.         await _signal.WaitAsync(cancellationToken);
  31.         _workItems.TryDequeue(out var workItem);
  33.         return workItem;
  34.     }
  35. }

在以下 QueueHostedService 示例中：

  • BackgroundProcessing 方法返回 ExecuteAsync 中等待的 Task。
  • 在 BackgroundProcessing 中，取消排队并执行队列中的后台任务。
  • 服务在 StopAsync 中停止之前，将等待工作项。
  1. public class QueuedHostedService : BackgroundService
  2. {
  3.     private readonly ILogger<QueuedHostedService> _logger;
  5.     public QueuedHostedService(IBackgroundTaskQueue taskQueue, 
  6.         ILogger<QueuedHostedService> logger)
  7.     {
  8.         TaskQueue = taskQueue;
  9.         _logger = logger;
  10.     }
  12.     public IBackgroundTaskQueue TaskQueue { get; }
  14.     protected override async Task ExecuteAsync(CancellationToken stoppingToken)
  15.     {
  16.         _logger.LogInformation(
  17.             $"Queued Hosted Service is running.{Environment.NewLine}" +
  18.             $"{Environment.NewLine}Tap W to add a work item to the " +
  19.             $"background queue.{Environment.NewLine}");
  21.         await BackgroundProcessing(stoppingToken);
  22.     }
  24.     private async Task BackgroundProcessing(CancellationToken stoppingToken)
  25.     {
  26.         while (!stoppingToken.IsCancellationRequested)
  27.         {
  28.             var workItem = 
  29.                 await TaskQueue.DequeueAsync(stoppingToken);
  31.             try
  32.             {
  33.                 await workItem(stoppingToken);
  34.             }
  35.             catch (Exception ex)
  36.             {
  37.                 _logger.LogError(ex, 
  38.                     "Error occurred executing {WorkItem}.", nameof(workItem));
  39.             }
  40.         }
  41.     }
  43.     public override async Task StopAsync(CancellationToken stoppingToken)
  44.     {
  45.         _logger.LogInformation("Queued Hosted Service is stopping.");
  47.         await base.StopAsync(stoppingToken);
  48.     }
  49. }

每当在输入设备上选择 w 键时，MonitorLoop 服务将处理托管服务的排队任务：

  • IBackgroundTaskQueue 注入到 MonitorLoop 服务中。
  • 调用 IBackgroundTaskQueue.QueueBackgroundWorkItem 来将工作项排入队列。
  • 工作项模拟长时间运行的后台任务： 
  1. public class MonitorLoop
  2. {
  3.     private readonly IBackgroundTaskQueue _taskQueue;
  4.     private readonly ILogger _logger;
  5.     private readonly CancellationToken _cancellationToken;
  7.     public MonitorLoop(IBackgroundTaskQueue taskQueue, 
  8.         ILogger<MonitorLoop> logger, 
  9.         IHostApplicationLifetime applicationLifetime)
  10.     {
  11.         _taskQueue = taskQueue;
  12.         _logger = logger;
  13.         _cancellationToken = applicationLifetime.ApplicationStopping;
  14.     }
  16.     public void StartMonitorLoop()
  17.     {
  18.         _logger.LogInformation("Monitor Loop is starting.");
  20.         // Run a console user input loop in a background thread
  21.         Task.Run(() => Monitor());
  22.     }
  24.     public void Monitor()
  25.     {
  26.         while (!_cancellationToken.IsCancellationRequested)
  27.         {
  28.             var keyStroke = Console.ReadKey();
  30.             if (keyStroke.Key == ConsoleKey.W)
  31.             {
  32.                 // Enqueue a background work item
  33.                 _taskQueue.QueueBackgroundWorkItem(async token =>
  34.                 {
  35.                     // Simulate three 5-second tasks to complete
  36.                     // for each enqueued work item
  38.                     int delayLoop = 0;
  39.                     var guid = Guid.NewGuid().ToString();
  41.                     _logger.LogInformation(
  42.                         "Queued Background Task {Guid} is starting.", guid);
  44.                     while (!token.IsCancellationRequested && delayLoop < 3)
  45.                     {
  46.                         try
  47.                         {
  48.                             await Task.Delay(TimeSpan.FromSeconds(5), token);
  49.                         }
  50.                         catch (OperationCanceledException)
  51.                         {
  52.                             // Prevent throwing if the Delay is cancelled
  53.                         }
  55.                         delayLoop++;
  57.                         _logger.LogInformation(
  58.                             "Queued Background Task {Guid} is running. " +
  59.                             "{DelayLoop}/3", guid, delayLoop);
  60.                     }
  62.                     if (delayLoop == 3)
  63.                     {
  64.                         _logger.LogInformation(
  65.                             "Queued Background Task {Guid} is complete.", guid);
  66.                     }
  67.                     else
  68.                     {
  69.                         _logger.LogInformation(
  70.                             "Queued Background Task {Guid} was cancelled.", guid);
  71.                     }
  72.                 });
  73.             }
  74.         }
  75.     }
  76. }

已在 IHostBuilder.ConfigureServices (Program.cs) 中注册这些服务。已使用 AddHostedService 扩展方法注册托管服务：

  1. services.AddSingleton<MonitorLoop>();
  2. services.AddHostedService<QueuedHostedService>();
  3. services.AddSingleton<IBackgroundTaskQueue, BackgroundTaskQueue>();

已在 Program.Main 中启动 MontiorLoop：

  1. var monitorLoop = host.Services.GetRequiredService<MonitorLoop>();
  2. monitorLoop.StartMonitorLoop();

在 ASP.NET Core 中，后台任务作为托管服务实现 。托管服务是一个类，具有实现 IHostedService 接口的后台任务逻辑。本主题提供了三个托管服务示例：

查看或下载示例代码（如何下载）

PackagePackage

引用 Microsoft.AspNetCore.App 元包或将包引用添加到 Microsoft.Extensions.Hosting 包。

IHostedService 接口IHostedService interface

托管服务实现 IHostedService 接口。该接口为主机托管的对象定义了两种方法：

默认情况下，取消令牌会有五秒超时，以指示关闭进程不再正常。在令牌上请求取消时：

  • 应中止应用正在执行的任何剩余后台操作。
  • StopAsync 中调用的任何方法都应及时返回。
    但是，在请求取消后，将不会放弃任务 — 调用方等待所有任务完成。

如果应用意外关闭（例如，应用的进程失败），则可能不会调用 StopAsync。因此，在 StopAsync 中执行的任何方法或操作都可能不会发生。

若要延长默认值为 5 秒的关闭超时值，请设置：

托管服务在应用启动时激活一次，在应用关闭时正常关闭。如果在执行后台任务期间引发错误，即使未调用 StopAsync，也应调用 Dispose。

计时的后台任务Timed background tasks

定时后台任务使用 System.Threading.Timer 类。计时器触发任务的 DoWork 方法。在 StopAsync 上禁用计时器，并在 Dispose 上处置服务容器时处置计时器：

  1. internal class TimedHostedService : IHostedService, IDisposable
  2. {
  3.     private readonly ILogger _logger;
  4.     private Timer _timer;
  6.     public TimedHostedService(ILogger<TimedHostedService> logger)
  7.     {
  8.         _logger = logger;
  9.     }
  11.     public Task StartAsync(CancellationToken cancellationToken)
  12.     {
  13.         _logger.LogInformation("Timed Background Service is starting.");
  15.         _timer = new Timer(DoWork, null, TimeSpan.Zero, 
  16.             TimeSpan.FromSeconds(5));
  18.         return Task.CompletedTask;
  19.     }
  21.     private void DoWork(object state)
  22.     {
  23.         _logger.LogInformation("Timed Background Service is working.");
  24.     }
  26.     public Task StopAsync(CancellationToken cancellationToken)
  27.     {
  28.         _logger.LogInformation("Timed Background Service is stopping.");
  30.         _timer?.Change(Timeout.Infinite, 0);
  32.         return Task.CompletedTask;
  33.     }
  35.     public void Dispose()
  36.     {
  37.         _timer?.Dispose();
  38.     }
  39. }

Timer 不等待先前的 DoWork 执行完成，因此所介绍的方法可能并不适用于所有场景。

已使用 AddHostedService 扩展方法在 Startup.ConfigureServices 中注册该服务：

  1. services.AddHostedService<TimedHostedService>();

在后台任务中使用有作用域的服务Consuming a scoped service in a background task

要在 IHostedService 中使用有作用域的服务，请创建一个作用域。默认情况下，不会为托管服务创建作用域。

作用域后台任务服务包含后台任务的逻辑。在以下示例中，将 ILogger 注入到服务中：

  1. internal interface IScopedProcessingService
  2. {
  3.     void DoWork();
  4. }
  6. internal class ScopedProcessingService : IScopedProcessingService
  7. {
  8.     private readonly ILogger _logger;
  10.     public ScopedProcessingService(ILogger<ScopedProcessingService> logger)
  11.     {
  12.         _logger = logger;
  13.     }
  15.     public void DoWork()
  16.     {
  17.         _logger.LogInformation("Scoped Processing Service is working.");
  18.     }
  19. }

托管服务创建一个作用域来解决作用域后台任务服务以调用其 DoWork 方法：

  1. internal class ConsumeScopedServiceHostedService : IHostedService
  2. {
  3.     private readonly ILogger _logger;
  5.     public ConsumeScopedServiceHostedService(IServiceProvider services, 
  6.         ILogger<ConsumeScopedServiceHostedService> logger)
  7.     {
  8.         Services = services;
  9.         _logger = logger;
  10.     }
  12.     public IServiceProvider Services { get; }
  14.     public Task StartAsync(CancellationToken cancellationToken)
  15.     {
  16.         _logger.LogInformation(
  17.             "Consume Scoped Service Hosted Service is starting.");
  19.         DoWork();
  21.         return Task.CompletedTask;
  22.     }
  24.     private void DoWork()
  25.     {
  26.         _logger.LogInformation(
  27.             "Consume Scoped Service Hosted Service is working.");
  29.         using (var scope = Services.CreateScope())
  30.         {
  31.             var scopedProcessingService = 
  32.                 scope.ServiceProvider
  33.                     .GetRequiredService<IScopedProcessingService>();
  35.             scopedProcessingService.DoWork();
  36.         }
  37.     }
  39.     public Task StopAsync(CancellationToken cancellationToken)
  40.     {
  41.         _logger.LogInformation(
  42.             "Consume Scoped Service Hosted Service is stopping.");
  44.         return Task.CompletedTask;
  45.     }
  46. }

已在 Startup.ConfigureServices 中注册这些服务。已使用 AddHostedService 扩展方法注册 IHostedService 实现：

  1. services.AddHostedService<ConsumeScopedServiceHostedService>();
  2. services.AddScoped<IScopedProcessingService, ScopedProcessingService>();

排队的后台任务Queued background tasks

后台任务队列基于 .NET Framework 4.x QueueBackgroundWorkItem（暂定为 ASP.NET Core 内置版本）：

  1. public interface IBackgroundTaskQueue
  2. {
  3.     void QueueBackgroundWorkItem(Func<CancellationToken, Task> workItem);
  5.     Task<Func<CancellationToken, Task>> DequeueAsync(
  6.         CancellationToken cancellationToken);
  7. }
  9. public class BackgroundTaskQueue : IBackgroundTaskQueue
  10. {
  11.     private ConcurrentQueue<Func<CancellationToken, Task>> _workItems = 
  12.         new ConcurrentQueue<Func<CancellationToken, Task>>();
  13.     private SemaphoreSlim _signal = new SemaphoreSlim(0);
  15.     public void QueueBackgroundWorkItem(
  16.         Func<CancellationToken, Task> workItem)
  17.     {
  18.         if (workItem == null)
  19.         {
  20.             throw new ArgumentNullException(nameof(workItem));
  21.         }
  23.         _workItems.Enqueue(workItem);
  24.         _signal.Release();
  25.     }
  27.     public async Task<Func<CancellationToken, Task>> DequeueAsync(
  28.         CancellationToken cancellationToken)
  29.     {
  30.         await _signal.WaitAsync(cancellationToken);
  31.         _workItems.TryDequeue(out var workItem);
  33.         return workItem;
  34.     }
  35. }

在 QueueHostedService 中，队列中的后台任务会取消排队，并作为 BackgroundService 执行，此类是用于实现长时间运行 IHostedService 的基类：

  1. public class QueuedHostedService : BackgroundService
  2. {
  3.     private readonly ILogger _logger;
  5.     public QueuedHostedService(IBackgroundTaskQueue taskQueue, 
  6.         ILoggerFactory loggerFactory)
  7.     {
  8.         TaskQueue = taskQueue;
  9.         _logger = loggerFactory.CreateLogger<QueuedHostedService>();
  10.     }
  12.     public IBackgroundTaskQueue TaskQueue { get; }
  14.     protected async override Task ExecuteAsync(
  15.         CancellationToken cancellationToken)
  16.     {
  17.         _logger.LogInformation("Queued Hosted Service is starting.");
  19.         while (!cancellationToken.IsCancellationRequested)
  20.         {
  21.             var workItem = await TaskQueue.DequeueAsync(cancellationToken);
  23.             try
  24.             {
  25.                 await workItem(cancellationToken);
  26.             }
  27.             catch (Exception ex)
  28.             {
  29.                 _logger.LogError(ex, 
  30.                    "Error occurred executing {WorkItem}.", nameof(workItem));
  31.             }
  32.         }
  34.         _logger.LogInformation("Queued Hosted Service is stopping.");
  35.     }
  36. }

已在 Startup.ConfigureServices 中注册这些服务。已使用 AddHostedService 扩展方法注册 IHostedService 实现：

  1. services.AddHostedService<QueuedHostedService>();
  2. services.AddSingleton<IBackgroundTaskQueue, BackgroundTaskQueue>();

在索引页模型类中：

  • 将 IBackgroundTaskQueue 注入构造函数并分配给 Queue。
  • 注入 IServiceScopeFactory 并将其分配给 _serviceScopeFactory。工厂用于创建 IServiceScope 的实例，用于在范围内创建服务。创建范围是为了使用应用的AppDbContext（设置了范围的服务），以在 IBackgroundTaskQueue（单一实例服务）中写入数据库记录。
  1. public class IndexModel : PageModel
  2. {
  3.     private readonly AppDbContext _db;
  4.     private readonly ILogger _logger;
  5.     private readonly IServiceScopeFactory _serviceScopeFactory;
  7.     public IndexModel(AppDbContext db, IBackgroundTaskQueue queue, 
  8.         ILogger<IndexModel> logger, IServiceScopeFactory serviceScopeFactory)
  9.     {
  10.         _db = db;
  11.         _logger = logger;
  12.         Queue = queue;
  13.         _serviceScopeFactory = serviceScopeFactory;
  14.     }
  16.     public IBackgroundTaskQueue Queue { get; }

在索引页上选择“添加任务”按钮时，会执行 OnPostAddTask 方法 。调用 QueueBackgroundWorkItem 来将工作项排入队列：

  1. public IActionResult OnPostAddTaskAsync()
  2. {
  3.     Queue.QueueBackgroundWorkItem(async token =>
  4.     {
  5.         var guid = Guid.NewGuid().ToString();
  7.         using (var scope = _serviceScopeFactory.CreateScope())
  8.         {
  9.             var scopedServices = scope.ServiceProvider;
  10.             var db = scopedServices.GetRequiredService<AppDbContext>();
  12.             for (int delayLoop = 1; delayLoop < 4; delayLoop++)
  13.             {
  14.                 try
  15.                 {
  16.                     db.Messages.Add(
  17.                         new Message() 
  18.                         { 
  19.                             Text = $"Queued Background Task {guid} has " +
  20.                                 $"written a step. {delayLoop}/3"
  21.                         });
  22.                     await db.SaveChangesAsync();
  23.                 }
  24.                 catch (Exception ex)
  25.                 {
  26.                     _logger.LogError(ex, 
  27.                         "An error occurred writing to the " +
  28.                         "database. Error: {Message}", ex.Message);
  29.                 }
  31.                 await Task.Delay(TimeSpan.FromSeconds(5), token);
  32.             }
  33.         }
  35.         _logger.LogInformation(
  36.             "Queued Background Task {Guid} is complete. 3/3", guid);
  37.     });
  39.     return RedirectToPage();
  40. }

其他资源Additional resources