Model验证系统运行机制是如何实现的？

在前面三篇文章（《ModelValidator》、《ModelValidatorProvider》和《ModelValidatorProviders》）中我们详细介绍了真正用于Model验证的ModelValidator以及相关的提供机制，接下来我们来讨论一下在这个以ModelValidator为核心的Model验证系统中，通过Model绑定得到的数据对象的验证是如何实现的。[[本文已经同步到《How ASP.NET MVC Works?》中]

目录 
一、从ModelState谈起 
二、实例演示：验证Model绑定过程中对ModelError的设置 
三、验证消息的呈现 
    HtmlHelper.ValidationMessage & HtmlHelper<TModel>.ValidationMessageFor 
    HtmlHelper.ValidationSummary 
    错误消息在EditForModel方法中的呈现 
四、 Model绑定与Model验证

一、从ModelState谈起

我们知道Controller对象的ViewData包含有个元素类型为ModelState的集合，用于表示Model的状态。除了在Model绑定过程通过ValueProvider体工的数据保存在该集合中之外，提供数据的验证结果也保存其中。

[Serializable]
public class ModelState
{
    public ModelErrorCollection Errors { get; }
    public ValueProviderResult Value { get; set;}
}

[Serializable]
public class ModelErrorCollection : Collection<ModelError>
{
    public ModelErrorCollection();
    public void Add(Exception exception);
    public void Add(string errorMessage);
}

[Serializable]
public class ModelError
{
    public ModelError(Exception exception);
    public ModelError(string errorMessage);
    public ModelError(Exception exception, string errorMessage);

    public string ErrorMessage { get; }
    public Exception Exception { get; }
}

通过上面的代码片断所示，ModelState具有Value和Errors两个核心属性，前者表示ValueProvider提供的ValueProviderResult对象，后者表示针对该数据对象的错误集合，其类型为ModelErrorCollection。ModelErrorCollection是一个元素类型为ModelError的集合，而一个ModelError对象通过错误消息和异常来描述错误。

二、实例演示：验证Model绑定过程中对ModelError的设置

Model验证可以看成是Model绑定过程的一部分，它在生成目标Action方法参数值的过程中会对提供的数据实施验证，而在验证失败的情况下验证结果会以ModelError的形式写入当前Controller的ViewData的ModelState中，现在我们通过一个简单的实例来证实这一点。我们还是将多次使用的Contact作为Model类型，如下面的代码片断所示，类型Contact和Address以及它们的所有属性应用了上面定义的验证特性AlwaysFailsAttribute（《ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProviders》），并设置了相应的错误信息。

[AlwaysFails(ErrorMessage = "Contact")]
public class Contact
{
    [AlwaysFails(ErrorMessage = "Contact.Name")]
    public string Name { get; set; }

    [AlwaysFails(ErrorMessage = "Contact.PhoneNo")]
    public string PhoneNo { get; set; }

    [AlwaysFails(ErrorMessage = "Contact.EmailAddress")]
    public string EmailAddress { get; set; }

    [AlwaysFails(ErrorMessage = "Contact.Address")]
    public Address Address { get; set; }
}

[AlwaysFails(ErrorMessage = "Address")]
public class Address
{
    [AlwaysFails(ErrorMessage = "Address.Province")]
    public string Province { get; set; }

    [AlwaysFails(ErrorMessage = "Address.City")]
    public string City { get; set; }

    [AlwaysFails(ErrorMessage = "Address.District")]
    public string District { get; set; }

    [AlwaysFails(ErrorMessage = "Address.Street")]
    public string Street { get; set; }
}

在通过Visual Studio的ASP.NET MVC项目模板创建的空Web应用中，我们定义了如下一个默认的HomeController。在基于HTTP-GET的Action方法Index中我们创建一个Contact对象并使用默认的View将其呈现出来。应用了HttpPostAttribute特性的Index方法具有一个类型为Contact的参数，在此方法中我们将包含在当前ViewData的所有ModelState的值和错误信息呈现出来。

public class HomeController : Controller
{
    public ActionResult Index()
    {
        Address address = new Address
        {
            Province     = "江苏",
            City         = "苏州",
            District     = "工业园区",
            Street       = "星湖街328号"
        };
        Contact contact = new Contact
        {
            Name         = "张三",
            PhoneNo      = "123456789",
            EmailAddress = "zhangsan@gmail.com",
            Address      = address
        };

        return View(contact);
    }

    [HttpPost]
    public void Index(Contact contact)
    {
        foreach (string key in ViewData.ModelState.Keys)
        {
            Response.Write(key + "<br/>");
            ModelState modelState = ViewData.ModelState[key];
            Response.Write(string.Format("&nbsp;&nbsp;&nbsp;&nbsp;Value: {0}<br/>", modelState.Value.ConvertTo(typeof(string))));
            foreach (ModelError error in modelState.Errors)
            {
                Response.Write(string.Format("&nbsp;&nbsp;&nbsp;&nbsp;Error: {0}<br/>", error.ErrorMessage));
            }
        }
    }
}

在如下所示的Action方法Index对应的View的定义，这是一个基于Contact的强类型View。在该View中我们将作为Model的整个Contact对象以编辑模式呈现在一个表单之中。由于Contact的Address属性是一个复杂类型，所以不会出现在调用EditorForModel方法呈现的HTML中，所有还需要调用EditorFor将该属性显示呈现出来。

@model Contact
@using(Html.BeginForm())
{
    @Html.EditorForModel()
    @Html.EditorFor(m=>m.Address)
    <input type="submit" value="保存" />
}

运行该程序后会现在浏览器中呈现一个编辑联系人信息的表单，直接点击“保存”按钮后会在呈现出如下的输出结果。我们知道输出的ModelState的值是在Model绑定过程中通过ValueProvider提供的，而伴随着Model绑定的验证则会根据验证的结果对ModelState的ModelError进行设置。

Name
    Value: 张三
    Error: Contact.Name
PhoneNo
    Value: 123456789
    Error: Contact.PhoneNo
EmailAddress
    Value: zhangsan@gmail.com
    Error: Contact.EmailAddress
Address.Province
    Value: 江苏
    Error: Address.Province
Address.City
    Value: 苏州
    Error: Address.City
Address.District
    Value: 工业园区
    Error: Address.District
Address.Street
    Value: 星湖街328号
    Error: Address.Street

这个演示程序还说明了另一个问题。通过前面的介绍我们知道默认用于进行Model验证的是CompositeModelValidator，而根据我们之前的实例演示的结果，基于CompositeModelValidator的Model验证并不具有递归性（《ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProviders》），也就是针对Contact对象的验证并不会递归地对Address对象的属性实施验证。但是从上面的输出结果可以清楚地看到，递归验证的现象去发生了，我们将后面的内容讨论这个问题。

三、验证消息的呈现

Model的验证过程伴随着Model绑定，当ModelBinder从请求中提取相应的数据为目标Action方法绑定参数值后，验证错误信息已经以ModelError的形式保存到相应的ModelState中。而ModelState列表属于ViewData的一部分，所以可以直接在View中被使用，这对错误信息在View中的呈现提供了可能。现在我们就来讨论验证信息在View中的呈现问题。

HtmlHelper.ValidationMessage & HtmlHelper<TModel>.ValidationMessageFor

验证消息在View中的呈现通过HtmlHelper/HtmlHelper<TModel>来实现。如下面的代码片断所示，静态ValidationExtensions类中为HtmlHelper定义了4个名为ValidationMessage的扩展方法，为HtmlHelper<TModel>定义了一个名为ValidationMessage的扩展方法。

public static class ValidationExtensions
{
    //其他成员
    public static MvcHtmlString ValidationMessage(this HtmlHelper htmlHelper, string modelName);
    public static MvcHtmlString ValidationMessage(this HtmlHelper htmlHelper, string modelName, IDictionary<string, object> htmlAttributes);
    public static MvcHtmlString ValidationMessage(this HtmlHelper htmlHelper, string modelName, object htmlAttributes);
    public static MvcHtmlString ValidationMessage(this HtmlHelper htmlHelper, string modelName, string validationMessage);

    public static MvcHtmlString ValidationMessageFor<TModel, TProperty>(this HtmlHelper<TModel> htmlHelper, Expression<Func<TModel, TProperty>>
        expression, string validationMessage, object htmlAttributes);
}

ViewData的ModelState属性的类型不是ModelState，而是一个具有字典结构的ModelStateDictionary类型。ValidationMessage方法中表示所谓Model名称的参数modelName实际山个对应着存在于这个ModelStateDictionary字典中某个ModelState对象的Key。如果没有通过参数validationMessage显式指定了验证消息，那么就会通过modelName找到相应的ModelState对象，从其Errors属性表示的ModelErrorCollection对象中提取相应的错误消息。

由于ModelState可以包含多个ModelError对象，第一个具有非空消息的ModelError会被选择，而对应的消息将会作为验证消息呈现出来。如果这样的ModelError不存在，不会有任何HTML会被呈现。而ValidationMessageFor与ValidationMessage不同之处在于它会通过指定的表达式来提取ValidationMessage方法中的参数modelName。

现在我们对上面演示的实例略加改动来演示验证消息的呈现。如下面的代码片断所示，在应用了HttpPostAttribute特性的Index方法中，我们将作为参数的contact对象在一个名为“ValidationMessage”的View中呈现。

public class HomeController : Controller
{
    //其他成员
    [HttpPost]
    public ActionResult Index(Contact contact)
    {
        return View("ValidationMessage", contact);
    }
}

如下所示的是这个名为ValidationMessage的View的定义，这是一个基于Contact类型的强类型View。在该View中我们调用HtmlHelper<TModel>的ValidationMessage方法所有的验证消息呈现出来。

@model MvcApp.Models.Contact
<ul>
    <li>@Html.ValidationMessage("Name")</li>
    <li>@Html.ValidationMessage("PhoneNo")</li>
    <li>@Html.ValidationMessage("EmailAddress")</li>
    <li>@Html.ValidationMessage("Address.Province")</li>
    <li>@Html.ValidationMessage("Address.City")</li>
    <li>@Html.ValidationMessage("Address.District")</li>
    <li>@Html.ValidationMessage("Address.Street")</li>
</ul>

运行该程序后，在联系人编辑页面中直接点击“保存”按钮，这个名为ValidationMessage的View会以如下图所示的效果呈现出来。

在ValidationMessage中针对验证消息的呈现也可以按照如下的方式调用HtmlHelper<TModel〉的扩展方法ValidationMessageFor来实现。

@model MvcApp.Models.Contact
<ul>
   <li>@Html.ValidationMessageFor(c=>c.Name)</li>
   <li>@Html.ValidationMessageFor(c=>c.PhoneNo)</li>
   <li>@Html.ValidationMessageFor(c=>c.EmailAddress)</li>
   <li>@Html.ValidationMessageFor(c=>c.Address.Province)</li>
   <li>@Html.ValidationMessageFor(c=>c.Address.City)</li>
   <li>@Html.ValidationMessageFor(c=>c.Address.District)</li>
   <li>@Html.ValidationMessageFor(c=>c.Address.Street)</li>
</ul>

通过这两个呈现出来的验证消息具有相同的显示效果 ，其对应的HTML如下面的代码所示。可以看出呈现出来的验证显示体现为一个<span>元素，其样式（class="field-validation-error"）和客户端验证属性（data-valmsg-for="PhoneNo" data-valmsg-replace="true"）作了相应设置。

<ul>
  <li>
    <span class="field-validation-error" data-valmsg-for="Name" data-valmsg-replace="true">Contact.Name</span></li>
  <li>
      <span class="field-validation-error" data-valmsg-for="PhoneNo" data-valmsg-replace="true">Contact.PhoneNo</span>
  </li>
  <li>
     <span class="field-validation-error" data-valmsg-for="EmailAddress" data-valmsg-replace="true">Contact.EmailAddress</span>
  </li>
  <li>
    <span class="field-validation-error" data-valmsg-for="Address.Province" data-valmsg-replace="true">Address.Province</span>
  </li>
  <li>
    <span class="field-validation-error" data-valmsg-for="Address.City" data-valmsg-replace="true">Address.City</span>
  </li>
  <li>
    <span class="field-validation-error" data-valmsg-for="Address.District" data-valmsg-replace="true">Address.District</span>
  </li>
  <li>
    <span class="field-validation-error" data-valmsg-for="Address.Street" data-valmsg-replace="true">Address.Street</span>
  </li>
</ul>

HtmlHelper.ValidationSummary

除了通过ValidationMessageFor与ValidationMessage这两个方法显示单条验证消息之外，我们还可以通过调用HtmlHelper的扩展方法ValidationSummary将所有的验证消息一并显示出来。如下面的代码片断所示，ValidationExtensions定义了一系列ValidationSummary方法重载。布尔类型的参数excludePropertyErrors表示是否需要排除基于属性的验证消息，而通过message参数可以为ValidationSummary指定一个作为标题的字符串。

public static class ValidationExtensions
{
    //其他成员
    public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper);
    public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, bool excludePropertyErrors);
    public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, string message);
    public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, bool excludePropertyErrors, string message);
    public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, string message, IDictionary<string, object> htmlAttributes);
    public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, string message, object htmlAttributes);
    public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, bool excludePropertyErrors, string message, IDictionary<string, object> htmlAttributes);
    public static MvcHtmlString ValidationSummary(this HtmlHelper htmlHelper, bool excludePropertyErrors, string message, object htmlAttributes);
}

