.NET 6 BackgroundService.ExecuteAsync取消令牌与异常异常问题咨询

为什么循环后的代码永远不执行？ #

按下Ctrl-C时，Host会触发stoppingToken的取消信号。此时await Task.Delay(1000, stoppingToken)会直接抛出TaskCanceledException，代码流程直接跳转到catch块，不会执行到循环结束后的日志语句。

为什么添加异常捕获后反而显示异常堆栈？ #

你使用了_logger.LogWarning(ex, "Execution Cancelled")，其中第一个参数传入了异常实例。微软日志框架（或第三方日志库如Serilog）在接收到异常参数时，会自动输出异常的堆栈跟踪信息——这不是异常未被捕获，而是日志本身的行为，是你主动让日志打印了异常详情。

而未添加异常处理时，BackgroundService基类会自动处理TaskCanceledException，将其视为正常的服务终止信号，不会将异常暴露到控制台，所以看起来是“干净退出”。

解决方案 #

方案1：仅记录取消信息，不输出异常堆栈 #

修改catch块的日志调用，使用不带异常参数的重载：

catch (Exception ex) when (stoppingToken.IsCancellationRequested)
{
    _logger.LogWarning("Execution Cancelled");
}

这样只会打印警告信息，不会输出异常堆栈，和未加处理时的“干净”效果一致，同时你能自定义取消日志。

方案2：调整逻辑，让循环正常退出（避免捕获取消异常） #

如果你希望执行到循环后的代码，可以在Task.Delay之外检查令牌，用Task.WhenAny配合令牌避免抛出异常：

protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
    await Task.Yield();

    try
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            _logger.LogInformation($"Worker running at: {DateTimeOffset.Now} / Cancel: {stoppingToken.IsCancellationRequested}");
            
            // 用WhenAny响应取消信号，同时避免Delay抛出异常
            await Task.WhenAny(Task.Delay(1000), Task.Delay(Timeout.Infinite, stoppingToken));
        }
        
        // 现在这段代码会被执行到
        _logger.LogInformation("Execution ended. Cancelation token cancelled = {IsCancellationRequested}",stoppingToken.IsCancellationRequested);
    }
    catch (Exception ex) when (!stoppingToken.IsCancellationRequested)
    {
        _logger.LogError(ex, "Unhandeled exception. Execution Stopping");
    }
}

这种方式下，取消信号会触发Task.Delay(Timeout.Infinite, stoppingToken)完成，WhenAny返回后循环检查到令牌已取消，从而退出执行后续代码，只有非取消类异常才会被捕获日志。

方案3：保留异常捕获但隐藏堆栈（自定义日志格式） #

如果需要记录异常但不想显示堆栈，可以修改日志配置（比如appsettings.json），调整日志模板排除异常堆栈输出。例如针对微软日志：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.Hosting.Lifetime": "Information"
    },
    "Console": {
      "FormatterName": "simple",
      "FormatterOptions": {
        "IncludeScopes": false,
        "SingleLine": true,
        "TimestampFormat": "HH:mm:ss ",
        "UseUtcTimestamp": false,
        "DisableColors": false,
        "ExceptionFormat": "None" // 隐藏异常堆栈
      }
    }
  }
}

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