ASP.NET Core 中的模型验证错误如何自定义?

来源:这里教程网 时间:2026-02-21 17:26:58 作者:

在 ASP.NET Core 中,当模型验证失败时,默认会返回 400 状态码和包含错误信息的响应。你可以通过多种方式自定义这些验证错误,让返回的内容更符合项目需求,比如统一格式、添加额外字段或改变错误消息结构。

1. 使用 ModelState 自定义错误响应

控制器中可以通过检查 ModelState.IsValid 来拦截验证错误,并构造自定义响应。

示例:

[HttpPost]
public IActionResult CreateUser(UserModel user)
{
    if (!ModelState.IsValid)
    {
        var errors = ModelState
            .Where(kv => kv.Value.Errors.Any())
            .Select(kv => new
            {
                Field = kv.Key,
                Message = kv.Value.Errors.First().ErrorMessage
            });
        return BadRequest(new
        {
            Success = false,
            Message = "验证失败",
            Errors = errors
        });
    }
    // 处理逻辑
    return Ok(new { Success = true, Message = "创建成功" });
}

2. 全局处理验证错误(使用中间件或过滤器)

为了避免每个控制器重复写验证逻辑,可以使用 ActionFilterProblemDetails 扩展来统一处理。

创建一个自定义过滤器:

public class ValidationFilter : IActionFilter
{
    public void OnActionExecuting(ActionExecutingContext context)
    {
        if (!context.ModelState.IsValid)
        {
            var errors = context.ModelState
                .Where(e => e.Value.Errors.Count > 0)
                .ToDictionary(
                    kvp => kvp.Key,
                    kvp => kvp.Value.Errors.Select(e => e.ErrorMessage).ToArray()
                );
            context.Result = new BadRequestObjectResult(new
            {
                Success = false,
                Message = "请求数据无效",
                Errors = errors
            });
        }
    }
    public void OnActionExecuted(ActionExecutedContext context) { }
}

Program.cs 中注册过滤器:

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

3. 自定义验证属性

你还可以继承 ValidationAttribute 创建自己的验证规则,并控制错误消息。

示例:确保用户名不包含特殊字符

public class NoSpecialCharsAttribute : ValidationAttribute
{
    protected override ValidationResult IsValid(object value, ValidationContext validationContext)
    {
        if (value is string str)
        {
            if (System.Text.RegularExpressions.Regex.IsMatch(str, @"[^a-zA-Z0-9]"))
            {
                return new ValidationResult("用户名不能包含特殊字符");
            }
        }
        return ValidationResult.Success;
    }
}
// 在模型中使用
public class UserModel
{
    [Required(ErrorMessage = "用户名是必填项")]
    [NoSpecialChars]
    public string Username { get; set; }
    [Range(18, 100, ErrorMessage = "年龄必须在 18 到 100 之间")]
    public int Age { get; set; }
}

4. 覆盖默认的验证行为(可选)

如果你希望完全接管模型绑定和验证流程,可以禁用默认行为并手动处理:

// 在 Program.cs 中
builder.Services.Configure<ApiBehaviorOptions>(options =>
{
    options.InvalidModelStateResponseFactory = context =>
    {
        var errors = context.ModelState
            .Where(e => e.Value.Errors.Any())
            .Select(e => new
            {
                Field = e.Key,
                Message = e.Value.Errors.First().ErrorMessage
            });
        return new BadRequestObjectResult(new
        {
            Success = false,
            Timestamp = DateTime.UtcNow,
            Errors = errors
        });
    };
});

这个方法能全局替换所有 400 响应的输出格式,无需额外代码。

基本上就这些。根据项目规模选择合适的方式:小项目可以直接在控制器处理,中大型项目推荐使用全局过滤器或重写 InvalidModelStateResponseFactory。自定义验证属性则用于业务规则级别的校验。这样既能保持一致性,又能灵活控制错误输出。

相关推荐