ASP.NET MVC基於標注特性的Model驗證：一個Model，多種驗證規則

對於Model驗證，理想的設計應該是場景驅動的，而不是Model（類型）驅動的，也就是對於同一個Model對象，在不同的使用場景中可能具有不同的驗證規則。舉個簡單的例子，對於一個表示應聘者的數據對象來說，針對應聘的崗位不同，肯定對應聘者的年齡、性別、專業技能等方面有不同的要求。但是ASP.NET MVC的Model驗證確是Model驅動的，因為驗證規則以驗證特性的形式應用到Model類型及其屬性上。這樣的驗證方式實際上限制了Model類型在基於不同驗證規則的使用場景中的重用。通過上一篇文章《將ValidationAttribute應用到參數上》的擴展我們將驗證特性直接應用在參數上變成了可能，這從一定程度上解決了這個問題，但是只能解決部分問題，因為應用到參數的驗證特性只能用於針對參數類型級別的驗證，而不能用於針對參數類型屬性級別的驗證（源代碼從這里下載）。[本文已經同步到《How ASP.NET MVC Works?》中]

目錄
一、同一個Model在采用不同的驗證規則
二、新的基類ValidatorAttribute
三、指定當前采用的驗證規則：ValidationRuleAttribute
四、新的Controller基類：RuleBasedController
五、自定義ModelValidatorProvider：RuleBasedValidatorProvider

一、同一個Model在采用不同的驗證規則

現在我們通過利用對ASP.NET MVC的擴展來實現一種基於不同驗證規則的Model驗證。為了讓讀者對這種認證方式有一個感官的認識，我們來看看這個擴展最終實現怎樣的驗證效果。在通過Visual Studio的ASP.NET MVC 項目模板創建的空Web應用中，我們定義了如下一個Person類型作為Model。

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

    [DisplayName("性別")]
    public string Gender { get; set; }

    [DisplayName("年齡")]
    [RangeValidator(10, 20, RuleName = "Rule1",  ErrorMessage = "{0}必須在{1}和{2}之間！")]
    [RangeValidator(20, 30, RuleName = "Rule2", ErrorMessage = "{0}必須在{1}和{2}之間！")]
    [RangeValidator(30, 40, RuleName = "Rule3", ErrorMessage = "{0}必須在{1}和{2}之間！")]
    public int Age { get; set; }
}

在表示年齡的Age屬性上應用了三個RangeValidatorAttribute（不是RangeAttribute），它們對應針對年齡的三種不同的驗證規則，RuleName屬性表示規則名稱。三種驗證規則（Rule1、Rule2和Rule3）分別要求年齡分別在10到20、20到30和30到40歲之間。

然后我們定義了具有如下定義HomeController，它具有三組Action方法（Index、Rule1和Rule2）。方法Rule1、Rule2和HomeController類上應用了一個ValidationRuleAttribute特性用於指定了當前采用的驗證規則。用於指定驗證規則的ValidationRuleAttribute特性可以同時應用於Controller類型和Action方法上，應用於后者的ValidationRuleAttribute特性具有更高的優先級。針對HomeController的定義，Action方法Index、Rule1和Rule2分別采用的驗證規則為Rule3、Rule1和Rule2。

[ValidationRule("Rule3")]
public class HomeController : RuleBasedController
{
    public ActionResult Index()
    {
        return View("person", new Person());
    }
    [HttpPost]
    public ActionResult Index(Person person)
    {
        return View("person", person);
    }

    [ValidationRule("Rule1")]
    public ActionResult Rule1()
    {
        return View("person", new Person());
    }
    [HttpPost]
    [ValidationRule("Rule1")]
    public ActionResult Rule1(Person person)
    {
        return View("person", person);
    }

    [ValidationRule("Rule2")]
    public ActionResult Rule2()
    {
        return View("person", new Person());
    }
    [HttpPost]
    [ValidationRule("Rule2")]
    public ActionResult Rule2(Person person)
    {
        return View("person", person);
    }
}

定義在HomeController中的6個方法均將創建的/接收的Person對象呈現到名為Person的View中，該View的定義如下所示。這是一個將Person類型作為Model的強類型View，在該View中我們將作為Model的Person對象以編輯模式呈現在一個表單中，並在表單中提供一個提交按鈕。

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

現在運行我們的程序，並通過在瀏覽器中指定相應的地址分別訪問定義在HomeController的三個Action（Index、Rule1和Rule2），一個用於編輯個人信息的表單會呈現出來。然后我們根據三個Action方法采用的驗證規則輸入不合法的年齡，然后點擊“保存”按鈕，我們會看到輸入的年齡按照對應的規則被驗證了，具體的驗證效果如下圖所示。

二、新的基類ValidatorAttribute

