如何通过NLog将类成员变量作为日志消息前缀？

嘿，这个需求NLog其实有好几种灵活的实现方式，我给你拆解几个实用的方案，你可以根据自己的场景选：

方案一：用MappedDiagnosticsLogicalContext（MDLC）快速绑定类属性（轻量易上手） #

这是最直接的方式，把类的属性值放入NLog的逻辑上下文，然后在日志布局里直接引用它。

首先在你的类中，把属性值注入MDLC：

public class OrderService
{
    private readonly ILogger _logger;
    // 你的自定义标识属性
    public string ClassTag { get; } = "OrderService_v1";

    public OrderService(ILogger<OrderService> logger)
    {
        _logger = logger;
        // 将属性值存入MDLC，整个逻辑上下文都能访问到
        MappedDiagnosticsLogicalContext.Set("ClassTag", ClassTag);
    }

    public void ProcessOrder(int orderId)
    {
        _logger.LogInformation("Processing order {OrderId}", orderId);
    }
}

然后修改NLog的配置文件（比如nlog.config），调整日志布局，把${mdlc:item=ClassTag}放在消息最前面：

<targets>
    <target name="logfile" xsi:type="File" 
            fileName="logs/app.log"
            layout="${longdate} [${mdlc:item=ClassTag}] ${level:uppercase=true} ${message}" />
</targets>

这样输出的日志就会自动带上类的属性内容：

2024-05-20 15:10:00.789 [OrderService_v1] INFO Processing order 123

方案二：自定义布局渲染器（统一管理更优雅） #

如果不想每个类都手动写MDLC的代码，可以自定义一个布局渲染器，自动读取类的指定属性值，适合大规模项目统一规范。

步骤1：创建自定义布局渲染器 #

[LayoutRenderer("class-property")]
public class ClassPropertyRenderer : LayoutRenderer
{
    // 可配置的属性名称，默认取"ClassTag"
    public string PropertyName { get; set; } = "ClassTag";

    protected override void Append(StringBuilder builder, LogEventInfo logEvent)
    {
        // 从日志事件中获取类的类型
        var loggerType = Type.GetType(logEvent.LoggerName);
        if (loggerType == null)
        {
            builder.Append("UnknownClass");
            return;
        }

        // 获取指定的公共实例属性
        var property = loggerType.GetProperty(PropertyName, BindingFlags.Public | BindingFlags.Instance);
        if (property == null)
        {
            builder.Append("MissingProperty");
            return;
        }

        // 这里我们通过日志事件的Properties获取属性值（需要类里提前绑定）
        if (logEvent.Properties.TryGetValue(PropertyName, out var propValue))
        {
            builder.Append(propValue.ToString());
            return;
        }

        builder.Append("Unset");
    }
}

步骤2：注册渲染器（程序启动时） #

// 在Program.cs或者Startup类中注册
NLog.LogManager.Setup().SetupExtensions(ext =>
    ext.RegisterLayoutRenderer<ClassPropertyRenderer>("class-property"));

步骤3：在类中绑定属性到日志器 #

public class PaymentService
{
    private readonly ILogger _logger;
    public string ClassTag { get; } = "PaymentService_v2";

    public PaymentService(ILogger<PaymentService> logger)
    {
        // 用WithProperty把属性值附加到日志器上
        _logger = logger.WithProperty("ClassTag", ClassTag);
    }

    public void ProcessPayment(decimal amount)
    {
        _logger.LogInformation("Processing payment of {Amount:C}", amount);
    }
}

步骤4：修改NLog配置 #

<layout="${longdate} [${class-property:PropertyName=ClassTag}] ${level:uppercase=true} ${message}" />

最终日志输出效果：

2024-05-20 15:15:00.123 [PaymentService_v2] INFO Processing payment of $99.99

方案三：使用作用域Scope（适合临时生效场景） #

如果你的属性值只需要在特定方法范围内生效，或者方法执行中可能变化，可以用NLog的Scope功能：

public class InventoryService
{
    private readonly ILogger _logger;
    public string ServiceTag { get; } = "InventoryService_v3";

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

    public void UpdateStock(int productId, int quantity)
    {
        // 创建作用域，绑定属性值，作用域内的日志都会带上这个标签
        using (_logger.BeginScope(new Dictionary<string, object> { ["ClassTag"] = ServiceTag }))
        {
            _logger.LogInformation("Updating stock for product {ProductId} to {Quantity}", productId, quantity);
        }
    }
}

NLog配置里用${scopedProperties:item=ClassTag}引用：

<layout="${longdate} [${scopedProperties:item=ClassTag}] ${level:uppercase=true} ${message}" />

一些注意事项 #

• 如果是ASP.NET Core应用，MDLC和Scope都会自动跟随异步上下文，异步方法里也能正常工作。
• 自定义渲染器的方式适合团队统一规范，避免重复代码。
• 如果属性是静态的，可以简化自定义渲染器，直接通过Type获取静态属性值。

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