asp.net-mvc-3 - 使用 ViewModel 时不显示 MVC3 自定义验证错误消息

Question

摘要

问题:为什么使用 ViewModel 时不显示自定义验证错误消息。

答案: 自定义验证应该应用于 ViewModel 而不是 Class。有关示例代码，请参阅@JaySilk84 答案的末尾。

MVC3，项目使用

• jquery-1.7.2.min.js
• modernizr-2.5.3.js
• jquery-ui-1.8.22.custom.min.js(由 jQuery.com 为 Accordion 插件生成)
• jquery.validate.min.js 和
• jquery.validate.unobtrusive.min.js

我在我的项目中对 View 中的数据注释和 Controller 中的 ModelState.AddModelError 进行了验证，因此我知道我已正确配置所有验证代码。

但是使用自定义验证时，代码中会生成错误，但不会显示错误消息。

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
{ if (DOB > DateTime.Now.AddYears(-18))
  { yield return new ValidationResult("Must be 18 or over."); }      }

在 POST 操作中深入调试时，自定义验证会导致模型状态失败，并且错误消息被放置在正确的值字段中，但当模型发送回 View 时，错误消息不会显示。在 Controller 中，我还有 ModelState.AddModelError 代码，并且它的消息确实显示。对于一种有效而另一种无效的处理方式有何不同？如果不是这样，还有什么可以阻止显示错误消息？

更新1:

我正在使用 ViewModel 在 View 中创建模型。我删除了 ViewModel，错误消息开始显示，当我将 ViewModel 添加回消息中时，错误消息再次停止显示。有人成功使用 ViewModel 进行自定义验证吗？为了让它发挥作用，您需要做哪些额外的事情吗？

更新2:

我使用这两个简单的类(Agency 和 Person)创建了一个新的 MVC3 项目。

  public class Agency : IValidatableObject
  {

    public int Id { get; set; }

    public string Name { get; set; }

    public DateTime DOB { get; set; }

    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
    {
      if (DOB > DateTime.Now.AddYears(-18)) { yield return new ValidationResult("Must be over 18."); }
    }
  }

  public class Person
  {
    public int Id { get; set; }

    public string Name { get; set; }
  }

这是 Controller 代码

    public ActionResult Create()
    {
        return View();
    } 

    //
    // POST: /Agency/Create

    [HttpPost]
    public ActionResult Create(Agency agency)
    {
      if (ModelState.IsValid)
      {

        db.Agencies.Add(agency);
        db.SaveChanges();
        return RedirectToAction("Index");
      }

      return View(agency);
    }
    
    //[HttpPost]
    //public ActionResult Create(AgencyVM agencyVM)
    //{
    //  if (ModelState.IsValid)
    //  {
    //    var agency = agencyVM.Agency;
    //    db.Agencies.Add(agency);
    //    db.SaveChanges();
    //    return RedirectToAction("Index");
    //  }

    //  return View(agencyVM);
    //}

View

@model CustValTest.Models.Agency
@*@model CustValTest.Models.AgencyVM*@
@* When using VM (model => model.Name)  becomes (model => model.Agency.Name) etc. *@

@{
    ViewBag.Title = "Create";
}

<h2>Create</h2>

<script src="@Url.Content("~/Scripts/jquery.validate.min.js")" type="text/javascript"></script>
<script src="@Url.Content("~/Scripts/jquery.validate.unobtrusive.min.js")" type="text/javascript"></script>

@using (Html.BeginForm()) {
    @Html.ValidationSummary(true)
    <fieldset>
        <legend>Agency</legend>

        <div class="editor-label">
            @Html.LabelFor(model => model.Name)
        </div>
        <div class="editor-field">
            @Html.EditorFor(model => model.Name)
            @Html.ValidationMessageFor(model => model.Name)
        </div>

        <div class="editor-label">
            @Html.LabelFor(model => model.DOB)
        </div>
        <div class="editor-field">
            @Html.EditorFor(model => model.DOB)
            @Html.ValidationMessageFor(model => model.DOB)
        </div>

        <p>
            <input type="submit" value="Create" />
        </p>
    </fieldset>
}

