在 ASP.NET Core 中使用托管服务实现后台任务

Posted 2022-01-15 dotNET跨平台

在 ASP.NET Core 中，后台任务作为托管服务实现。托管服务是一个类，具有实现 IHostedService 接口的后台任务逻辑。

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

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

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

创建新项目。

选择“辅助角色服务”。选择“下一步”。

在“项目名称”字段提供项目名称，或接受默认项目名称。选择“下一页”。

在“其他信息”对话框中，选择“框架” 。选择“创建”。

Package

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

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

IHostedService 接口

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

StartAsync(CancellationToken)
StopAsync(CancellationToken)

StartAsync

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

已配置应用的请求处理管道。

已启动服务器且已触发 IApplicationLifetime.ApplicationStarted。可以更改默认行为，以便在配置应用的管道并调用 ApplicationStarted 之后，运行托管服务的 StartAsync。若要更改默认行为，请在调用 CreateBuilder 后添加托管服务（以下示例中的 VideosWatcher）：

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddHostedService<VideosWatcher>();

StopAsync

StopAsync(CancellationToken) 在主机执行正常关闭时触发。StopAsync 包含结束后台任务的逻辑。实现 IDisposable 和终结器（析构函数）以处置任何非托管资源。

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

应中止应用正在执行的任何剩余后台操作。

StopAsync 中调用的任何方法都应及时返回。

但是，在请求取消后，将不会放弃任务 — 调用方等待所有任务完成。

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

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

ShutdownTimeout（当使用通用主机时）。有关详细信息，请参阅 ASP.NET Core 中的 .NET 通用主机。使用 Web 主机时为关闭超时值主机配置设置。有关详细信息，请参阅 ASP.NET Core Web 主机。托管服务在应用启动时激活一次，在应用关闭时正常关闭。如果在执行后台任务期间引发错误，即使未调用 StopAsync，也应调用 Dispose。

BackgroundService 基类

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

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

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

StartAsync 应仅限于短期任务，因为托管服务是按顺序运行的，在 StartAsync 运行完成之前不会启动其他服务。长期任务应放置在 ExecuteAsync 中。有关详细信息，请参阅 BackgroundService 数据源。

计时的后台任务

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

public class TimedHostedService : IHostedService, IDisposable

    private int executionCount = 0;
    private readonly ILogger<TimedHostedService> _logger;
    private Timer _timer = null!;

    public TimedHostedService(ILogger<TimedHostedService> logger)
    
        _logger = logger;
    

    public Task StartAsync(CancellationToken stoppingToken)
    
        _logger.LogInformation("Timed Hosted Service running.");

        _timer = new Timer(DoWork, null, TimeSpan.Zero, 
            TimeSpan.FromSeconds(5));

        return Task.CompletedTask;
    

    private void DoWork(object? state)
    
        var count = Interlocked.Increment(ref executionCount);

        _logger.LogInformation(
            "Timed Hosted Service is working. Count: Count", count);
    

    public Task StopAsync(CancellationToken stoppingToken)
    
        _logger.LogInformation("Timed Hosted Service is stopping.");

        _timer?.Change(Timeout.Infinite, 0);

        return Task.CompletedTask;
    

    public void Dispose()
    
        _timer?.Dispose();
    

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

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

services.AddHostedService<TimedHostedService>();