ModelStateDictionary是一个Key和Value分别为字符串和ModelState的字典，并且允许一个空字符串作为其Key。ValidationSummary方法通过Key是否为空来判断ModelState包含的ModelError是否是针对属性。ModelStateDictionary还定义了如下两个AddModelError方法重载是我们很容易地进行ModelError的设置。在该方法执行过程中，如果具有相同Key的ModelState对象存在，那么被添加的ModelError将会直接添加到它的Errors集合中；否则会添加一个新的ModelState并将添加的ModelError包含其中。

[Serializable]
public class ModelStateDictionary : IDictionary<string, ModelState>, ICollection<KeyValuePair<string, ModelState>>,
    IEnumerable<KeyValuePair<string, ModelState>>, IEnumerable
{
    //其他成员
    public void AddModelError(string key, Exception exception);
    public void AddModelError(string key, string errorMessage);
}

在一个通过Visual Studio的ASP.NET MVC项目模板创建的空Web应用中，我们定义了如下一个默认的HomeController。在默认的Action方法Index中我们添加了四个ModelError到当前的ModelState集合中，除了最后一个将一个空字符串作为Key之外，前三个均具有一个明确的Key。最后我们直接将默认的View呈现出来。

public class HomeController : Controller
{
    public ActionResult Index()
    {
        ModelState.AddModelError("Name", "请输入姓名");
        ModelState.AddModelError("PhoneNo", "请输入电话号码");
        ModelState.AddModelError("EmailAddress", "请输入电子邮箱地址");

        ModelState.AddModelError("", "系统发生异常，详细信息请与管理员联系");
        return View();
    }
}