<div>
    @Html.ActionLink("Back to List", "Index")
</div>

View 模型

  public class AgencyVM
  {
    public Agency Agency { get; set; }

    public Person Person { get; set; }

  }

当 View 中仅显示代理时，将显示验证错误(DOB 低于 18)。当 ViewModel 出现时，错误不会显示。但自定义验证始终会捕获错误并导致 ModelState.IsValid 失败并重新呈现 View 。任何人都可以复制这个吗？关于原因和如何解决的任何想法？

更新3:

作为临时解决方案，我通过向 ValidationResult 添加参数将验证更改为字段一级(相对于模型一级):

if (DOB > DateTime.Now.AddYears(-18)) { yield return new ValidationResult("Must be over 18.", new [] { "DOB" }); }

现在的问题是错误消息显示在字段旁边而不是表单顶部(这对于 Accordion View 来说不好，因为用户将返回到表单而没有可见错误信息)。为了解决这个次要问题，我将此代码添加到 Controller POST 操作中。

      ModelState.AddModelError(string.Empty, errMsgInvld);
      return View(agencyVM);
    }
    string errMsgInvld = "There was an entry error, please review the entire form. Invalid entries will be noted in red.";

这个问题仍然没有答案，为什么模型级别的错误消息不显示在 ViewModel 中(有关更多信息，请参阅我对 JaySilk84 的回复)？

Answer 1

现在的问题是您的模型是嵌套的，错误消息被放入 Agency 下的 ModelState 中没有 .DOB，因为您没有在 ValidationResult 中指定它。 ValidationMessageFor()助手正在寻找名为 Agency.DOB 的键(请参阅下面来自 ValidationMessageFor() 助手的相关代码):

string fullHtmlFieldName = htmlHelper.ViewContext.ViewData.TemplateInfo.GetFullHtmlFieldName(expression);
FormContext clientValidation = htmlHelper.ViewContext.GetFormContextForClientValidation();
if (!htmlHelper.ViewData.ModelState.ContainsKey(fullHtmlFieldName) && clientValidation == null)
    return (MvcHtmlString) null;

GetFullHtmlFieldName()返回Agency.DOB，而不是Agency

我想如果你将出生日期添加到 ValidationResult它会起作用:

public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
{
    if (DOB > DateTime.Now.AddYears(-18)) { yield return new ValidationResult("Must be over 18.", new List<string>() { "DOB" }); }
}

第二个参数为 ValidationResult会告诉它在 ModelState 中使用哪个键(默认情况下，它将附加父对象 Agency )，因此 ModelState 将有一个名为 Agency.DOB 的键，这就是您的 ValidationMessageFor() 。正在寻找。

编辑:

<罢工> 如果您不想进行字段级验证，则不需要 Html.ValidationMessageFor() 。您只需要ValidationSummary() 。

View 正在治疗AgencyVM作为模型。如果您希望它正确验证，请将验证放在 AgencyVM 处。级别并让它验证子对象。或者，您可以对子对象进行验证，但父对象 (AgencyVM) 必须将其聚合到 View 。您可以做的另一件事是保持原样并更改 ValidationSummary(true)至ValidationSummary(false) 。这会将 ModelState 中的所有内容打印到摘要中。我认为从 Agency 中删除验证并穿上AgencyVM可能是最好的方法:

 public class AgencyVM : IValidatableObject

    {
        public Agency Agency { get; set; }

        public Person Person { get; set; }

        public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
        {
            if (Agency.DOB > DateTime.Now.AddYears(-18)) { yield return new ValidationResult("Must be over 18."); }
            if (string.IsNullOrEmpty(Agency.Name)) { yield return new ValidationResult("Need a name"); }
        }
    }