ASP.NET MVC以ModelValidator為核心的Model驗證體系: ModelValidatorProviders

前面篇文章我們分別介紹用真正用於實施Model驗證的ModelValidator（《ASP.NET MVC以ModelValidator為核心的Model驗證體系: ModelValidator》），以及用於提供ModelValidator的ModelValidatorProvider（《ASP.NET MVC以ModelValidator為核心的Model驗證體系: ModelValidatorProvider》），那么對於ASP.NET MVC的Model驗證體系來說，最終是通過怎樣的方式對ModelValidatorProvider進行注冊，又是如何利用它們來創建相應的ModelValidator來實施Model驗證的呢？這就是本篇文章論述的重點。[本文已經同步到《How ASP.NET MVC Works?》中]

目錄
一、ModelValidatorProviders
二、ModelValidator、ModelValidatorProvider和ModelValidatorProviders
三、CompositeModelValidator
四、實例演示：探測CompositeModelValidator采用的驗證行為

一、ModelValidatorProviders

我們通過靜態類型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);
}

值得一提的是，ModelValidatorProviderCollection定義了一個GetValidators方法用於返回一個通過集合中每個ModelValidatorProvider創建的ModelValidator集合。在這個方法中，指定的Model元數據和Controller上下文會被傳入每個ModelValidatorProvider對象的GetValidators方法，得到的每個ModelValidator對象將會作為最終返回的ModelValidator集合的元素。

在默認的情況下，通過ModelValidatorProviders的Providers表示注冊的ModelValidatorProvider列表會包含三個對象，對應着我們前面介紹的三種ModelValidatorProvider類型，即DataAnnotationsModelValidatorProvider、ClientDataTypeModelValidatorProvider和DataErrorInfoPropertyModelValidator。

如果我們需要添加一個自定義ModelValidatorProvider，可以直接將相應的對象添加到ModelValidatorProviders的Providers列表中。如果需要采用自定義ModelValidatorProvider來替換掉現有的ModelValidatorProvider，比如我們創建了一個擴展的DataAnnotationsModelValidatorProvider，還需要將現有的ModelValidatorProvider從該列表中移除。

實現在ModelValidatorProvider中的ModelValidator提供機制是基於Model元數據和Controller上下文的，實際上用於描述Model元數據的ModelMetadata類型同樣定義了一個GetValidators方法用於根據指定的Controller上下文的所有ModelValidator對象。如下面的代碼片斷所示，該方法直接調用了通過ModelValidatorProviders的Providers屬性表述的ModelValidatorProviderCollection對象的同名方法。

public abstract class ModelValidator
{
    //其他成員
    public virtual IEnumerable<ModelValidator> GetValidators(ControllerContext context)
    {
        return ModelValidatorProviders.Providers.GetValidators(this, context);
    }
}

二、ModelValidator、ModelValidatorProvider和ModelValidatorProviders

上面我們介紹用於進行Model驗證的ModelValidator，用於提供ModelValidator的ModelValidatorProvider，以及用於注冊ModelValidatorProvider的ModelValidatorProviders，整個ModelValidator的提供機制以此三類組件為核心，下圖所示的UML體現了它們之間的關系。

三、CompositeModelValidator

雖然CompositeModelValidator僅僅是定義在程序集System.Web.Mvc.dll中的一個私有類型，但是它在ASP.NET MVC的Model驗證系統中具有重要的地位，可以說真正用於Model驗證的ModelValidator就是這么一個對象。從如下所以的成員定義代碼並不能看出CompositeModelValidator有何特別之處。

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

從其類型名稱可以看出CompositeModelValidator實際上並不是一個真正對Model對象實施驗證的ModelValidator，它是一系列ModelValidator的組合，它根據基於Model本身類型及其屬性的Model元數據動態地獲取相應的ModelValidator（通過調用ModelMetadata的GetValidators方法）對Model對象實施驗證。

定義在Validate方法中的驗證邏輯是這樣的：CompositeModelValidator通過在構造函數中初始化的表示驗證對象類型的Model元數據的ModelMetadata對象的Properties屬性得到基於屬性的Model元數據列表。然后遍歷該列表的每個ModelMetadata對象，調用其GetValidators方法得到一組用於驗證屬性值得ModelValidator列表，然后使用該ModelValidator列表依次對相應的屬性值進行驗證，驗證失敗得到的ModelValidationResult對象被添加到最終返回的ModelValidationResult集合中。

只有在所有屬性值都通過驗證的情況下，CompositeModelValidator采用調用基於被驗證類型Model元數據的ModelMetadata對象的GetValidators方法得到在類型級別ModelValidator列表對指定的數據對象實施驗證，驗證失敗得到的ModelValidationResult對象被添加到最終返回的ModelValidationResult集合中。

