如何重写ApiController内置的Model State处理逻辑以适配自定义错误处理中间件

要让自定义错误处理中间件能覆盖模型绑定错误场景，你需要做两个关键调整，同时理解背后的逻辑：

1. 保留禁用内置模型状态验证过滤器的配置 #

首先确保你已经在AddControllers()中配置了SuppressModelStateInvalidFilter = true，这一步是基础——它会阻止.NET自动返回400响应，让请求能流转到你的自定义中间件：

services.AddControllers()
    .ConfigureApiBehaviorOptions(options =>
    {
        options.SuppressModelStateInvalidFilter = true;
    });

2. 修改中间件，主动检查ModelState有效性 #

模型绑定错误不会抛出异常，只会让ModelState.IsValid变为false，所以你的中间件需要在执行后续管道后，主动检查这个状态并处理。修改后的完整中间件代码如下：

public class ErrorHandlerMiddleware
{
    private readonly RequestDelegate _next;

    public ErrorHandlerMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task Invoke(HttpContext context)
    {
        try
        {
            await _next(context);

            // 主动处理模型绑定/验证错误
            await HandleModelStateErrors(context);
        }
        catch (Exception error)
        {
            var response = context.Response;
            response.ContentType = "application/json";
            var responseModel = new Response<string>() { Succeeded = false, Message = error?.Message };

            switch (error)
            {
                case ConflictException:
                    response.StatusCode = (int)HttpStatusCode.Conflict;
                    break;
                case ApiException:
                    response.StatusCode = (int)HttpStatusCode.BadRequest;
                    break;
                case ValidationException e:
                    response.StatusCode = (int)HttpStatusCode.BadRequest;
                    responseModel.Errors = e.Errors;
                    break;
                case KeyNotFoundException:
                    response.StatusCode = (int)HttpStatusCode.NotFound;
                    break;
                default:
                    response.StatusCode = (int)HttpStatusCode.InternalServerError;
                    break;
            }

            var result = JsonSerializer.Serialize(responseModel);
            await response.WriteAsync(result);
        }
    }

    private async Task HandleModelStateErrors(HttpContext context)
    {
        // 可选：只处理API路由下的请求，避免影响非API页面
        if (!context.Request.Path.StartsWithSegments("/api"))
            return;

        // 如果ModelState有效，或者响应已经开始发送，直接跳过
        if (context.ModelState.IsValid || context.Response.HasStarted)
            return;

        var response = context.Response;
        response.ContentType = "application/json";
        response.StatusCode = (int)HttpStatusCode.BadRequest;

        // 将ModelState错误转换为和你的ResponseModel兼容的格式
        var validationErrors = context.ModelState
            .Where(entry => entry.Value.Errors.Any())
            .ToDictionary(
                entry => entry.Key,
                entry => entry.Value.Errors.Select(e => e.ErrorMessage).ToArray()
            );

        var responseModel = new Response<string>
        {
            Succeeded = false,
            Message = "模型验证失败",
            Errors = validationErrors
        };

        var serializedResult = JsonSerializer.Serialize(responseModel);
        await response.WriteAsync(serializedResult);
    }
}

为什么之前会出现500错误？ #

当你设置SuppressModelStateInvalidFilter = true后，框架不再自动拦截ModelState无效的请求，而是会把请求传递到你的动作方法。如果动作方法依赖了绑定失败的模型（比如参数为null、属性值不符合要求），执行时就会抛出NullReferenceException或其他异常，这时候你的中间件会捕获到这个异常并返回500，而非我们期望的400模型验证错误。通过主动检查ModelState并提前返回错误，就能避免这种情况。

额外优化建议 #

• 你可以根据业务需求调整HandleModelStateErrors中的错误提示文案、错误格式，确保和现有ResponseModel完全匹配。
• context.Response.HasStarted的检查是必要的——如果响应已经开始发送，再修改响应会触发运行时异常。

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