通过扩展改善ASP.NET MVC的验证机制[实现篇]

在《使用篇》中我们谈到扩展的验证编程方式，并且演示了本解决方案的三大特性：消息提供机制的分离、多语言的支持和多验证规则的支持，我们现在来看看这样的验证解决方案最终是如何实现的。

目录：
一、为验证创建一个上下文：ValidatorContext
二、通过自定义ActionInvoker在进行操作执行之前初始化上下文
三、为Validator创建基类:ValidatorBaseAttribute
四、通过自定义ModelValidatorProvider在验证之前将不匹配Validator移除
五、RequiredValidatorAttribute的定义

一、为验证创建一个上下文：ValidatorContext

“基于某个规则的验证”是本解决方案一个最大的卖点。为了保持以验证规则名称为核心的上下文信息，我定义了如下一个ValidatorContext（我们本打算将其命名为ValidationContext，无奈这个类型已经存在）。ValidatorContext的属性RuleName和Culture表示当前的验证规则和语言文化（默认值为当前线程的CurrentUICulture），而字典类型的属性Properties用户存放一些额外信息。当前ValidationContext的获取与设置通过静态Current完成。

public class ValidatorContext
{
    [ThreadStatic]
    private static ValidatorContext current;

    public string RuleName { get; private set; }
    public CultureInfo Culture { get; private set; }
    public IDictionary<string, object> Properties { get; private set; }

    public ValidatorContext(string ruleName, CultureInfo culture=null)
    {
        this.RuleName = ruleName;
        this.Properties = new Dictionary<string, object>();
        this.Culture = culture??CultureInfo.CurrentUICulture;
    }

    public static ValidatorContext Current
    {
        get { return current; }
        set { current = value; }
    }
}

我们为ValidatorContext定义了如下一个匹配的ValidatorContextScope对象用于设置ValidatorContext的作用范围。

public class ValidatorContextScope : IDisposable
{
    private ValidatorContext current = ValidatorContext.Current;
    public ValidatorContextScope(string ruleName, CultureInfo culture = null)
    {
        ValidatorContext.Current = new ValidatorContext(ruleName, culture);
    }
    public void Dispose()
    {
        if (null == current)
        {
            foreach (object property in ValidatorContext.Current.Properties.Values)
            {
                IDisposable disposable = property as IDisposable;
                if (null != disposable)
                {
                    disposable.Dispose();
                }
            }
        }
        ValidatorContext.Current = current;
    }
}

二、通过自定义ActionInvoker在进行操作执行之前初始化上下文

通过《使用篇》中我们知道当前的验证规则名称是通过ValidationRuleAttribute来设置的，该特性不仅仅可以应用在Action方法上，也可以应用在Controller类型上。当然Action方法上的ValidationRuleAttribute具有更高的优先级。如下面的代码片断所示，ValidationRuleAttribute就是一个包含Name属性的普通Attribute而已。

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

很显然，以当前验证规则验证规则为核心的ValidatorContext需要在Action操作之前设置（严格地说应该在进行Model绑定之前），而在Action操作完成后清除。很自然地，我们可以通过自定义ActionInvoker来完成，为此我定义了如下一个直接继承自ControllerActionInvoker的ExtendedControllerActionInvoker类。

