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

一、ModelValidator與ModelValidatorProvider

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

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

針對(duì)目標(biāo)數(shù)據(jù)的驗(yàn)證是通過調(diào)用Validate方法來完成的，該方法的輸入?yún)?shù)container表示的正是被驗(yàn)證的對(duì)象。正是因?yàn)楸或?yàn)證的總是一個(gè)復(fù)雜類型的對(duì)象，后者又被稱為一個(gè)具有若干數(shù)據(jù)成員的“容器”對(duì)象，所以對(duì)應(yīng)的參數(shù)被命名為container。Validate方法表示驗(yàn)證結(jié)果的返回值并不是一個(gè)簡單的布爾值，而是一個(gè)元素類型為具有如下定義的ModelValidationResult對(duì)象集合。

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

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

ModelValidationResult集合只有在驗(yàn)證失敗的情況下才會(huì)返回。如果被驗(yàn)證數(shù)據(jù)對(duì)象符合所有的驗(yàn)證規(guī)則，Validate方法會(huì)直接返回Null或者一個(gè)空ModelValidationResult集合。值得一提的是，我們有時(shí)候會(huì)用ValidationResult的靜態(tài)只讀字段Success表示成功通過驗(yàn)證的結(jié)果，實(shí)際上該字段的值就是Null。

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

ModelValidator具有一個(gè)布爾類型的只讀屬性IsRequired表示該ModelValidator是否對(duì)目標(biāo)數(shù)據(jù)進(jìn)行“必需性”驗(yàn)證（即被驗(yàn)證的數(shù)據(jù)成員必須具有一個(gè)具體的值），該屬性默認(rèn)返回False。我們可以通過應(yīng)用RequiredAttribute特性將某個(gè)屬性定義成“必需”的數(shù)據(jù)成員。

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

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

如上面的代碼片段所示，GetValidators方法具有兩個(gè)參數(shù)，一個(gè)是用于描述被驗(yàn)證類型或者屬性Model元數(shù)據(jù)的ModelMetadata對(duì)象，另一個(gè)是當(dāng)前ControllerContext。該方法返回的是一個(gè)元素類型為ModelValidator的集合。

ASP.NET MVC 通過靜態(tài)類型ModelValidatorProviders對(duì)使用的ModelValidatorProvider進(jìn)行注冊(cè)。如下面的代碼片段所示，ModelValidatorProviders具有一個(gè)靜態(tài)只讀屬性Providers，對(duì)應(yīng)的類型為ModelValidatorProviderCollection，它表示基于整個(gè)Web應(yīng)用范圍的全局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元數(shù)據(jù)的ModelMetadata類型具有如下一個(gè)GetValidators方法，它返回的ModelValidator列表正是利用注冊(cè)到ModelValidatorProviders靜態(tài)屬性Providers上的ModelValidatorProvider創(chuàng)建的。

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

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

二、DataAnnotationsModelValidator

我們?cè)凇禔SP.NET MVC下的四種驗(yàn)證編程方式》中介紹了三種不同的“自動(dòng)化驗(yàn)證”的編程方式，ASP.NET MVC在內(nèi)部會(huì)采用不同的ModelValidator來對(duì)綁定的參數(shù)實(shí)施驗(yàn)證。一個(gè)具體的ModelValidator通常有相應(yīng)的ModelValidatorProvider來提供，接下來的內(nèi)容中將對(duì)ASP.NET MVC提供的原生的ModelValidator和對(duì)應(yīng)的ModelValidatorProvider作詳細(xì)的介紹。

對(duì)于上面提到的這三種驗(yàn)證編程方式，第一種（利用應(yīng)用在數(shù)據(jù)類型或其數(shù)據(jù)成員上的ValidationAttribute特性來定義相應(yīng)的驗(yàn)證規(guī)則）是最為常用的。基于ValidationAttribute特性這種聲明式驗(yàn)證解決方案最終通過DataAnnotationsModelValidator來完成。一個(gè)DataAnnotationsModelValidator對(duì)象實(shí)際上是對(duì)一個(gè)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,關(guān)于ValidationAttribute、DataAnnotationsModelValidator和DataAnnotationsModelValidatorProvider的詳細(xì)內(nèi)容可以參考之前寫的三篇文章。

ASP.NET MVC基于標(biāo)注特性的Model驗(yàn)證：ValidationAttribute

ASP.NET MVC基于標(biāo)注特性的Model驗(yàn)證：DataAnnotationsModelValidator

ASP.NET MVC基于標(biāo)注特性的Model驗(yàn)證：DataAnnotationsModelValidatorProvider

三、ValidatableObjectAdapter

如果被驗(yàn)證的數(shù)據(jù)類型實(shí)現(xiàn)了IValidatable接口，ASP.NET MVC會(huì)自動(dòng)調(diào)用實(shí)現(xiàn)的Validate方法對(duì)其實(shí)施驗(yàn)證，此時(shí)創(chuàng)建的ModelValidator是一個(gè)ValidatableObjectAdapter對(duì)象。ValidatableObjectAdapter定義如下，其Validate方法的實(shí)現(xiàn)邏輯很簡單：它直接調(diào)用被驗(yàn)證對(duì)象的Validate方法，并將返回的ValidationResult對(duì)象轉(zhuǎn)換成ModelValidationResult類型。

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

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

四、DataErrorInfoModelValidator

如果我們讓數(shù)據(jù)類型實(shí)現(xiàn)IDataErrorInfo接口，可以利用實(shí)現(xiàn)的Error屬性和索引提供針對(duì)自身以及所屬數(shù)據(jù)成員的驗(yàn)證錯(cuò)誤信息。針對(duì)這樣的數(shù)據(jù)類型，ASP.NET MVC最終會(huì)創(chuàng)建一個(gè)DataErrorInfoModelValidator對(duì)象來對(duì)其實(shí)施驗(yàn)證，DataErrorInfoClassModelValidator和DataErrorInfoPropertyModelValidator是兩個(gè)具體的DataErrorInfoModelValidator。

DataErrorInfoClassModelValidator和DataErrorInfoPropertyModelValidator是兩個(gè)內(nèi)部類型。前者針對(duì)容器對(duì)象自身實(shí)施驗(yàn)證，所以它只需要從實(shí)現(xiàn)的Error屬性中提取錯(cuò)誤消息并將其轉(zhuǎn)換成返回的ModelValidationResult對(duì)象。后者則專門驗(yàn)證容器對(duì)象的某個(gè)屬性，它在實(shí)現(xiàn)的Validate方法中會(huì)利用屬性名從實(shí)現(xiàn)的索引中提取相應(yīng)的錯(cuò)誤消息并將其轉(zhuǎn)換成返回的ModelValidationResult對(duì)象。

 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。對(duì)于其實(shí)現(xiàn)的GetValidators方法來說，如果被驗(yàn)證對(duì)象的類型實(shí)現(xiàn)了IDataErrorInfo接口，它會(huì)創(chuàng)建一個(gè)DataErrorInfoClassModelValidator對(duì)象并添加到返回的ModelValidator列表中。如果被驗(yàn)證的是容器類型的某個(gè)屬性值并且容器類型實(shí)現(xiàn)了IDataErrorInfo接口，它會(huì)創(chuàng)建一個(gè)DataErrorInfoPropertyModelValidator對(duì)象并添加到返回的ModelValidator列表中。

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

以上就是本文的全部內(nèi)容，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來一定的幫助，如果有疑問大家可以留言交流，同時(shí)也希望多多支持腳本之家！

最新評(píng)論