我們現在就來具體談談上面這個例子所展示的基於不同規則的Model驗證是如何實現的。首先我們需要重建一套新的驗證特性體系，只為我們能夠指定具體的驗證規則。為此我們定義了一個抽象的ValidatorAttribute類型，如下面的代碼片斷所示，ValidatorAttribute直接繼承自ValidationAttribute，屬性RuleName表示采用的驗證規則名稱。我們重寫了TypeId屬性，因為我們需要在相同的屬性或者類型上應用多個同類的ValidatorAttribute。

[AttributeUsage( AttributeTargets.Class| AttributeTargets.Property,AllowMultiple = true)]
public abstract class ValidatorAttribute: ValidationAttribute
{
    private object typeId;
    public string RuleName { get; set; }
    public override object TypeId
    {
        get{return typeId ?? (typeId = new object());}
    }
}

上面演示實例采用的RangeValidatorAttribute定義如下，我們可以看到它僅僅是對RangeAttribute的封裝。RangeValidatorAttribute具有與RangeAttribute一致的構造函數定義，並直接使用被封裝的RangeAttribute實施驗證。除了能夠通過RuleName指定具體采用的驗證規則之外，其他的使用方式與RangeAttribute完全一致。

[AttributeUsage( AttributeTargets.Property, AllowMultiple = true)]
public class RangeValidatorAttribute:ValidatorAttribute
{
    private RangeAttribute rangeAttribute;
    public RangeValidatorAttribute(int minimum, int maximum)
    {
        rangeAttribute = new RangeAttribute(minimum, maximum);
    }
    public RangeValidatorAttribute(double minimum, double maximum)
    {
        rangeAttribute = new RangeAttribute(minimum, maximum);
    }
    public RangeValidatorAttribute(Type type, string minimum, string maximum)
    {
        rangeAttribute = new RangeAttribute(type, minimum, maximum);
    }
    public override bool IsValid(object value)
    {
        return rangeAttribute.IsValid(value);
    }

    public override string FormatErrorMessage(string name)
    {
        return string.Format(CultureInfo.CurrentCulture, base.ErrorMessageString, new object[] { name, rangeAttribute.Minimum, rangeAttribute.Maximum });
    }
}

三、指定當前采用的驗證規則：ValidationRuleAttribute

ValidatorAttribte的RuleName屬性僅僅指定了驗證特性采用的驗證規則名稱，當前應在采用的驗證規則通過應用在Action方法或者Controller類型上的ValidationRuleAttribute特性還指定。如下所示的就是ValidationRuleAttribute的定義，它僅僅包含一個表示當前采用的驗證規則名稱的RuleName屬性的特性而已。

[AttributeUsage( AttributeTargets.Class| AttributeTargets.Method)]
public class ValidationRuleAttribute: Attribute
{
    public string RuleName { get; private set; }
    public ValidationRuleAttribute(string ruleName)
    {
        this.RuleName = ruleName;
    }
}

四、新的Controller基類：RuleBasedController

對於這個用於實現針對不同驗證規則的擴展來說，其核心是如何將通過ValidationRuleAttribute特性設置的驗證規則應用到ModelValidator的提供機制中，使之篩選出與當前驗證規則匹配的驗證特性，在這里我們依然使用Controller上下文來保存這個這個驗證規則名稱。細心的讀者應該留意到了上面演示實例中創建的HomeController不是繼承自Controller，而是繼承自RuleBasedController，這個自定義的Controller基類定義如下。

public class RuleBasedController: Controller
{
    private static Dictionary<Type, ControllerDescriptor> controllerDescriptors = new Dictionary<Type, ControllerDescriptor>();
    public ControllerDescriptor ControllerDescriptor
    {
        get
        {
            ControllerDescriptor controllerDescriptor;
            if (controllerDescriptors.TryGetValue(this.GetType(), out controllerDescriptor))
            {
                return controllerDescriptor;
            }
            lock (controllerDescriptors)
            {
                if (!controllerDescriptors.TryGetValue(this.GetType(), out controllerDescriptor))
                {
                    controllerDescriptor = new ReflectedControllerDescriptor(this.GetType());
                    controllerDescriptors.Add(this.GetType(), controllerDescriptor);
                }
                return controllerDescriptor;
            }
        }
    }
    protected override IAsyncResult BeginExecuteCore(AsyncCallback callback, object state)
    {
        SetValidationRule();
        return base.BeginExecuteCore(callback, state);
    }
    protected override void ExecuteCore()
    {
        SetValidationRule();
        base.ExecuteCore();
    }
    private void SetValidationRule()
    {
        string actionName = this.ControllerContext.RouteData.GetRequiredString("action");
        ActionDescriptor actionDescriptor = this.ControllerDescriptor.FindAction(this.ControllerContext, actionName);
        if (null != actionDescriptor)
        {
            ValidationRuleAttribute validationRuleAttribute = actionDescriptor.GetCustomAttributes(true).OfType<ValidationRuleAttribute>().FirstOrDefault() ??
                this.ControllerDescriptor.GetCustomAttributes(true).OfType<ValidationRuleAttribute>().FirstOrDefault() ??
                new ValidationRuleAttribute(string.Empty);
            this.ControllerContext.RouteData.DataTokens.Add("ValidationRuleName", validationRuleAttribute.RuleName);
        }
    }
}