public class ExtendedControllerActionInvoker : ControllerActionInvoker
{
    public ExtendedControllerActionInvoker()
    {
        this.CurrentCultureAccessor= (context=>
            {
                string culture = context.RouteData.GetRequiredString("culture");
                if(string.IsNullOrEmpty(culture))
                {
                    return null;
                }
                else
                {
                    return new CultureInfo(culture);
                }
            });
    }
    public virtual Func<ControllerContext, CultureInfo> CurrentCultureAccessor { get; set; }
    public override bool InvokeAction(ControllerContext controllerContext, string actionName)
    {
        CultureInfo originalCulture = CultureInfo.CurrentCulture;
        CultureInfo originalUICulture = CultureInfo.CurrentUICulture;
        try
        {
            CultureInfo culture = this.CurrentCultureAccessor(controllerContext);
            if (null != culture)
            {
                Thread.CurrentThread.CurrentCulture = culture;
                Thread.CurrentThread.CurrentUICulture = culture;
            }
            var controllerDescriptor = this.GetControllerDescriptor(controllerContext);
            var actionDescriptor = this.FindAction(controllerContext, controllerDescriptor, actionName);
            ValidationRuleAttribute attribute = actionDescriptor.GetCustomAttributes(true).OfType<ValidationRuleAttribute>().FirstOrDefault() as ValidationRuleAttribute;
            if (null == attribute)
            {
                attribute = controllerDescriptor.GetCustomAttributes(true).OfType<ValidationRuleAttribute>().FirstOrDefault() as ValidationRuleAttribute;
            }
            string ruleName = (null == attribute) ? string.Empty : attribute.Name;
            using (ValidatorContextScope contextScope = new ValidatorContextScope(ruleName))
            {
                return base.InvokeAction(controllerContext, actionName);
            }
        }
        catch
        {
            throw;
        }
        finally
        {
            Thread.CurrentThread.CurrentCulture = originalCulture;
            Thread.CurrentThread.CurrentUICulture = originalUICulture;
        }
    }
}

如上面的代码片断所示，在重写的InvokeAction方法中我们通过ControllerDescriptor/ActionDescriptor得到应用在Controller类型/Action方法上的ValidationRuleAttribute特性，并或者到设置的验证规则名称。然后我们创建ValidatorContextScope对象，而针对基类InvokeAction方法的执行就在该ValidatorContextScope中执行的。初次之外，我们还对当前线程的Culture进行了相应地设置，默认的Culture 信息来源于当前RouteData。

为了更方便地使用ExtendedControllerActionInvoker，我们定义了一个抽象的Controller基类：BaseController。BaseController是Controller的子类，在构造函数中我们将ActionInvoker属性设置成我们自定义的ExtendedControllerActionInvoker对象。

public abstract class BaseController: Controller
{
    public BaseController()
    {
        this.ActionInvoker = new ExtendedControllerActionInvoker();
    }
}

三、为Validator创建基类:ValidatorBaseAttribute

接下来我们才来看看真正用于验证的验证特性如何定义。我们的验证特性都直接或者间接地继承自具有如下定义的ValidatorBaseAttribute，而它使ValidationAttribute的子类。如下面的代码片断所示，ValidatorBaseAttribute还实现了IClientValidatable接口，以提供对客户端验证的支持。属性RuleName、MessageCategory、MessageId和Culture分别代表验证规则名称、错误消息的类别和ID号（通过这两个属性通过MessageManager这个独立的组件获取完整的错误消息）和基于的语言文化。

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false)]
public abstract class ValidatorBaseAttribute : ValidationAttribute, IClientValidatable
{

    public string RuleName { get; set; }
    public string MessageCategory { get; private set; }
    public string MessageId { get; private set; }
    public string Culture { get; set; }

    public ValidatorBaseAttribute(MessageManager messageManager, string messageCategory, string messageId, params object[] args)
        : base(() => messageManager.FormatMessage(messageCategory, messageId, args))
    {
        this.MessageCategory = messageCategory;
        this.MessageId = messageId;
    }

    public ValidatorBaseAttribute(string messageCategory, string messageId, params object[] args)
        : this(MessageManagerFactory.GetMessageManager(), messageCategory, messageId, args)
    { }

    public virtual bool Match(ValidatorContext context, IEnumerable<ValidatorBaseAttribute> validators)
    {
        if (!string.IsNullOrEmpty(this.RuleName))
        {
            if (this.RuleName != context.RuleName)
            {
                return false;
            }
        }

        if (!string.IsNullOrEmpty(this.Culture))
        {
            if (string.Compare(this.Culture, context.Culture.Name, true) != 0)
            {
                return false;
            }
        }

        if (string.IsNullOrEmpty(this.Culture))
        {
            if (validators.Any(validator => validator.GetType() == this.GetType() && string.Compare(validator.Culture, context.Culture.Name, true) == 0))
            {
                return false;
            }
        }
        return true;
    }
    public abstract IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context);
    private object typeId;
    public override object TypeId
    {
        get { return (null == typeId) ? (typeId = new object()) : typeId; }
    }
}

