ASP.NET MVC下的四种验证编程方式[续篇]

原文:ASP.NET MVC下的四种验证编程方式[续篇]在《ASP.NET MVC下的四种验证编程方式》一文中我们介绍了ASP.NET MVC支持的四种服务端验证的编程方式（“手工验证”、“标注ValidationAttribute特性”、“让数据类型实现IValidatableObject或者IDataErrorInfo”），那么在ASP.NET MVC框架内部是如何提供针对这四种不同编程方式的支持的呢？接下来我们就来聊聊这背后的故事。

一、ModelValidator与ModelValidatorProvider

虽然Model绑定的方式因被验证数据类型的差异而有所不同，但是ASP.NET MVC总是使用一个名为ModelValidator的对象来对绑定的数据对象实施验证。所有的ModelValidator类型均继承自具有如下定义的抽象类ModelValidator。它的GetClientValidationRules方法返回一个元素类型为ModelClientValidationRule的集合，而ModelClientValidationRule是对客户端验证规则的封装，我们会在客户端验证部分对其进行详细介绍。

[code] public abstract class ModelValidator

{

//其他成员

public virtual IEnumerable<ModelClientValidationRule> GetClientValidationRules();

public abstract IEnumerable<ModelValidationResult> Validate(object container);

     public virtual bool IsRequired{ get;}

}

[/code]

针对目标数据的验证是通过调用Validate方法来完成的，该方法的输入参数container表示的正是被验证的对象。正是因为被验证的总是一个复杂类型的对象，后者又被称为一个具有若干数据成员的“容器”对象，所以对应的参数被命名为container。Validate方法表示验证结果的返回值并不是一个简单的布尔值，而是一个元素类型为具有如下定义的ModelValidationResult对象集合。

[code] public class ModelValidationResult

{  

     public string MemberName{ get; set;}

     public string Message{ get; set;}

}

[/code]

ModelValidationResult具有两个字符串类型属性MemberName和Message，前者代表被验证数据成员的名称，后者表示错误消息。一般来说，如果ModelValidationResult对象来源于针对容器对象本身的验证，它的MemberName属性为空字符串。对于针对容器对象某个属性的验证来说，属性名称会作为返回的ModelValidationResult对象的MemberName属性。

ModelValidationResult集合只有在验证失败的情况下才会返回。如果被验证数据对象符合所有的验证规则，Validate方法会直接返回Null或者一个空ModelValidationResult集合。值得一提的是，我们有时候会用ValidationResult的静态只读字段Success表示成功通过验证的结果，实际上该字段的值就是Null。

[code] public class ValidationResult

{

//其他成员

public static readonly ValidationResult Success;

}

[/code]

ModelValidator具有一个布尔类型的只读属性IsRequired表示该ModelValidator是否对目标数据进行“必需性”验证（即被验证的数据成员必须具有一个具体的值），该属性默认返回False。我们可以通过应用RequiredAttribute特性将某个属性定义成“必需”的数据成员。

我们知道ASP.NET MVC大都采用Provider的模式来提供相应的组件，比如描述Model元数据的ModelMetadata通过对应的ModelMetadataProvider来提供，实现Model绑定的ModelBinder则可以通过对应的ModelBinderProvider来提供，用于实现Model验证的ModelValidator也不例外，它对应的提供者为ModelValidatorProvider，对应的类型继承自具有如下定义的抽象类ModelValidator Provider。

[code] public abstract class ModelValidatorProvider

{

public abstract IEnumerable<ModelValidator> GetValidators(ModelMetadata metadata, ControllerContext context);

}

[/code]

如上面的代码片段所示，GetValidators方法具有两个参数，一个是用于描述被验证类型或者属性Model元数据的ModelMetadata对象，另一个是当前ControllerContext。该方法返回的是一个元素类型为ModelValidator的集合。

ASP.NET MVC 通过静态类型ModelValidatorProviders对使用的ModelValidatorProvider进行注册。如下面的代码片段所示，ModelValidatorProviders具有一个静态只读属性Providers，对应的类型为ModelValidatorProviderCollection，它表示基于整个Web应用范围的全局ModelValidatorProvider集合。

[code] 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);

}

[/code]

值得一提的是用于描述Model元数据的ModelMetadata类型具有如下一个GetValidators方法，它返回的ModelValidator列表正是利用注册到ModelValidatorProviders静态属性Providers上的ModelValidatorProvider创建的。

[code] public class ModelMetadata

