C# IHostedService的用法 - 在ASP.NET Core中运行后台任务-C#.Net教程-PHP中文网

C# IHostedService的用法 - 在ASP.NET Core中运行后台任务

小老鼠

发布： 2025-12-04 14:01:02

原创

660人浏览过

IHostedService是ASP.NET Core中用于托管长时间运行后台任务的接口，含StartAsync（启动时执行）和StopAsync（关闭时优雅停止）方法；可通过实现该接口或继承BackgroundService（提供ExecuteAsync抽象方法）来创建定时任务、消息队列处理等服务，并需用AddHostedService注册以确保生命周期由主机管理。

c# ihostedservice的用法 - 在asp.net core中运行后台任务

在 ASP.NET Core 中，如果需要运行长时间运行的后台任务，比如定时处理数据、轮询数据库、发送邮件或维护缓存，IHostedService 是一个非常合适的选择。它允许你在应用启动和关闭时执行自定义逻辑，非常适合托管后台服务。

什么是 IHostedService？

IHostedService 是一个接口，包含两个方法：

StartAsync(CancellationToken cancellationToken)：在应用启动后调用，用于开始后台任务。
StopAsync(CancellationToken cancellationToken)：在应用关闭时调用，用于优雅地停止任务。

你只需实现这个接口，将你的后台逻辑放入其中，ASP.NET Core 会自动管理它的生命周期。

如何使用 IHostedService？

以一个简单的定时任务为例，每 10 秒打印一条日志。

创建一个类实现 IHostedService：

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

public class TimedHostedService : IHostedService
{
    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 is starting.");

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

        return Task.CompletedTask;
    }

    private void DoWork(object? state)
    {
        if (!_timer!.Disposed)
        {
            _logger.LogInformation("Timed Hosted Service is working. Time: {Time}", DateTime.Now);
        }
    }

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

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

        return Task.CompletedTask;
    }
}

登录后复制

在 Program.cs 中注册服务：

var builder = WebApplication.CreateBuilder(args);

// 添加 Hosted Service
builder.Services.AddHostedService<TimedHostedService>();

var app = builder.Build();

app.Run();

登录后复制

这样，当应用启动时，StartAsync 被调用，定时器开始工作；关闭时，StopAsync 确保定时器被正确释放。

更复杂的场景：使用 BackgroundService

直接实现 IHostedService 对于复杂任务可能不够方便。ASP.NET Core 提供了抽象类 BackgroundService，更适合长时间运行的任务，比如从队列中消费消息。

版纳武林DIY企业建站系统

系统简介1:安全可靠：在微软主推的.NET开发平台上，采用业界领先的ASP.NET技术和C#语言开发，不仅安全可靠，并能保证系统的高性能运行。2:简单易用：版纳武林DIY企业建站系统真正做到以人为本、以用户体验为中心，能使您快速搭建您的网站。后台管理操作简单，一目了然，没有夹杂多余的功能和广告。3:布局易改：版纳武林DIY企业建站系统采用的是博客形式的风格管理，让您真正感受到我的地盘听我的.4:

查看详情

using Microsoft.Extensions.Hosting;
using System.Threading.Channels;

public class QueuedHostedService : BackgroundService
{
    private readonly ChannelReader<string> _reader;

    public QueuedHostedService(Channel<string> channel)
    {
        _reader = channel.Reader;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        await foreach (var message in _reader.ReadAllAsync(stoppingToken))
        {
            Console.WriteLine($"Processing message: {message}");
            await Task.Delay(1000, stoppingToken); // 模拟处理耗时
        }
    }
}

登录后复制

BackgroundService 内部实现了 IHostedService，并提供了一个抽象的 ExecuteAsync 方法，你可以在这里写主循环逻辑，避免手动管理 CancellationToken 和循环。