ASP.NET MVC下的四種驗證編程方式[續篇]

在《ASP.NET MVC的四種驗證編程方式》一文中我們介紹了ASP.NET MVC支持的四種服務端驗證的編程方式（“手工驗證”、“標注ValidationAttribute特性”、“讓數據類型實現IValidatableObject或者IDataErrorInfo”），那么在ASP.NET MVC框架內部是如何提供針對這四種不同編程方式的支持的呢？接下來我們就來聊聊這背后的故事。

一、ModelValidator與ModelValidatorProvider

雖然Model綁定的方式因被驗證數據類型的差異而有所不同，但是ASP.NET MVC總是使用一個名為ModelValidator的對象來對綁定的數據對象實施驗證。所有的ModelValidator類型均繼承自具有如下定義的抽象類ModelValidator。它的GetClientValidationRules方法返回一個元素類型為ModelClientValidationRule的集合，而ModelClientValidationRule是對客戶端驗證規則的封裝，我們會在客戶端驗證部分對其進行詳細介紹。

 public abstract class ModelValidator
 {
 //其他成員
 public virtual IEnumerable<ModelClientValidationRule> GetClientValidationRules();
 public abstract IEnumerable<ModelValidationResult> Validate(object container);
 
 public virtual bool IsRequired { get; }
 }

針對目標數據的驗證是通過調用Validate方法來完成的，該方法的輸入參數container表示的正是被驗證的對象。正是因為被驗證的總是一個復雜類型的對象，后者又被稱為一個具有若干數據成員的“容器”對象，所以對應的參數被命名為container。Validate方法表示驗證結果的返回值并不是一個簡單的布爾值，而是一個元素類型為具有如下定義的ModelValidationResult對象集合。

 public class ModelValidationResult
 { 
 public string MemberName { get; set; }
 public string Message { get; set; }
 }

ModelValidationResult具有兩個字符串類型屬性MemberName和Message，前者代表被驗證數據成員的名稱，后者表示錯誤消息。一般來說，如果ModelValidationResult對象來源于針對容器對象本身的驗證，它的MemberName屬性為空字符串。對于針對容器對象某個屬性的驗證來說，屬性名稱會作為返回的ModelValidationResult對象的MemberName屬性。

ModelValidationResult集合只有在驗證失敗的情況下才會返回。如果被驗證數據對象符合所有的驗證規則，Validate方法會直接返回Null或者一個空ModelValidationResult集合。值得一提的是，我們有時候會用ValidationResult的靜態只讀字段Success表示成功通過驗證的結果，實際上該字段的值就是Null。

 public class ValidationResult
 {
 //其他成員
 public static readonly ValidationResult Success;
 }

ModelValidator具有一個布爾類型的只讀屬性IsRequired表示該ModelValidator是否對目標數據進行“必需性”驗證（即被驗證的數據成員必須具有一個具體的值），該屬性默認返回False。我們可以通過應用RequiredAttribute特性將某個屬性定義成“必需”的數據成員。

我們知道ASP.NET MVC大都采用Provider的模式來提供相應的組件，比如描述Model元數據的ModelMetadata通過對應的ModelMetadataProvider來提供，實現Model綁定的ModelBinder則可以通過對應的ModelBinderProvider來提供，用于實現Model驗證的ModelValidator也不例外，它對應的提供者為ModelValidatorProvider，對應的類型繼承自具有如下定義的抽象類ModelValidator Provider。

 public abstract class ModelValidatorProvider
 {
 public abstract IEnumerable<ModelValidator> GetValidators(ModelMetadata metadata, ControllerContext context);
 }

如上面的代碼片段所示，GetValidators方法具有兩個參數，一個是用于描述被驗證類型或者屬性Model元數據的ModelMetadata對象，另一個是當前ControllerContext。該方法返回的是一個元素類型為ModelValidator的集合。

ASP.NET MVC 通過靜態類型ModelValidatorProviders對使用的ModelValidatorProvider進行注冊。如下面的代碼片段所示，ModelValidatorProviders具有一個靜態只讀屬性Providers，對應的類型為ModelValidatorProviderCollection，它表示基于整個Web應用范圍的全局ModelValidatorProvider集合。

 public static class ModelValidatorProviders
 { 
 public static ModelValidatorProviderCollection Providers { get; }
 }
 public class ModelValidatorProviderCollection : Collection<ModelValidatorProvider>
 { 
 public ModelValidatorProviderCollection();
 public ModelValidatorProviderCollection(IList<ModelValidatorProvider> list);
 public IEnumerable<ModelValidator> GetValidators(ModelMetadata metadata, ControllerContext context); 
 }

值得一提的是用于描述Model元數據的ModelMetadata類型具有如下一個GetValidators方法，它返回的ModelValidator列表正是利用注冊到ModelValidatorProviders靜態屬性Providers上的ModelValidatorProvider創建的。

 public class ModelMetadata
 {
 //其他成員
 public virtual IEnumerable<ModelValidator> GetValidators(ControllerContext context);
 }

如右圖所示的UML列出了組成Model驗證系統的三個核心類型。具體的Model驗證工作總是通過某個具體的ModelValidator來完成，作為ModelValidator提供者的ModelValidatorProvider注冊在靜態類型ModelValidatorProviders之上。

