.NET Core BackgroundService崩溃时返回非零退出码问题

1. Host.Run()的异常隔离机制：Host.Run()是同步阻塞方法，它内部会托管所有IHostedService的生命周期。当BackgroundService的ExecuteAsync方法抛出异步异常时，主机的内部调度器会捕获该异常，不会将其冒泡到Main方法的try/catch块中。
2. StopApplication()触发正常关闭流程：即使你在异常后重新抛出并调用_lifetime.StopApplication()，主机仍会执行正常的关闭逻辑（停止所有服务、释放资源等），最终Host.Run()会正常返回，导致Main方法执行return 0，而非进入catch块返回1。

方案1：改用异步主机启动方法 #

将Main方法改为异步形式，使用Host.RunAsync()并等待其完成，这样异步异常会被正确冒泡到try/catch块：

public class Program
{
    public static async Task<int> Main(string[] args)
    {
        try
        {
            var builder = Host.CreateApplicationBuilder(args);
            builder.Services.AddHostedService<MyBackgroundService>();
            var host = builder.Build();
            await host.RunAsync();
            return 0;
        }
        catch (Exception)
        {
            return 1;
        }
    }
}

方案2：在服务内部直接设置退出码 #

如果需要保持Main同步，可以在BackgroundService的异常处理中直接调用Environment.Exit(1)，跳过主机的正常关闭流程：

protected override Task ExecuteAsync(CancellationToken stoppingToken) => Task.Run(async () =>
{
    try
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            await Task.Delay(1000);
            if (Random.Shared.NextDouble() < 0.5) throw new Exception("RANDOM CRASH!");
        }
    }
    catch
    {
        Environment.Exit(1); // 直接设置退出码并终止进程
    }
    finally
    {
        _lifetime.StopApplication();
    }
});

方案3：通过主机生命周期事件传递异常状态 #

利用IHostApplicationLifetime的事件，在服务异常时记录状态，在主机关闭后检查状态设置退出码：

public class Program
{
    private static int _exitCode = 0;

    public static int Main(string[] args)
    {
        var builder = Host.CreateApplicationBuilder(args);
        builder.Services.AddHostedService<MyBackgroundService>();
        var host = builder.Build();

        // 注册应用停止事件，检查异常状态
        host.Services.GetRequiredService<IHostApplicationLifetime>().ApplicationStopped.Register(() =>
        {
            if (_exitCode != 0)
            {
                Environment.ExitCode = _exitCode;
            }
        });

        host.Run();
        return Environment.ExitCode;
    }

    public class MyBackgroundService : BackgroundService
    {
        private readonly IHostApplicationLifetime _lifetime;
        public MyBackgroundService(IHostApplicationLifetime lifetime) => _lifetime = lifetime;

        protected override Task ExecuteAsync(CancellationToken stoppingToken) => Task.Run(async () =>
        {
            try
            {
                while (!stoppingToken.IsCancellationRequested)
                {
                    await Task.Delay(1000);
                    if (Random.Shared.NextDouble() < 0.5) throw new Exception("RANDOM CRASH!");
                }
            }
            catch
            {
                _exitCode = 1; // 设置异常退出码
            }
            finally
            {
                _lifetime.StopApplication();
            }
        });
    }
}

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