如何记录 ASP.NET Core 输入 JSON 序列化错误

Question

我们有用作 REST api 的 ASP.NET Core 应用程序。方法使用[FromBody]MyClass param 作为输入。问题是如果客户端发送一个无效的 JSON 字符串，input 值会因为 JSON 序列化错误而变为空。有没有办法记录此类错误？

编辑：我正在寻找应用程序范围的解决方案，而不是每个方法..

Answer 1

我通过在 Startup.cs 中添加错误处理程序解决了这个问题：

services.AddMvc()
        .AddJsonOptions(options => {
              options.SerializerSettings.Error = (object sender, Newtonsoft.Json.Serialization.ErrorEventArgs args) =>
              {
                    //Log args.ErrorContext.Error details...
              };
        });

Answer 2

您可以使用操作过滤器来捕获任何模型绑定错误（包括反序列化错误）。您可以从 ActionExecutingContext 中提取错误。

编辑：要使用这种方法，您需要抑制模型状态无效过滤器，因为默认情况下，如果存在绑定错误，web api 将自动返回 400。 https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.mvc.apibehavioroptions.suppressmodelstateinvalidfilter#microsoft-aspnetcore-mvc-apibehavioroptions-suppressmodelstateinvalidfilter

    public class LogModelBindingErrorFilter : IActionFilter
    {
        private readonly ILogger _logger = LogManager.GetCurrentClassLogger();

        public void OnActionExecuting(ActionExecutingContext context)
        {
            if (!context.ModelState.IsValid)
            {
                var messages = context.ModelState.Values
                    .SelectMany(x => x.Errors)
                    .Where(x => x.Exception is JsonException)
                    .Select(x => x.ErrorMessage);

                _logger.Log(LogLevel.Error, string.Join(", ", messages));
            }
        }

        public void OnActionExecuted(ActionExecutedContext context)
        {
        }
    }