Blazor Server中ILogger.BeginScope及日志中间件失效问题

问题根源 #

Blazor Server基于SignalR实现交互，普通HTTP中间件仅处理初始页面加载的HTTP请求，而组件后续的所有操作（如按钮点击、状态变更）都是通过SignalR Hub调用完成的，这些Hub调用不会经过你注册的UserScopeMiddleware，所以中间件创建的日志作用域无法覆盖组件内的日志输出。

可行解决方案 #

方案1：使用SignalR Hub过滤器（推荐） #

通过Hub过滤器为每个Blazor组件的Hub调用添加日志作用域，覆盖所有组件交互场景：

1. 创建Hub过滤器类：

public class UserScopeHubFilter : IHubFilter
{
    private readonly ILogger<UserScopeHubFilter> _logger;

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

    public async ValueTask<object> InvokeMethodAsync(HubInvocationContext invocationContext, Func<HubInvocationContext, ValueTask<object>> next)
    {
        if (invocationContext.Context.User.Identity is { IsAuthenticated: true })
        {
            var username = invocationContext.Context.User.Identity.Name;
            using (_logger.BeginScope("User:{username}", username))
            {
                return await next(invocationContext);
            }
        }
        return await next(invocationContext);
    }
}

2. 在Program.cs中注册过滤器：

builder.Services.AddSignalR(options =>
{
    options.AddFilter<UserScopeHubFilter>();
});

方案2：使用Scoped服务管理作用域 #

利用Blazor Server的Scoped服务生命周期（与用户连接绑定），在连接初始化时创建全局日志作用域：

1. 创建Scoped服务类：

public class UserLogScopeService : IAsyncDisposable
{
    private readonly ILogger<UserLogScopeService> _logger;
    private IDisposable? _scope;

    public UserLogScopeService(ILogger<UserLogScopeService> logger, IHttpContextAccessor httpContextAccessor)
    {
        _logger = logger;
        var httpContext = httpContextAccessor.HttpContext;
        if (httpContext?.User.Identity is { IsAuthenticated: true })
        {
            var username = httpContext.User.Identity.Name;
            _scope = _logger.BeginScope("User:{username}", username);
        }
    }

    public ValueTask DisposeAsync()
    {
        _scope?.Dispose();
        return ValueTask.CompletedTask;
    }
}

2. 在Program.cs中注册服务：

builder.Services.AddScoped<UserLogScopeService>();
builder.Services.AddHttpContextAccessor(); // 必须添加，用于获取初始请求的用户信息

3. 在根组件（如MainLayout.razor）中注入该服务：

@inject UserLogScopeService LogScopeService

Scoped服务会在用户连接建立时初始化，自动创建日志作用域，直到连接断开时释放。

额外配置检查 #

确保日志配置中开启了作用域包含，以JSON控制台日志为例：

"Logging": {
  "LogLevel": {
    "Default": "Information",
    "Microsoft.AspNetCore": "Warning"
  },
  "Console": {
    "FormatterName": "Json",
    "FormatterOptions": {
      "IncludeScopes": true, // 必须设为true，才会输出作用域信息
      "TimestampFormat": "yyyy-MM-dd HH:mm:ss",
      "UseUtcTimestamp": false
    }
  }
}

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