由于我们需要将多个相同类型的Validator特性应用到某个类型或者字段/属性上，我们需要通过AttributeUsageAttribute将AllowMultiple属性设置为True，此外需要重写TypeId属性。至于为什么需需要这么做，可以参考我的上一篇文章《在ASP.NET MVC中如何应用多个相同类型的ValidationAttribute？》。对于应用在同一个目标元素的多个相同类型的Validator特性，只有与当前ValidatorContext相匹配的才能执行，我们通过Match方法来进行匹配性的判断，具体的逻辑是这样的：

• 在显式设置了RuleName属性情况下，如果不等于当前验证规则，直接返回False；
• 在显式设置了Culture属性情况下，如果与当前语言文化不一致，直接返回False；
• 在没有设置Culture属性（语言文化中性）情况下，如果存在另一个同类型的Validator与当前的语言文化一致，也返回False；
• 其余情况返回True

四、通过自定义ModelValidatorProvider在验证之前将不匹配Validator移除

应用在Model类型或其属性/字段上的ValidationAttribute最终通过对应的ModelValidatorProvider（DataAnnotationsModelValidatorProvider）用于创建ModelValidator（DataAnnotationsModelValidator）。我们必须在ModelValidator创建之前将不匹配的Validator特性移除，才能确保只有与当前ValidatorContext相匹配的Validator特性参与验证。为此我们通过继承DataAnnotationsModelValidator自定义了如下一个ExtendedDataAnnotationsModelValidator。

public class ExtendedDataAnnotationsModelValidatorProvider : DataAnnotationsModelValidatorProvider
{
    protected override IEnumerable<ModelValidator> GetValidators(ModelMetadata metadata, ControllerContext context, IEnumerable<Attribute> attributes)
    {
        var validators = attributes.OfType<ValidatorBaseAttribute>();
        var allAttributes = attributes.Except(validators).ToList();
        foreach (ValidatorBaseAttribute validator in validators)
        {
            if (validator.Match(ValidatorContext.Current, validators))
            {
                allAttributes.Add(validator);
            }
        }
        return base.GetValidators(metadata, context, allAttributes);
    }
}

如上面的代码片断所示，在重写的GetClientValidationRules方法中，输入参数attributes表示所有的ValidationAttribute，在这里我们根据调用ValidatorBaseAttribute的Match方法将不匹配的Validator特性移除，然后根据余下的ValidationAttribute列表调用基类GetValidators方法创建ModelValidator列表。值得一提的是，关于System.Attribute的Equals/GetHashCode方法的问题就从这个方法中发现的（详情参见《为什么System.Attribute的GetHashCode方法需要如此设计？》）。自定义ExtendedDataAnnotationsModelValidator在Global.asax的Application_Start方法中通过如下的方式进行注册。

protected void Application_Start()
{
     //...
    var provider = ModelValidatorProviders.Providers.OfType<DataAnnotationsModelValidatorProvider>().FirstOrDefault();
    if (null != provider)
    {
        ModelValidatorProviders.Providers.Remove(provider);
    }
    ModelValidatorProviders.Providers.Add(new ExtendedDataAnnotationsModelValidatorProvider());
}

五、RequiredValidatorAttribute的定义

最后我们来看看用于验证必需字段的RequiredValidatorAttribute如何定义。IsValid用于服务端验证，而GetClientValidationRules生成调用客户端验证规则。

[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = true)]
public class RequiredValidatorAttribute : ValidatorBaseAttribute
{
    public RequiredValidatorAttribute(string messageCategory, string messageId, params object[] args)
        : base(messageCategory, messageId, args)
    { }

    public override bool IsValid(object value)
    {
        if (value == null)
        {
            return false;
        }
        string str = value as string;
        if (str != null)
        {
            return (str.Trim().Length != 0);
        }
        return true;
    }

    public override IEnumerable<ModelClientValidationRule> GetClientValidationRules(ModelMetadata metadata, ControllerContext context)
    {
        return new ModelClientValidationRequiredRule[] { new ModelClientValidationRequiredRule(this.ErrorMessageString) };
    }
}