抽象類ModelValidator具有一個靜態的GetModelValidator方法根據指定的Model元數據和Controller上下文得到相應的ModelValidator對象。如下面的代碼片斷所示，該方法返回的正是一個CompositeModelValidator對象。

public abstract class ModelValidator
{
    //其他成員
    public static ModelValidator GetModelValidator(ModelMetadata metadata, ControllerContext context)
    {
        return new CompositeModelValidator(metadata, context);
    }
}

四、實例演示：探測CompositeModelValidator采用的驗證行為

為了使讀者對CompositeModelValidator的驗證邏輯具有一個深刻的理解，我們來演示一個具體的Model驗證的實例。我們創建了如果一個名稱為AlwaysFailsAttribute的驗證特性。如下面的代碼片斷所示，重寫的IsValid方法總是返回False，意味着針對數據的驗證總是會失敗。我們還重寫了只讀屬性TypeId，讓它能夠真正能夠唯一標識一個AlwaysFailsAttribute特性實例，具體原因我們會在本章后續部分講述。

[AttributeUsage( AttributeTargets.Class| AttributeTargets.Property)]
 public class AlwaysFailsAttribute : ValidationAttribute
{
    private object typeId;
    public override bool IsValid(object value)
    {
        return false;
    }
    public override object TypeId
    {
        get { return typeId ?? (typeId = new object()); }
    }
}

我們將AlwaysFailsAttribute應用到具有如下定義的表示聯系人的Contact類型上。如下面的代碼片斷所示，我們在Contact和Address的類型和屬性都應用了該特性，並且指定了相應的錯誤消息。

[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類。在Action方法Index中，我們使用當前的ModelMetadataProvider創建了基於Contact類型的ModelMetadata，然后調用ModelValidator的靜態方法GetValidator方法得到基於該ModelMetadata和ControllerContext的ModelValidator對象（一個CompositeModelValidator對象）。最后我們通過該ModelValidator對象來驗證手工創建的Contact對象，並將得到的ModelValidationResult對象的MemberName和Message屬性呈現出來。

public class HomeController : Controller
{
    public void Index()
    {
        Address address = new Address
        {
            Province = "江蘇",
            City     = "蘇州",
            District = "工業園區",
            Street   = "星湖街328號"
        };
        Contact contact = new Contact
        {
            Name         = "張三",
            PhoneNo      = "123456789",
            EmailAddress = "[e-mail]",
            Address      = address
        };

        ModelMetadata metadata = ModelMetadataProviders.Current.GetMetadataForType(() => contact, typeof(Contact));
        ModelValidator validator = ModelValidator.GetModelValidator(metadata, ControllerContext);
        foreach (ModelValidationResult result in validator.Validate(contact))
        {
            Response.Write(string.Format("{0}: {1}<br/>", string.IsNullOrEmpty(result.MemberName)? "N/A": result.MemberName, result.Message));
        }
    }
}

運行該程序后會在瀏覽器中得到如下所示的輸出結果。這樣的輸出結果至少反映了兩個問題，其一，CompositeModelValidator對數據的驗證並不是遞歸進行的，因為只有應用在Contact屬性上的驗證特性參與了驗證，而應用在Address類型屬性上的驗證特性則沒有被使用；其二，在屬性認證失敗的情況下是不會進行基於類型的驗證的，因為瀏覽器中並不存在應用在Contact類型上的驗證特性對應的輸出。

Name        : Contact.Name
PhoneNo     : Contact.PhoneNo
EmailAddress: Contact.EmailAddress
Address     : Contact.Address
Address     : Address

上面的輸出結果還反映了另外一個細節，針對某個屬性的ModelValidator列表會同時包含應用在屬性和屬性對應類型的驗證特性生成的ModelValidator。輸出的最后兩個ModelValidationResult都是針對Contact的Address屬性的，分別對應着應用在Contact的Address屬性和Address類型上的兩個AlwaysFailsAttribute特性。現在我們按照如下的方式將應用在Contact的四個屬性以及Address類型上的AlwaysFailsAttribute特性注冊掉，只保留應用在Contact類型的AlwaysFailsAttribute特性。

[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
{
    //省略成員
}

在此運行我們的程序將會在瀏覽器中得到如下的輸出結果。不難看出輸出的ModelValidationResult對應於着應用在Contact類型上的AlwaysFailsAttribute特性，這充分反映了上面所說的：基於類型的驗證只有在基於屬性的驗證失敗的情況下才會進行。

N/A: Contact

 

ASP.NET MVC以ModelValidator為核心的Model驗證體系: ModelValidator
ASP.NET MVC以ModelValidator為核心的Model驗證體系: ModelValidatorProvider
ASP.NET MVC以ModelValidator為核心的Model驗證體系: ModelValidatorProviders