{

//其他成员

public virtual IEnumerable<ModelValidator> GetValidators(ControllerContext context);

}

[/code]




如右图所示的UML列出了组成Model验证系统的三个核心类型。具体的Model验证工作总是通过某个具体的ModelValidator来完成，作为ModelValidator提供者的ModelValidatorProvider注册在静态类型ModelValidatorProviders之上。

二、DataAnnotationsModelValidator

我们在《ASP.NET MVC下的四种验证编程方式》中介绍了三种不同的“自动化验证”的编程方式，ASP.NET MVC在内部会采用不同的ModelValidator来对绑定的参数实施验证。一个具体的ModelValidator通常有相应的ModelValidatorProvider来提供，接下来的内容中将对ASP.NET MVC提供的原生的ModelValidator和对应的ModelValidatorProvider作详细的介绍。

对于上面提到的这三种验证编程方式，第一种（利用应用在数据类型或其数据成员上的ValidationAttribute特性来定义相应的验证规则）是最为常用的。基于ValidationAttribute特性这种声明式验证解决方案最终通过DataAnnotationsModelValidator来完成。一个DataAnnotationsModelValidator对象实际上是对一个ValidationAttribute特性的封装，这可以从如下所示的定义看出来。

[code] 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;}

}

[/code]

DataAnnotationsModelValidator的提供者为DataAnnotationsModelValidatorProvider,关于ValidationAttribute、DataAnnotationsModelValidator和DataAnnotationsModelValidatorProvider的详细内容可以参考之前写的三篇文章。

ASP.NET MVC基于标注特性的Model验证：ValidationAttribute

ASP.NET MVC基于标注特性的Model验证：DataAnnotationsModelValidator

ASP.NET MVC基于标注特性的Model验证：DataAnnotationsModelValidatorProvider

三、ValidatableObjectAdapter

如果被验证的数据类型实现了IValidatable接口，ASP.NET MVC会自动调用实现的Validate方法对其实施验证，此时创建的ModelValidator是一个ValidatableObjectAdapter对象。ValidatableObjectAdapter定义如下，其Validate方法的实现逻辑很简单：它直接调用被验证对象的Validate方法，并将返回的ValidationResult对象转换成ModelValidationResult类型。

[code] public class ValidatableObjectAdapter : ModelValidator

{

public ValidatableObjectAdapter(ModelMetadata metadata, ControllerContext context);

public override IEnumerable<ModelValidationResult> Validate(object container);

}

[/code]

虽然ValidatableObjectAdapter继承自ModelValidator，但是ASP.NET MVC貌似没有将其视为一个真正意义上的ModelValidator，而是将其视为一个“适配器（Adapter）”。ASP.NET MVC也没有为ValidatableObjectAdapter定义单独的ModelValidatorProvider，它的提供者其实是上面提到过的DataAnnotationsModelValidatorProvider。

四、DataErrorInfoModelValidator

如果我们让数据类型实现IDataErrorInfo接口，可以利用实现的Error属性和索引提供针对自身以及所属数据成员的验证错误信息。针对这样的数据类型，ASP.NET MVC最终会创建一个DataErrorInfoModelValidator对象来对其实施验证，DataErrorInfoClassModelValidator和DataErrorInfoPropertyModelValidator是两个具体的DataErrorInfoModelValidator。

DataErrorInfoClassModelValidator和DataErrorInfoPropertyModelValidator是两个内部类型。前者针对容器对象自身实施验证，所以它只需要从实现的Error属性中提取错误消息并将其转换成返回的ModelValidationResult对象。后者则专门验证容器对象的某个属性，它在实现的Validate方法中会利用属性名从实现的索引中提取相应的错误消息并将其转换成返回的ModelValidationResult对象。

[code] 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);

}

[/code]

ASP.NET MVC最终利用具有如下定义的DataErrorInfoModelValidatorProvider来提供这两种类型的DataErrorInfoModelValidator。对于其实现的GetValidators方法来说，如果被验证对象的类型实现了IDataErrorInfo接口，它会创建一个DataErrorInfoClassModelValidator对象并添加到返回的ModelValidator列表中。如果被验证的是容器类型的某个属性值并且容器类型实现了IDataErrorInfo接口，它会创建一个DataErrorInfoPropertyModelValidator对象并添加到返回的ModelValidator列表中。

[code] public class DataErrorInfoModelValidatorProvider : ModelValidatorProvider

{

public override IEnumerable<ModelValidator> GetValidators(ModelMetadata metadata, ControllerContext context);

}

[/code]