天天看點

ASP.NET MVC下的四種驗證程式設計方式[續篇]一、ModelValidator與ModelValidatorProvider二、DataAnnotationsModelValidator四、DataErrorInfoModelValidator

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

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

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

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

ModelValidator具有一個布爾類型的隻讀屬性IsRequired表示該ModelValidator是否對目标資料進行“必需性”驗證(即被驗證的資料成員必須具有一個具體的值),該屬性預設傳回False。我們可以通過應用RequiredAttribute特性将某個屬性定義成“必需”的資料成員。

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

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

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

值得一提的是用于描述Model中繼資料的ModelMetadata類型具有如下一個GetValidators方法,它傳回的ModelValidator清單正是利用注冊到ModelValidatorProviders靜态屬性Providers上的ModelValidatorProvider建立的。

ASP.NET MVC下的四種驗證程式設計方式[續篇]一、ModelValidator與ModelValidatorProvider二、DataAnnotationsModelValidator四、DataErrorInfoModelValidator

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

對于上面提到的這三種驗證程式設計方式,第一種(利用應用在資料類型或其資料成員上的ValidationAttribute特性來定義相應的驗證規則)是最為常用的。基于ValidationAttribute特性這種聲明式驗證解決方案最終通過DataAnnotationsModelValidator來完成。一個DataAnnotationsModelValidator對象實際上是對一個ValidationAttribute特性的封裝,這可以從如下所示的定義看出來。

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

<a href="http://www.cnblogs.com/artech/archive/2012/06/06/data-annotations-model-validation-01.html">ASP.NET MVC基于标注特性的Model驗證:ValidationAttribute</a>

<a href="http://www.cnblogs.com/artech/archive/2012/06/07/data-annotations-model-validation-02.html">ASP.NET MVC基于标注特性的Model驗證:DataAnnotationsModelValidator</a>

<a href="http://www.cnblogs.com/artech/archive/2012/06/08/data-annotations-model-validation-03.html">ASP.NET MVC基于标注特性的Model驗證:DataAnnotationsModelValidatorProvider</a>

三、ValidatableObjectAdapter

如果被驗證的資料類型實作了IValidatable接口,ASP.NET MVC會自動調用實作的Validate方法對其實施驗證,此時建立的ModelValidator是一個ValidatableObjectAdapter對象。ValidatableObjectAdapter定義如下,其Validate方法的實作邏輯很簡單:它直接調用被驗證對象的Validate方法,并将傳回的ValidationResult對象轉換成ModelValidationResult類型。

雖然ValidatableObjectAdapter繼承自ModelValidator,但是ASP.NET MVC貌似沒有将其視為一個真正意義上的ModelValidator,而是将其視為一個“擴充卡(Adapter)”。ASP.NET MVC也沒有為ValidatableObjectAdapter定義單獨的ModelValidatorProvider,它的提供者其實是上面提到過的DataAnnotationsModelValidatorProvider。

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

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

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

繼續閱讀