在繼承自Controller的RuleBasedController中，ExecuteCore和BeginExecuteCore方法被重寫，在調用基類的同名方法之前，方法SetValidationRule方法被調用將應用在當前Action方法或者Controller類型上的ValidationRuleAttribute特性指定的驗證規則名稱保存到當前Controller上下文中。由於對Action方法和Controller類上特性的解析需要使用到用於描述Controller的ControllerDescriptor對象，處於性能考慮，我們對該對象進行了全局緩存。

五、自定義ModelValidatorProvider：RuleBasedValidatorProvider

對於應用在同一個屬性或者類型上的多個基於不同驗證規則的ValidatorAttribute，對應的驗證規則名稱並沒有應用到具體的驗證邏輯中。以上面定義的RangeValidatorAttribute為例，具體的驗證邏輯通過被封裝的RangeAttribute來實現，如果我們不做任何的處理，所有的基於不同規則的RangeValidatorAttribute都還參與到最終的Model驗證過程中。我們必須作的是在根據驗證特性創建ModelValidator的時候只選擇那些與當前驗證規則一直的ValidatorAttribute，這樣的操作實現在具有如下定義的RuleBasedValidatorProvider中。

public class RuleBasedValidatorProvider : DataAnnotationsModelValidatorProvider
{
    protected override IEnumerable<ModelValidator> GetValidators(ModelMetadata metadata, ControllerContext context, IEnumerable<Attribute> attributes)
    {
        object validationRuleName = string.Empty;
        context.RouteData.DataTokens.TryGetValue("ValidationRuleName", out validationRuleName);
        string ruleName = validationRuleName.ToString();
        attributes = this.FilterAttributes(attributes, ruleName);
        return base.GetValidators(metadata, context, attributes);
    }

    private IEnumerable<Attribute> FilterAttributes(IEnumerable<Attribute> attributes, string validationRule)
    {
            var validatorAttributes = attributes.OfType<ValidatorAttribute>();
            var nonValidatorAttributes = attributes.Except(validatorAttributes);
            List<ValidatorAttribute> validValidatorAttributes = new List<ValidatorAttribute>();

        if (string.IsNullOrEmpty(validationRule))
        {
            validValidatorAttributes.AddRange(validatorAttributes.Where(v => string.IsNullOrEmpty(v.RuleName)));
        }
        else
        {
            var groups = from validator in validatorAttributesgroup validator by validator.GetType();
            foreach (var group in groups)
            {
                ValidatorAttribute validatorAttribute = group.Where(v => string.Compare(v.RuleName, validationRule, true) == 0).FirstOrDefault();
                if (null != validatorAttribute)
                {
                    validValidatorAttributes.Add(validatorAttribute);
                }
                else
                {
                    validatorAttribute = group.Where(v => string.IsNullOrEmpty(v.RuleName)).FirstOrDefault();
                    if (null != validatorAttribute)
                    {
                        validValidatorAttributes.Add(validatorAttribute);
                    }
                }
            }
        }
        return nonValidatorAttributes.Union(validValidatorAttributes);
    }
}

如上面的代碼所示，RuleBasedValidatorProvider繼承自DataAnnotationsModelValidatorProvider，基於當前驗證規則（從當前的Controller上下文中提取）對ValidatorAttribute的篩選，以及ModelValidator的創建通過重寫的GetValidators方法實現。具體的篩選機制是：如果當前的驗證規則存在，則選擇與之具有相同規則名稱的第一個ValidatorAttribute，如果這樣的ValidatorAttribute找不到，則選擇第一個沒有指定驗證規則的ValidatorAttribute；如果當前的驗證規則沒有指定，那么也選擇第一個沒有指定驗證規則的ValidatorAttribute。

在讓我們的Controller繼承自RuleBasedController之后，我們需要在Global.asax中通過如下的方式對自定義的RuleBasedValidatorProvider進行注冊，然后我們的應用就能按照我們期望的方式根據你指定的驗證規則實施Model驗證了。

public class MvcApplication : System.Web.HttpApplication
{
    //其他成員
    protected void Application_Start()
    {
        //其他操作
        DataAnnotationsModelValidatorProvider validator = ModelValidatorProviders.Providers.OfType<DataAnnotationsModelValidatorProvider>().FirstOrDefault();
        if(null != validator)
        {
            ModelValidatorProviders.Providers.Remove(validator);
        }
        ModelValidatorProviders.Providers.Add(new RuleBasedValidatorProvider());
    }
}