ASP.NET Core MVC模型验证自定义错误消息失效问题排查

我来帮你搞定这个自定义必填验证不生效的问题，咱们从最核心的地方开始排查，一步步解决：

这是最容易出问题的地方，自定义验证特性必须满足两个关键点：

• 正确继承ValidationAttribute，并重写IsValid方法
• 如果需要客户端实时验证（不用提交表单就提示），还要实现IClientModelValidator接口

给你一个标准的实现示例，能自动获取DisplayName作为错误消息的一部分：

using System.ComponentModel.DataAnnotations;
using Microsoft.AspNetCore.Mvc.ModelBinding.Validation;

public class GenericRequiredAttribute : ValidationAttribute, IClientModelValidator
{
    public override bool IsValid(object value)
    {
        // 处理值为空的情况：null、空字符串、空白字符串都算未填写
        if (value == null) return false;
        if (value is string str && string.IsNullOrWhiteSpace(str)) return false;
        // 如果是其他值类型（比如int），默认值是否视为未填写可根据需求调整
        return true;
    }

    // 重写FormatErrorMessage，把DisplayName替换到消息里
    public override string FormatErrorMessage(string name)
    {
        // name参数就是属性的DisplayName（没设置的话就是属性名）
        return $"请填写{name}";
    }

    // 实现客户端验证方法，让前端也能触发验证
    public void AddValidation(ClientModelValidationContext context)
    {
        if (context == null) throw new ArgumentNullException(nameof(context));
        
        // 添加客户端验证规则，对应jquery.validate的required规则
        MergeAttribute(context.Attributes, "data-val", "true");
        MergeAttribute(context.Attributes, "data-val-required", FormatErrorMessage(context.ModelMetadata.DisplayName ?? context.ModelMetadata.PropertyName));
    }

    private void MergeAttribute(IDictionary<string, string> attributes, string key, string value)
    {
        if (!attributes.ContainsKey(key))
        {
            attributes.Add(key, value);
        }
    }
}

确保你同时正确应用了[DisplayName]和[GenericRequired]，顺序不影响，但别写错特性名：

public class UserModel
{
    [DisplayName("用户名")]
    [GenericRequired]
    public string Username { get; set; }

    [DisplayName("邮箱地址")]
    [GenericRequired]
    public string Email { get; set; }
}

服务器端验证 #

在你的Post方法里，必须检查ModelState.IsValid，否则验证消息不会被返回：

[HttpPost]
public IActionResult Submit(UserModel model)
{
    if (!ModelState.IsValid)
    {
        // 验证失败，返回原视图，这样验证消息才会显示
        return View(model);
    }
    // 验证通过，继续业务逻辑
    return RedirectToAction("Success");
}

客户端验证 #

如果希望前端实时提示，要确保视图里引用了必要的脚本（ASP.NET Core MVC模板默认会包含，但自定义视图可能漏加）：

<!-- 在表单之前或者页面底部引用 -->
<script src="~/lib/jquery/dist/jquery.min.js"></script>
<script src="~/lib/jquery-validation/dist/jquery.validate.min.js"></script>
<script src="~/lib/jquery-validation-unobtrusive/jquery.validate.unobtrusive.min.js"></script>

• 确保asp-validation-for绑定的是模型的正确属性，并且在<form>标签内部
• 可以配合ValidationSummary显示所有错误，或者单独显示每个字段的错误

示例视图代码：

@model UserModel

<form asp-action="Submit" method="post">
    <!-- 显示所有验证错误的汇总（可选） -->
    <div asp-validation-summary="All" class="text-danger"></div>

    <div class="form-group">
        <label asp-for="Username"></label>
        <input asp-for="Username" class="form-control" />
        <!-- 这里会显示该字段的自定义错误消息 -->
        <span asp-validation-for="Username" class="text-danger"></span>
    </div>

    <div class="form-group">
        <label asp-for="Email"></label>
        <input asp-for="Email" class="form-control" />
        <span asp-validation-for="Email" class="text-danger"></span>
    </div>

    <button type="submit" class="btn btn-primary">提交</button>
</form>

• 自定义特性里没重写FormatErrorMessage：默认会用通用消息，不会替换字段名
• 没实现IClientModelValidator：前端不会实时提示，只有提交表单后服务器端才会返回错误
• Post方法里没检查ModelState.IsValid：直接跳过验证，自然看不到错误消息
• 视图里漏了验证脚本：客户端验证不生效，只能等服务器端返回
• DisplayName特性写错：导致错误消息里的字段名不对

按照上面的步骤排查，基本就能解决验证不生效、消息不显示的问题啦！

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