如下所示的Action方法Index对应的View的定义，在该View中我们两次调用HtmlHelper的ValidationSummary方法并且指定了message参数。ValidationSummary方法的参数excludePropertyErrors在两次调用中分别设置为False和True。

@Html.ValidationSummary(false, "excludePropertyErrors: false")
@Html.ValidationSummary(true, "excludePropertyErrors: true")

该程序运行之后会在浏览器中呈现如下图所示的效果。我们可以看到当excludePropertyErrors参数被设置为True的时候，ValidationSummary中只会呈现出Key为空字符串的ModelState的错误消息。

错误消息在EditForModel方法中的呈现

在一个强类型View中调用HtmlHelper<TModel>的扩展方法EditorForModel将整个Model对象以编辑模式呈现出来时，如果某个属性对应的ModelSate具有相应的错误（通过Errors属性表示的ModelError集合不为空），错误消息也会一并呈现出来。当然，如果我们为Model类型定义了相应的模板，那又另当别论。我们同样可以通过一个简单的实例来演示错误消息在EditForModel方法中的呈现。在一个通过Visual Studio的ASP.NET MVC项目模板创建的空Web应用中，我们定义了如下一个属性的Contact类型作为View的Model。

public class Contact
{
    [DisplayName("姓名")]
    public string Name { get; set; }

