了解 .NET 8 中的定时任务或后台服务：IHostedService 和 BackgroundService

news2024/10/27 22:40:55

IHostedService.NET 8 引入了使用和管理后台任务的强大功能BackgroundService。这些服务使长时间运行的操作（例如计划任务、后台处理和定期维护任务）可以无缝集成到您的应用程序中。本文探讨了这些新功能，并提供了实际示例来帮助您入门。您可以在我的GitHub 存储库中找到这些示例的源代码。

什么是后台服务？
.NET 中的后台服务允许您独立于主应用程序线程在后台运行任务。这对于需要连续或定期运行且不会阻塞主应用程序流程的任务至关重要。

IHostedService 接口

该IHostedService接口定义了两种方法：

StartAsync(CancellationToken cancellationToken)：应用程序主机启动时调用。

StopAsync(CancellationToken cancellationToken)：当应用程序主机正在执行正常关闭时调用。

IHostedService 实现示例：

using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

public class TimedHostedService : IHostedService, IDisposable
{
private readonly ILogger<TimedHostedService> _logger;
private Timer _timer;

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

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

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

return Task.CompletedTask;
}

private void DoWork(object state)
{
_logger.LogInformation("Timed Hosted Service is working.");
}

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

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

return Task.CompletedTask;
}

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

BackgroundService Class
该类BackgroundService是一个抽象基类，可简化后台任务的实现。它提供了一个方法来重写：

ExecuteAsync(CancellationToken stoppingToken)：包含后台任务的逻辑并运行直到应用程序关闭。

BackgroundService 实现示例：

using System;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

public class TimedBackgroundService : BackgroundService
{
private readonly ILogger<TimedBackgroundService> _logger;

public TimedBackgroundService(ILogger<TimedBackgroundService> logger)
{
_logger = logger;
}

protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
_logger.LogInformation("Timed Background Service running.");

while (!stoppingToken.IsCancellationRequested)
{
_logger.LogInformation("Timed Background Service is working.");
await Task.Delay(TimeSpan.FromSeconds(5), stoppingToken);
}

_logger.LogInformation("Timed Background Service is stopping.");
}
}

实际用途：
要在您的 .NET 应用程序中使用这些后台服务，您需要在依赖注入容器中注册它们。这可以在文件中完成Program.cs。

注册托管服务：

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using System.Threading.Tasks;

public class Program
{
public static async Task Main(string[] args)
{
var host = Host.CreateDefaultBuilder(args)
.ConfigureServices(services =>
{
services.AddHostedService<TimedHostedService>();
services.AddHostedService<TimedBackgroundService>();
})
.Build();

await host.RunAsync();
}
}