如何为类实例发起的所有日志添加前缀（或作用域）？

问题根源 #

你之前使用BeginScope出现作用域叠加，是因为BeginScope基于AsyncLocal实现上下文级作用域，而非实例级。同一上下文内创建多个A实例时，新作用域会叠加旧的，导致日志出现A123 => A234这类嵌套前缀。

可行的原生解决方案 #

方案1：实例绑定的Logger装饰器（推荐） #

通过实现ILogger装饰器，为每个A实例创建专属Logger，自动给所有日志添加实例ID前缀。这种方式直接绑定到实例，不受上下文影响。

步骤1：实现Logger装饰器

using Microsoft.Extensions.Logging;

public class InstanceScopedLogger : ILogger
{
    private readonly ILogger _innerLogger;
    private readonly string _instancePrefix;

    public InstanceScopedLogger(ILogger innerLogger, string instancePrefix)
    {
        _innerLogger = innerLogger;
        _instancePrefix = instancePrefix;
    }

    public IDisposable BeginScope<TState>(TState state) => _innerLogger.BeginScope(state);

    public bool IsEnabled(LogLevel logLevel) => _innerLogger.IsEnabled(logLevel);

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
    {
        // 包装日志内容，添加实例前缀
        var wrappedFormatter = new Func<TState, Exception, string>((s, ex) => $"{_instancePrefix}: {formatter(s, ex)}");
        _innerLogger.Log(logLevel, eventId, state, exception, wrappedFormatter);
    }

    // 扩展方法简化创建
    public static ILogger CreateInstanceScoped(this ILogger logger, string prefix)
    {
        return new InstanceScopedLogger(logger, prefix);
    }
}

步骤2：修改A类使用装饰器Logger

public class A
{
    private ILogger _logger;
    private int _id;
    private B _b;

    public A(int id, ILogger logger)
    {
        _id = id;
        // 为当前实例创建带前缀的Logger
        _logger = logger.CreateInstanceScoped($"A{_id}");
        // 将带前缀的Logger传给依赖B
        _b = new B(_logger);
    }

    public void A1()
    {
        _logger.LogInformation("Calling B1");
        _b.B1();
    }

    public void A2()
    {
        _logger.LogInformation("Calling B2");
        _b.B2();
    }
}

效果

输出日志会自动带上实例ID前缀，完全符合预期：

info: LoggingTest.Program[0]
      A123: Calling B1
info: LoggingTest.Program[0]
      A123: Executing B1
info: LoggingTest.Program[0]
      A123: Calling B2
info: LoggingTest.Program[0]
      A123: Executing B2
info: LoggingTest.Program[0]
      A234: Calling B1
info: LoggingTest.Program[0]
      A234: Executing B1
info: LoggingTest.Program[0]
      A234: Calling B2
info: LoggingTest.Program[0]
      A234: Executing B2

方案2：修正作用域使用方式 #

如果坚持使用BeginScope，需要确保每个A实例的作用域独立，且在方法调用时明确进入作用域：

修改A类

public class A
{
    private ILogger _logger;
    private int _id;
    private B _b;

    public A(int id, ILogger logger)
    {
        _id = id;
        _logger = logger;
        _b = new B(_logger);
    }

    public void A1()
    {
        // 每次方法调用创建独立作用域
        using var scope = _logger.BeginScope("A{0}: ", _id);
        _logger.LogInformation("Calling B1");
        _b.B1();
    }

    public void A2()
    {
        using var scope = _logger.BeginScope("A{0}: ", _id);
        _logger.LogInformation("Calling B2");
        _b.B2();
    }
}

配置日志格式

修改LoggerFactory的控制台输出格式，将作用域作为前缀：

using var loggerFactory = LoggerFactory.Create(builder =>
{
    builder
        .AddConsole()
        .AddSimpleConsole(options => 
        {
            options.IncludeScopes = true;
            options.Format = "[{Timestamp:HH:mm:ss} {Level}] {Scope} {Message}{NewLine}{Exception}";
        });
});

这种方式的缺点是需要在每个方法中包裹作用域，且作用域是上下文绑定的，若A实例在多线程环境下被调用，需确保作用域正确传递。

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