    [DisplayName("电话号码")]
    public string PhoneNo { get; set; }

    [DisplayName("电子邮箱地址")]
    public string EmailAddress { get; set; }
}

然后我们创建一个具有如下定义的HomeController。在Action方法Index中，我们通过调用当ModelState属性的AddModelError方法认为地添加三个错误消息，对应的ModelState名称与作为Model的Contact类型的属性名称一致。最后我们将创建的Contact对象在默认的View中呈现出来。

public class HomeController : Controller
{
    public ActionResult Index()
    {
        ModelState.AddModelError("Name", "请输入姓名");
        ModelState.AddModelError("PhoneNo", "请输入电话号码");
        ModelState.AddModelError("EmailAddress", "请输入电子邮箱地址");
        return View(new Contact());
    }
}

下面的代码片断代表了Action方法Index对应的View的定义，该View的Model类型为Contact，我们仅仅简单地调用HtmlHelper<TModel>的扩展方法EditorForModel将整个Model对象以编辑的模式呈现出来。

@model Contact
@Html.EditorForModel()

当我们成功运行该程序的时候会在浏览器中呈现出如下图所示的效果，我们可以 看到在每个属性对应的文本框后面，相应的错误消息被显示出来。（S607）

四、 Model绑定与Model验证

在前面我们不止一次地提到，Model验证可以看成是Model绑定的一个中间环节。具体来说，Model验证最终是通过默认的ModelBinder，即DefaultModelBinder实现的。那么现在有这么一个问题：ModelBinder得到最终的作为目标Action方法的参数对象后，再递交给ModelValidator实施验证呢，还是ModelBinder在实施Model绑定的过程中动态地调用ModelValidator对通过ValueProvder提供的数据值实施验证？

