.NET 7 Web API如何让BackgroundService阻塞应用启动至首次任务执行？

要让你的BackgroundService阻塞应用启动流程，直到首次"do some work"逻辑执行完毕，你可以通过以下两种方案实现：

方案一：抽离初始逻辑，在主机启动前手动执行 #

这种方式将首次执行的逻辑抽离为独立方法，在Web应用启动前主动调用并等待完成，确保API服务在初始任务完成后才对外提供服务。

1. 修改BackgroundService类，抽离初始工作方法 #

public class MyBackgroundService : BackgroundService
{
    private readonly IServiceProvider _provider;

    public MyBackgroundService(IServiceProvider provider)
    {
        _provider = provider;
    }

    // 抽离首次执行的核心工作逻辑
    public async Task DoInitialWorkAsync(CancellationToken cancellationToken)
    {
        using var scope = _provider.CreateScope();
        // 这里放置你的"do some work"逻辑
        // 示例：获取作用域内的服务并执行任务
        // var someService = scope.ServiceProvider.GetRequiredService<ISomeService>();
        // await someService.DoWorkAsync(cancellationToken);
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        // 后台循环中复用初始工作方法
        while (!stoppingToken.IsCancellationRequested)
        {
            await DoInitialWorkAsync(stoppingToken);
            await Task.Delay(60000, stoppingToken);
        }
    }
}

2. 在Program.cs中执行初始工作后启动应用 #

var builder = WebApplication.CreateBuilder(args);

// 注册后台服务
builder.Services.AddHostedService<MyBackgroundService>();

// 注册其他服务...

var app = builder.Build();

// 执行初始工作，阻塞启动流程直到完成
using var scope = app.Services.CreateScope();
var backgroundService = scope.ServiceProvider.GetRequiredService<MyBackgroundService>();
await backgroundService.DoInitialWorkAsync(CancellationToken.None);

// 配置API中间件
app.MapControllers();

// 启动Web API服务
app.Run();

方案二：重写StartAsync方法阻塞启动流程 #

通过重写BackgroundService的StartAsync方法，在后台服务启动阶段先执行初始工作，完成后再启动循环任务，利用主机对StartAsync的等待机制阻塞应用启动。

修改BackgroundService类 #

public class MyBackgroundService : BackgroundService
{
    private readonly IServiceProvider _provider;
    private Task _executingTask;
    private readonly CancellationTokenSource _stoppingCts = new();

    public MyBackgroundService(IServiceProvider provider)
    {
        _provider = provider;
    }

    public override async Task StartAsync(CancellationToken cancellationToken)
    {
        // 先执行初始工作，阻塞主机启动直到完成
        using var scope = _provider.CreateScope();
        // 这里放置你的"do some work"逻辑
        // var someService = scope.ServiceProvider.GetRequiredService<ISomeService>();
        // await someService.DoWorkAsync(cancellationToken);

        // 启动后台循环任务
        _executingTask = ExecuteAsync(_stoppingCts.Token);
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            using var scope = _provider.CreateScope();
            // 这里放置你的"do some work"逻辑
            await Task.Delay(60000, stoppingToken);
        }
    }

    public override async Task StopAsync(CancellationToken cancellationToken)
    {
        _stoppingCts.Cancel();
        if (_executingTask != null)
        {
            await Task.WhenAny(_executingTask, Task.Delay(Timeout.Infinite, cancellationToken));
        }
    }
}

注册方式保持不变 #

services.AddHostedService<MyBackgroundService>();

注意事项 #

• 若初始工作耗时较长，需调整应用启动超时配置（如IIS的启动超时、Kestrel的相关设置），避免启动被强制终止。
• 务必处理初始工作中的异常，若任务失败应及时终止应用启动或进行容错处理，防止API服务启动后后台任务异常。

内容的提问来源于stack exchange，提问作者filur