如何让Web API返回所有布尔类型转换验证错误而非单个？

问题背景 #

你在ASP.NET Web API中遇到以下场景：

• 定义了包含布尔类型字段的请求模型PostJobRequest
• 发送JSON请求时，布尔字段传入了数字值（如1）
• 框架默认仅返回第一个字段的转换错误，而你需要返回所有无效字段的错误列表

解决方案 #

方法一：自定义ModelBinder捕获所有反序列化错误

通过手动处理请求体反序列化，收集所有转换错误并添加到ModelState，让框架返回完整错误信息。

1. 创建自定义ModelBinder类：

public class FullErrorModelBinder : IModelBinder
{
    public async Task BindModelAsync(ModelBindingContext bindingContext)
    {
        if (bindingContext == null)
            throw new ArgumentNullException(nameof(bindingContext));

        // 读取请求体内容
        using var reader = new StreamReader(bindingContext.HttpContext.Request.Body);
        var jsonContent = await reader.ReadToEndAsync();

        var serializerOptions = new JsonSerializerOptions
        {
            ReadCommentHandling = JsonCommentHandling.Skip,
            PropertyNameCaseInsensitive = true
        };

        var errorList = new List<string>();
        // 注册错误回调，收集所有错误并继续反序列化
        serializerOptions.Error += (sender, args) =>
        {
            errorList.Add(args.ErrorContext.Message);
            args.ErrorContext.Handled = true;
        };

        try
        {
            // 尝试反序列化模型
            var model = JsonSerializer.Deserialize(jsonContent, bindingContext.ModelType, serializerOptions);
            if (model != null)
            {
                bindingContext.Result = ModelBindingResult.Success(model);
            }
            else
            {
                bindingContext.ModelState.TryAddModelError(bindingContext.ModelName, "请求体无法反序列化为目标模型");
            }
        }
        catch (Exception ex)
        {
            bindingContext.ModelState.TryAddModelError(bindingContext.ModelName, ex.Message);
        }

        // 将收集到的错误逐个添加到ModelState，匹配对应的字段路径
        var pathRegex = new Regex(@"Path: (.*?) \|");
        foreach (var error in errorList)
        {
            var match = pathRegex.Match(error);
            if (match.Success)
            {
                var fieldPath = match.Groups[1].Value;
                bindingContext.ModelState.TryAddModelError(fieldPath, error);
            }
            else
            {
                bindingContext.ModelState.TryAddModelError(string.Empty, error);
            }
        }
    }
}

2. 注册ModelBinder：

• 仅对目标模型注册：在PostJobRequest类上添加特性：

[ModelBinder(BinderType = typeof(FullErrorModelBinder))]
public class PostJobRequest
{
    public int NumberOfThreads { get; set; }

    public bool ReprocessSuccessful { get; set; } = true;

    public bool ReprocessFailed { get; set; } = true;

    public bool ProcessNew { get; set; } = true;
}

• 全局注册：创建Provider并添加到服务中：

public class FullErrorModelBinderProvider : IModelBinderProvider
{
    public IModelBinder GetBinder(ModelBinderProviderContext context)
    {
        if (context.Metadata.ModelType == typeof(PostJobRequest))
        {
            return new FullErrorModelBinder();
        }
        return null;
    }
}

// 在Program.cs中配置
builder.Services.AddControllers(options =>
{
    options.ModelBinderProviders.Insert(0, new FullErrorModelBinderProvider());
});

方法二：替换为Newtonsoft.Json（Json.NET）

利用Json.NET更灵活的错误处理机制，批量收集所有反序列化错误。

1. 安装NuGet包：

Install-Package Microsoft.AspNetCore.Mvc.NewtonsoftJson

2. 配置Json.NET并注册错误回调：

builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.Error = (sender, args) =>
        {
            // 收集当前字段的错误信息
            var fieldPath = $"$.{args.CurrentContext.Path}";
            var errorMessage = args.Error.Message;
            
            // 将错误添加到ModelState
            var httpContext = args.ErrorContext.Context as HttpContext;
            if (httpContext != null)
            {
                var actionContext = httpContext.Features.Get<IActionContextAccessor>()?.ActionContext;
                actionContext?.ModelState.TryAddModelError(fieldPath, errorMessage);
            }
            
            // 标记错误已处理，继续反序列化后续字段
            args.ErrorContext.Handled = true;
        };
    });

配置完成后，框架返回的400响应会包含所有无效字段的转换错误信息。

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