实际上我们上面演示的两个实例已经回答了个问题。通过上面演示的两个例子我们知道通过CompositeModelValidator这个默认ModelValidator完成的Model验证并不是递归进行的），但是从整个Model绑定过程来看，Model验证却具有递归性，所以Model绑定和Model验证绝对不可能是先后的过程，唯一的可能是DefaultModelBinder在递归地进行Model绑定的过程中去调用ModelValidator对提供的数据实施验证。

同样以针对Contact类型的Model绑定为例。当DefaultModelBinder通过Model得到一个被初始化的Contact对象之后，会根据Contact类型的Model元数据调用ModelValidator的静态方法GetModelValidator得到一个CompositeModelValidator对象对Contact对象实施验证。由于CompositeModelValidator的Model验证不具有递归性，所以只有应用在Contact四个属性（Name、PhoneNo、Email和Address）及其自身类型上的验证规则在本轮验证中有效。

由于Contact的Address属性是一个复杂类型，所以在针对Contact类型的Model绑定过程中会递归地绑定一个Address对象并对Contact对象的Address属性进行初始化。而在完成对Address对象的绑定之后，又会调用ModelValidator的静态方法GetModelValidator根据基于Address类型的Model元数据得到一个CompositeModelValidator对初始化的Address对象实施验证。

Model元数据是一个树型层次化结构，我们的验证规则可以应用到每一个节点上。DefaultModelBinder就是在递归绑定复杂类型对象的过程中对绑定后的对象实施验证，从而使各个层次上的验证规则得以生效。不过CompositeModelValidator只有在所有属性值都验证通过的情况下，采用使用应用在类型上的验证规则对数据对象实施验证，所以验证的结果也不能完全反映所有的验证规则。

作者：Artech
出处：http://artech.cnblogs.com/
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。