如何在NLog中为特定请求掩码敏感数据并获取Action属性类型

1. 方案可行性判断 #

你的方案整体是可行的，但落地时要注意几个关键细节：

• 性能开销：反序列化→掩码→重新序列化的流程会增加日志记录的耗时，高并发场景下必须做性能测试，建议提前缓存模型的敏感字段元数据，避免每次都反射解析。
• 异常兜底：请求体可能存在JSON格式错误，反序列化失败时要做降级处理（比如保留原始内容并标记掩码失败），不能因为日志逻辑异常影响主业务流程。
• 标记完整性：必须确保所有含敏感数据的Action都正确标记[RequestMethodFormatter]，遗漏会直接导致敏感数据泄露。
• 嵌套字段掩码：你的MaskHelper要支持深层嵌套模型（比如示例中的BankCardDetails），确保嵌套的敏感字段也能被正确处理。

2. 在自定义LayoutRenderer中获取Action的属性类型 #

要拿到Action上标记的RequestMethodFormatter属性，核心是从当前请求的HttpContext中获取对应的ActionDescriptor，具体实现如下：

步骤1：完善自定义属性定义 #

先确保你的属性类定义正确：

[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
public class RequestMethodFormatterAttribute : Attribute
{
    public Type RequestModelType { get; }

    public RequestMethodFormatterAttribute(Type requestModelType)
    {
        RequestModelType = requestModelType;
    }
}

步骤2：在LayoutRenderer中获取上下文与属性 #

利用ASP.NET的HttpContextAccessor获取当前请求上下文，再从中提取ActionDescriptor并查找自定义属性：

[LayoutRenderer("http-request")]
public class NLogHttpRequestLayoutRenderer : AspNetRequestPostedBody
{
    protected override void DoAppend(StringBuilder builder, LogEventInfo logEvent)
    {
        base.DoAppend(builder, logEvent);
        var rawBody = builder.ToString();
        Type targetModelType = null;

        // 获取当前请求上下文
        var httpContext = HttpContextAccessor?.HttpContext;
        if (httpContext is not null)
        {
            // 从请求特征中获取Action描述符
            var actionDescriptor = httpContext.Features.Get<Microsoft.AspNetCore.Mvc.Abstractions.ActionDescriptor>();
            if (actionDescriptor is not null)
            {
                // 查找Action上的自定义属性
                var formatterAttr = actionDescriptor.EndpointMetadata
                    .OfType<RequestMethodFormatterAttribute>()
                    .FirstOrDefault();
                targetModelType = formatterAttr?.RequestModelType;
            }
        }

        // 仅当获取到目标模型且请求体非空时执行掩码
        if (targetModelType is not null && !string.IsNullOrEmpty(rawBody))
        {
            try
            {
                var maskedBody = MaskHelper.GetMaskedJsonString(rawBody, targetModelType);
                // 替换原始内容为掩码后的结果
                builder.Clear();
                builder.Append(maskedBody);
            }
            catch (Exception ex)
            {
                // 反序列化失败时的降级处理，保留原始内容并标记错误
                builder.Append($" [掩码失败：{ex.Message}]");
            }
        }
    }

    // 注入HttpContextAccessor，需在依赖注入容器中注册
    public IHttpContextAccessor HttpContextAccessor { get; set; }
}

步骤3：注册依赖与自定义渲染器 #

在ASP.NET的启动配置中注册IHttpContextAccessor，并将自定义布局渲染器注册到NLog：

// Program.cs
builder.Services.AddHttpContextAccessor();

// 注册NLog自定义布局渲染器
NLog.Config.ConfigurationItemFactory.Default.LayoutRenderers.RegisterDefinition("http-request", typeof(NLogHttpRequestLayoutRenderer));

步骤4：更新NLog配置 #

将原日志配置中的${aspnet-request-posted-body}替换为自定义的${http-request}：

<attribute name="user-requestBody" layout="${http-request}"/>

额外优化建议 #

• 基于模型字段标记敏感数据：可以在模型的敏感字段上标记自定义属性（比如[SensitiveData]），让MaskHelper自动识别并掩码，这样无需在Action上指定模型类型，扩展性更强。
• 异步日志处理：如果掩码逻辑耗时较长，建议使用NLog的异步目标（AsyncTargetWrapper），避免阻塞请求线程。

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