二、DataAnnotationsModelValidator

我們在《ASP.NET MVC下的四種驗證編程方式》中介紹了三種不同的“自動化驗證”的編程方式，ASP.NET MVC在內部會采用不同的ModelValidator來對綁定的參數實施驗證。一個具體的ModelValidator通常有相應的ModelValidatorProvider來提供，接下來的內容中將對ASP.NET MVC提供的原生的ModelValidator和對應的ModelValidatorProvider作詳細的介紹。

對于上面提到的這三種驗證編程方式，第一種（利用應用在數據類型或其數據成員上的ValidationAttribute特性來定義相應的驗證規則）是最為常用的?；赩alidationAttribute特性這種聲明式驗證解決方案最終通過DataAnnotationsModelValidator來完成。一個DataAnnotationsModelValidator對象實際上是對一個ValidationAttribute特性的封裝，這可以從如下所示的定義看出來。

 public class DataAnnotationsModelValidator : ModelValidator
 { 
 public DataAnnotationsModelValidator(ModelMetadata metadata, ControllerContext context, ValidationAttribute attribute);
 public override IEnumerable<ModelClientValidationRule> GetClientValidationRules();
 public override IEnumerable<ModelValidationResult> Validate(object container);
 
 protected internal ValidationAttribute Attribute { get; }
 protected internal string ErrorMessage { get; }
 public override bool IsRequired { get; }
 }

DataAnnotationsModelValidator的提供者為DataAnnotationsModelValidatorProvider,關于ValidationAttribute、DataAnnotationsModelValidator和DataAnnotationsModelValidatorProvider的詳細內容可以參考之前寫的三篇文章。

ASP.NET MVC基于標注特性的Model驗證：ValidationAttribute

ASP.NET MVC基于標注特性的Model驗證：DataAnnotationsModelValidator

ASP.NET MVC基于標注特性的Model驗證：DataAnnotationsModelValidatorProvider

三、ValidatableObjectAdapter

如果被驗證的數據類型實現了IValidatable接口，ASP.NET MVC會自動調用實現的Validate方法對其實施驗證，此時創建的ModelValidator是一個ValidatableObjectAdapter對象。ValidatableObjectAdapter定義如下，其Validate方法的實現邏輯很簡單：它直接調用被驗證對象的Validate方法，并將返回的ValidationResult對象轉換成ModelValidationResult類型。

 public class ValidatableObjectAdapter : ModelValidator
 {
 public ValidatableObjectAdapter(ModelMetadata metadata, ControllerContext context);
 public override IEnumerable<ModelValidationResult> Validate(object container);
 }

雖然ValidatableObjectAdapter繼承自ModelValidator，但是ASP.NET MVC貌似沒有將其視為一個真正意義上的ModelValidator，而是將其視為一個“適配器（Adapter）”。ASP.NET MVC也沒有為ValidatableObjectAdapter定義單獨的ModelValidatorProvider，它的提供者其實是上面提到過的DataAnnotationsModelValidatorProvider。

四、DataErrorInfoModelValidator

如果我們讓數據類型實現IDataErrorInfo接口，可以利用實現的Error屬性和索引提供針對自身以及所屬數據成員的驗證錯誤信息。針對這樣的數據類型，ASP.NET MVC最終會創建一個DataErrorInfoModelValidator對象來對其實施驗證，DataErrorInfoClassModelValidator和DataErrorInfoPropertyModelValidator是兩個具體的DataErrorInfoModelValidator。

DataErrorInfoClassModelValidator和DataErrorInfoPropertyModelValidator是兩個內部類型。前者針對容器對象自身實施驗證，所以它只需要從實現的Error屬性中提取錯誤消息并將其轉換成返回的ModelValidationResult對象。后者則專門驗證容器對象的某個屬性，它在實現的Validate方法中會利用屬性名從實現的索引中提取相應的錯誤消息并將其轉換成返回的ModelValidationResult對象。

 internal sealed class DataErrorInfoClassModelValidator : ModelValidator
 {
 public DataErrorInfoClassModelValidator(ModelMetadata metadata, ControllerContext controllerContext);
 public override IEnumerable<ModelValidationResult> Validate(object container);
 } 
 internal sealed class DataErrorInfoPropertyModelValidator : ModelValidator
 {
 public DataErrorInfoPropertyModelValidator(ModelMetadata metadata, ControllerContext controllerContext);
 public override IEnumerable<ModelValidationResult> Validate(object container);
 }

ASP.NET MVC最終利用具有如下定義的DataErrorInfoModelValidatorProvider來提供這兩種類型的DataErrorInfoModelValidator。對于其實現的GetValidators方法來說，如果被驗證對象的類型實現了IDataErrorInfo接口，它會創建一個DataErrorInfoClassModelValidator對象并添加到返回的ModelValidator列表中。如果被驗證的是容器類型的某個屬性值并且容器類型實現了IDataErrorInfo接口，它會創建一個DataErrorInfoPropertyModelValidator對象并添加到返回的ModelValidator列表中。

 public class DataErrorInfoModelValidatorProvider : ModelValidatorProvider
 {
 public override IEnumerable<ModelValidator> GetValidators(ModelMetadata metadata, ControllerContext context);
 }

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com