ASP.NET自定义验证器预期工作流及自定义错误返回方案咨询

核心思路 #

既然已经通过IModelValidatorProvider实现了自定义验证器，要全局拦截验证失败并返回自定义响应，无需逐个标记过滤器，**全局注册ActionFilterAttribute**是最直接的方案，也可以利用ASP.NET原生的模型验证结果处理机制实现。

具体实现步骤 #

1. 定义自定义Error对象 #

先明确要返回的错误结构：

public class CustomValidationError
{
    public string Code { get; set; }
    public string Message { get; set; }
    public string Field { get; set; }
}

public class CustomErrorResponse
{
    public List<CustomValidationError> Errors { get; set; } = new List<CustomValidationError>();
}

2. 编写全局验证过滤器 #

创建继承ActionFilterAttribute的过滤器，在OnActionExecuting阶段检查模型状态，验证失败时直接返回自定义响应：

public class GlobalValidationFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            var errorResponse = new CustomErrorResponse();
            
            foreach (var keyValuePair in context.ModelState)
            {
                var field = keyValuePair.Key;
                foreach (var error in keyValuePair.Value.Errors)
                {
                    errorResponse.Errors.Add(new CustomValidationError
                    {
                        Code = "VALIDATION_FAILED",
                        Message = error.ErrorMessage,
                        Field = field
                    });
                }
            }

            // 返回400状态码和自定义错误对象
            context.Result = new BadRequestObjectResult(errorResponse);
        }
    }
}

3. 全局注册过滤器 #

在Program.cs（ASP.NET Core）中全局注册该过滤器，所有接口会自动应用验证逻辑：

builder.Services.AddControllers(options =>
{
    options.Filters.Add<GlobalValidationFilter>();
});

4. 让自定义验证器返回个性化错误信息 #

如果需要自定义错误码或专属提示，可以在IModelValidator的Validate方法中返回带标记的ValidationResult：

public class CustomModelValidator : IModelValidator
{
    public IEnumerable<ValidationResult> Validate(ModelValidationContext context)
    {
        var model = context.Model;
        if (/* 你的验证逻辑 */)
        {
            // 用Tag字段携带自定义错误码
            yield return new ValidationResult(
                "字段格式不符合要求",
                new[] { context.ModelMetadata.PropertyName },
                "FIELD_FORMAT_ERROR_001");
        }
    }
}

之后在全局过滤器中，可以通过ValidationResult的Tag属性提取自定义错误码：

// 在GlobalValidationFilter的循环中调整
foreach (var error in keyValuePair.Value.Errors)
{
    var validationResult = error as ValidationResult;
    var errorCode = validationResult?.Tag?.ToString() ?? "VALIDATION_FAILED";
    errorResponse.Errors.Add(new CustomValidationError
    {
        Code = errorCode,
        Message = error.ErrorMessage,
        Field = field
    });
}

替代方案：自定义模型验证响应格式化器 #

如果更倾向于贴近框架原生流程，可以自定义IProblemDetailsFactory替换默认错误生成逻辑：

public class CustomProblemDetailsFactory : ProblemDetailsFactory
{
    public override ProblemDetails CreateProblemDetails(
        HttpContext httpContext,
        int? statusCode = null,
        string? title = null,
        string? type = null,
        string? detail = null,
        string? instance = null)
    {
        if (httpContext.Items.TryGetValue(MvcProblemDetailsFactory.ModelStateKey, out var modelState) && modelState is ModelStateDictionary modelStateDict)
        {
            var customError = new CustomErrorResponse();
            foreach (var kvp in modelStateDict)
            {
                foreach (var error in kvp.Value.Errors)
                {
                    customError.Errors.Add(new CustomValidationError
                    {
                        Code = "VALIDATION_ERROR",
                        Message = error.ErrorMessage,
                        Field = kvp.Key
                    });
                }
            }

            httpContext.Response.StatusCode = StatusCodes.Status400BadRequest;
            httpContext.Response.ContentType = "application/json";
            var json = JsonSerializer.Serialize(customError);
            httpContext.Response.WriteAsync(json);
            return new ProblemDetails();
        }
        
        return base.CreateProblemDetails(httpContext, statusCode, title, type, detail, instance);
    }
}

注册到DI容器：

builder.Services.AddSingleton<ProblemDetailsFactory, CustomProblemDetailsFactory>();

注意事项 #

• 全局过滤器会拦截所有Action的模型验证失败场景，无需逐个标记特性，完全符合需求。
• 如果需要针对特定控制器/Action做特殊处理，可以在过滤器中通过context.ActionDescriptor判断并添加条件分支。
• 使用IProblemDetailsFactory时需注意响应写入时机，避免与框架默认逻辑冲突。

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