使用ViewModel时不显示MVC3自定义验证错误消息

Question

摘要

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

Answer:自定义验证应应用于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操作中深入调试时，自定义验证会导致模型状态失败，并且错误消息会放置在正确的值字段中，但是当将模型发送回视图时，不会显示错误消息。在控制器中，我还具有ModelState.AddModelError代码，并且确实显示了其消息。如何以一种方式而不是另一种方式来处理？如果不是这样，还有什么会阻止错误消息显示的？

更新1：

我正在使用ViewModel在视图中创建模型。我剥离了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; }
  }

这是控制器代码

    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);
    //}

风景

@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>

ViewModel

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

    public Person Person { get; set; }

  }

如果在视图中仅显示代理商，则会显示验证错误（DOB低于18）。显示ViewModel时，不会显示错误。自定义验证始终会捕获错误，并导致ModelState.IsValid失败并重新呈现视图。有人可以复制吗？关于为什么以及如何解决的任何想法？

更新3：

作为一项临时工作，我通过向ValidationResult添加参数，将Validation更改为一个字段级别（相对于模型级别1）：

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

现在的问题是错误消息显示在字段旁边而不是表单的顶部（这在手风琴视图中不好，因为用户将返回到没有可见错误消息的表单）。为了解决此次要问题，我将此代码添加到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没有 .DOB 的 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

我认为如果你将 DOB 添加到它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().

视图被视为AgencyVM模型。如果您希望它正确验证，请将验证置于该AgencyVM级别并让它验证子对象。或者，您可以对子对象进行验证，但父对象 (AgencyVM) 必须将其聚合到视图。您可以做的另一件事是保持原样并更改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"); }
        }
    }