.NET Core：当ApiController快捷方式管道时，根据错误请求访问请求数据

Question

对于所有遇到的所有绊脚石问题，我在Github上创建了一个小型公共游乐场。 随时加入。

---

我仍在尝试针对我的请求的所有日志过滤器。

目标很简单。 无需在每个控制器方法中写入日志，只需在过滤器（或中间件）中实施一次日志，然后将其全局应用于所有日志即可。 当出现问题时可以使用它，我可以看到使用了哪些数据导致了问题。

例如控制器动作（使用全局应用的过滤器）

[HttpPut("{id:int}")
public IActionResult UpdateModel(int id, [FromBody] MyRequestModel request) {}

将创建类似的日志

[Timestamp] INFO: MyNamespace.Controllers.MyModelController.UpdateModel
{ 
  "Parameters": {
     "Id": 1,
     "Request": {
       "Name": "abc",
       "SomeInt": 3
     }
  }
}

不错，每种方法都无需手动记录日志。

但是，等等：这是一个API，我使用了[ApiController]属性，请求模型包含无效数据（假设Name =“ a”，但长度至少应为3）。

这给我3个问题

1. ActionFilter.OnActionExecuting是快捷方式，不会被调用（由于ApiController）
2. 参数的绑定似乎已跳过，并且绑定（无效）数据未应用于ActionArguments
3. 仅调用ResultFilter.OnResultExecuted，但似乎无法访问/记录无效数据

这某种程度上意味着日志记录只有在一切正常的情况下才起作用，但是最有趣的日志不是那些出错了吗？

public void OnActionExecuting(ActionExecutingContext context)
  {
    _loggerFactory
    .CreateLogger(context.ActionDescriptor.DisplayName.Split(" ")[0])
    .LogInformation
    (
      JsonConvert.SerializeObject
      (
        new { Parameters = context.ActionArguments },
        Formatting.Indented
      )
    );
  }

要点1：我当然可以从每个控制器中删除ApiController并返回以手动返回BadRequest结果。 但是我喜欢集中化方法，并且愿意坚持下去。

我喜欢模型绑定方法，该方法使我可以为日志序列化类（而不是手动将请求主体作为一个字符串读取）。 使用自定义的Json合同解析器，我可以将模型属性标记为敏感属性，并且将它们隐藏在日志中（对于那些关心安全性的人）。

所以我的实际问题是：

有没有一种方法可以在ResultFilter中获取模型绑定值，或者将它们完全丢弃？ 还是有一种方法可以挂接到模型绑定/模型验证并在日志被丢弃之前在其中写入日志？ 两者都特别适用于ApiController属性开始缩短筛选器管道的情况。

---

public class LogFilter : IActionFilter, IResultFilter, IExceptionFilter
{

    private readonly ILoggerFactory _loggerFactory;

    public LogFilter(ILoggerFactory loggerFactory)
    {
      _loggerFactory = loggerFactory ?? throw new ArgumentNullException(nameof(loggerFactory));
    }

    public void OnActionExecuting(ActionExecutingContext context)
    {
      _loggerFactory
         .CreateLogger(context.ActionDescriptor.DisplayName.Split(" ")[0])
         .LogInformation
         (
           JsonConvert.SerializeObject
           (
             new
             {
               RequestBody = ReadBodyAsString(context.HttpContext.Request),
               Parameter = context.ActionArguments
             },
             Formatting.Indented
           )
         );
    }

    public void OnActionExecuted(ActionExecutedContext context) {}      

    public void OnResultExecuting(ResultExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
          _loggerFactory
            .CreateLogger(context.ActionDescriptor.DisplayName.Split(" ")[0])
            .LogWarning
            (
               JsonConvert.SerializeObject
               (
                 new
                 {
                   RequestBody = ReadBodyAsString(context.HttpContext.Request),
                   ModelErrors = context.ModelState
                    .Where(kvp => kvp.Value.Errors.Count > 0)
                    .ToDictionary
                    (
                      kvp => kvp.Key,
                      kvp => kvp.Value.Errors.Select(e => e.ErrorMessage).ToArray()
                    )
                 },
                 Formatting.Indented
               )
            );
        }
    }

    public void OnResultExecuted(ResultExecutedContext context) {}

    public void OnException(ExceptionContext context)
    {

        _loggerFactory
        .CreateLogger(context.ActionDescriptor.DisplayName.Split(" ")[0])
        .LogError
        (
          context.Exception,
          JsonConvert.SerializeObject
          (
            new
            {
              //RequestBody = ReadBodyAsString(context.HttpContext.Request) // body is disposed here
            },
            Formatting.Indented
          )
        );

    }
}

Answer 1

您可以创建一个实现IActionFilter的OnActionExecuting方法的类。 并将其注册在全局过滤器中，以便将其应用于所有控制器和操作。 当模型绑定发生异常（长度的原因）时，即使使用[ApiController]，您的OnActionExecuting方法仍然会被调用，您可以将其记录在那里。

例如。

public class MyActionFilterAttribute: IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        //Your logic to log the request, you can get the details from
        //context parameter

        //You can check if model state is valid also by using the property
        //context.ModelState.IsValid
    }
}

在Startup.cs中，您需要将SuppressModelStateInvalidFilter设置为true。 这不会自动返回400状态。 您的控制器方法仍然会被调用，并且由于您具有动作过滤器，因此会调用OnActionExecuting。

public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc(
            config =>
            {
                config.Filters.Add(new MyActionFilterAttribute());
            })
            .ConfigureApiBehaviorOptions(options =>
            {
                options.SuppressModelStateInvalidFilter = true;
            });
    }

Answer 2

我认为您对ActionFilter只捕获成功的请求是正确的。 对于您的无效请求，也许您可​​以看看InvalidModelStateResponseFactory 。

使用options.InvalidModelStateResponseFactory时，您可以读取模型和验证错误。