ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidator
2012-06-01 08:06
1011 查看
旨在为目标Action方法的执行绑定输入参数的Model绑定过程伴随着对Model的验证。借助相应的验证特性,我们可以直接以声明的方式在Model类型上定义验证规则,这些规则将会作为Model元数据的一部分。具体在Model绑定过程中,ModelBinder通过ValueProvider为Model对象的某个属性提供相应属性值之后,会根据定义在基于该属性的Model元数据的验证规则实施验证。ASP.NET MVC的整个Model验证系统以组件ModelValidator为核心,或者说Model对象的验证最终通过某个ModelValidator对象来完成,所以我们有必要先来认识一下ModelValidator以及背后的提供机制。[本文已经同步到《How ASP.NET MVC Works?》中]
[/code]
真正对目标数据实施验证是通过调用Validate方法来完成的,而该方法的输入参数container表示的正式被验证的对象。该Validate返回一个表示验证结果的元素类型为ModelValidationResult的集合,该类型的定义如下所示。
[/code]
ModelValidationResult具有两个字符串类型的属性MemberName和Message,前者代表被验证数据成员的名称,后者表示错误消息。一般来说,当它们用于验证某个复杂类型对象的时候,针对于类型本身验证返回的ModelValidationResult对象的MemberName属性为空字符串;而对于针对属性验证来说,属性名称直接作为MemberName属性值。
ModelClientValidationRule集合只有在验证失败的情况下才会返回。如果目标数据符合所有的验证规则,Validate方法会直接返回Null或者一个空ModelValidationResult集合。值得一提的是,我们在调用ModelValidator的Validate方法确定目标数据是否通过验证时,有时候会将方法返回值和定义在类型ValidationResult中具有如下定义的静态只读字段Success进行比较。实际上,表示验证成功的Success字段值就是Null。
[/code]
[/code]
由于ClientModelValidator仅限于客户端验证,其Validate方法(服务端验证)总是返回一个空的ModelValidationResult集合,而GetClientValidationRules方法会根据指定的验证类型和错误消息生成相应的客户端验证规则。
ClientModelValidator具有两个继承者,分别是数值类型和日期类型进行客户端验证的NumericModelValidator和DateModelValidator。如下面的代码片断所示,这两个ClientModelValidator用于表示验证数据类型的字符串分别是“number”和“date”。而表示错误消息的字符串是从内部维护的资源文件中获取的。这实际上带来了一个问题,我们无法对错误消息进行定制。
[/code]
[/code]
ASP.NET MVC的Model验证系统为实现了IDataErrorInfo接口的数据对象的验证定义专门的ModelValidator。具体来说,对于一个类型实现了IDataErrorInfo接口的数据对象,我们可以通过DataErrorInfoClassModelValidator对该对象本身实施验证,DataErrorInfoClassModelValidator会将Error属性表示的错误消息转换为表示验证结果的ModelValidationResult对象。而对于该对象的属性的验证则采用另一个类型为DataErrorInfoPropertyModelValidator对象,DataErrorInfoPropertyModelValidator会将属性名称作为调用索引的参数从而获得相应的错误消息,并进一步转换成ModelValidationResult对象返回。DataErrorInfoPropertyModelValidator和DataErrorInfoPropertyModelValidator都是定义在程序集System.Web.Mvc.dll中的内部类型,并不对外公布。
[/code]
ASP.NET Model验证系统定义了专门的ModelValidator来验证种实现了IValidatableObject接口的数据对象,其类型为ValidatableObjectAdapter。由于被验证本身已经将验证实现在了Validate方法中,所以ValidatableObjectAdapter只需要调用该方法并将验证结果从ValidationResult类型转换成ModelValidationResult类型即可。
[/code]
ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidator
ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProvider
ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProviders
目录
一、ModelValidator
二、DataAnnotationsModelValidator
三、ClientModelValidator
四、DataErrorInfoModelValidator
五、ValidatableObjectAdapter
一、ModelValidator
二、DataAnnotationsModelValidator
三、ClientModelValidator
四、DataErrorInfoModelValidator
五、ValidatableObjectAdapter
一、ModelValidator
在ASP.NET MVC应用编程接口中,所有的ModelValidator都直接或者间接地继承自抽象类型ModelValidator。如下面的代码片断所示,ModelValidator具有一个布尔类型的只读属性IsRequired,表示该ModelValidator是否是对目标数据进行必要性的验证,默认返回False。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表示的正式被验证的对象。该Validate返回一个表示验证结果的元素类型为ModelValidationResult的集合,该类型的定义如下所示。
[code] public class ModelValidationResult { public ModelValidationResult(); public string MemberName { get; set; } public string Message { get; set; } }
[/code]
ModelValidationResult具有两个字符串类型的属性MemberName和Message,前者代表被验证数据成员的名称,后者表示错误消息。一般来说,当它们用于验证某个复杂类型对象的时候,针对于类型本身验证返回的ModelValidationResult对象的MemberName属性为空字符串;而对于针对属性验证来说,属性名称直接作为MemberName属性值。
ModelClientValidationRule集合只有在验证失败的情况下才会返回。如果目标数据符合所有的验证规则,Validate方法会直接返回Null或者一个空ModelValidationResult集合。值得一提的是,我们在调用ModelValidator的Validate方法确定目标数据是否通过验证时,有时候会将方法返回值和定义在类型ValidationResult中具有如下定义的静态只读字段Success进行比较。实际上,表示验证成功的Success字段值就是Null。
[code] public class ValidationResult { //其他成员 public static readonly ValidationResult Success; }
[/code]
二、DataAnnotationsModelValidator
稍微了解ASP.NET MVC的读者应该知道,我们可以通过数据类型的某个属性上应用相应的验证标注特性(比如RequiredAttribute、RangeAttribute和RegularExpressionAttribute等)的方式来定义相应的验证规则,这是ASP.NET MVC 提供的默认Model验证方式。这种基于数据标注(Data Annotation)特性的验证对应的ModelValidator类型为DataAnnotationsModelValidator,我们会在后续的文章中对其进行单独介绍。三、ClientModelValidator
ClientModelValidator是定义在程序集System.Web.Mvc.dll中的内部类型,在客户端用于数据类型的验证。如下面的代码片断所示,在构造函数中除了指定Model元数据和Controller上下文之外,还需要以字符串的形式指定验证类型(数据类型)和错误消息。[code] internal class ClientModelValidator : ModelValidator { public ClientModelValidator(ModelMetadata metadata, ControllerContext controllerContext, string validationType,string errorMessage); public sealed override IEnumerable<ModelClientValidationRule> GetClientValidationRules(); public sealed override IEnumerable<ModelValidationResult> Validate(object container); }
[/code]
由于ClientModelValidator仅限于客户端验证,其Validate方法(服务端验证)总是返回一个空的ModelValidationResult集合,而GetClientValidationRules方法会根据指定的验证类型和错误消息生成相应的客户端验证规则。
ClientModelValidator具有两个继承者,分别是数值类型和日期类型进行客户端验证的NumericModelValidator和DateModelValidator。如下面的代码片断所示,这两个ClientModelValidator用于表示验证数据类型的字符串分别是“number”和“date”。而表示错误消息的字符串是从内部维护的资源文件中获取的。这实际上带来了一个问题,我们无法对错误消息进行定制。
[code] internal sealed class NumericModelValidator :ClientModelValidator { public NumericModelValidator(ModelMetadata metadata, ControllerContext controllerContext) : base(metadata, controllerContext, "number", ClientDataTypeModelValidatorProvider.GetFieldMustBeNumericResource(controllerContext)) { } } internal sealed class DateModelValidator :ClientModelValidator { public DateModelValidator(ModelMetadata metadata, ControllerContext controllerContext) : base(metadata, controllerContext, "date", ClientDataTypeModelValidatorProvider.GetFieldMustBeDateResource(controllerContext)) { } }
[/code]
四、DataErrorInfoModelValidator
在System.ComponentModel命名空间下定义了一个名为IDataErrorInfo的接口,该接口提供了一种标准的错误信息定制方式。如下面的代码片断所示,IDataErrorInfo具有两个成员,只读属性Error用于获取基于自身的错误消息,而只读索引用于返回指定数据成员的错误消息。[code] public interface IDataErrorInfo { string Error { get; } string this[string columnName] { get; } }
[/code]
ASP.NET MVC的Model验证系统为实现了IDataErrorInfo接口的数据对象的验证定义专门的ModelValidator。具体来说,对于一个类型实现了IDataErrorInfo接口的数据对象,我们可以通过DataErrorInfoClassModelValidator对该对象本身实施验证,DataErrorInfoClassModelValidator会将Error属性表示的错误消息转换为表示验证结果的ModelValidationResult对象。而对于该对象的属性的验证则采用另一个类型为DataErrorInfoPropertyModelValidator对象,DataErrorInfoPropertyModelValidator会将属性名称作为调用索引的参数从而获得相应的错误消息,并进一步转换成ModelValidationResult对象返回。DataErrorInfoPropertyModelValidator和DataErrorInfoPropertyModelValidator都是定义在程序集System.Web.Mvc.dll中的内部类型,并不对外公布。
五、ValidatableObjectAdapter
在System.ComponentModel.DataAnnotations命名空间下定义了一个IValidatableObject接口,它代表另外一种验证的模式,我个人将其称为“自我验证”,即数据对象自行实现针对自身的验证。如下面的代码片断所示,针对自身的验证实现在IValidatableObject的Validate方法中。[code] public interface IValidatableObject { IEnumerable<ValidationResult> Validate(ValidationContext validationContext); }
[/code]
ASP.NET Model验证系统定义了专门的ModelValidator来验证种实现了IValidatableObject接口的数据对象,其类型为ValidatableObjectAdapter。由于被验证本身已经将验证实现在了Validate方法中,所以ValidatableObjectAdapter只需要调用该方法并将验证结果从ValidationResult类型转换成ModelValidationResult类型即可。
[code] public class ValidatableObjectAdapter : ModelValidator { public ValidatableObjectAdapter(ModelMetadata metadata, ControllerContext context); public override IEnumerable<ModelValidationResult> Validate(object container); }
[/code]
ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidator
ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProvider
ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProviders
相关文章推荐
- ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProviders
- ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProvider
- ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProviders
- ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidator
- ASP.NET MVC以ModelValidator为核心的Model验证体系: ModelValidatorProvider
- ASP.NET MVC基于标注特性的Model验证:DataAnnotationsModelValidator
- asp.net mvc源码分析-ModelValidatorProviders 客户端的验证
- ASP.NET MVC基于标注特性的Model验证:DataAnnotationsModelValidatorProvider
- ASP.NET MVC基于标注特性的Model验证:DataAnnotationsModelValidator
- ASP.NET MVC基于标注特性的Model验证:DataAnnotationsModelValidatorProvider
- ASP.NET MVC 3 —— Model远程验证
- 菜鸟入门【ASP.NET Core】15:MVC开发:ReturnUrl实现、Model后端验证 、Model前端验证
- 【原创】Asp.Net MVC 学习笔记之-使用Model验证
- 一起谈.NET技术,ASP.NET MVC中对Model进行分步验证的解决方法
- ASP.NET MVC:如何提供 Controller 继承体系使用的 ModelBinder?
- Asp.net MVC 通过Attribute验证datamodel(二) ---使用IClientValidatable
- ASP.NET MVC Model验证(五)
- ASP.NET MVC基于标注特性的Model验证:将ValidationAttribute应用到参数上
- 【转载】ASP.NET MVC 3 —— Model远程验证
- asp.net mvc源码分析-DefaultModelBinder 自定义的普通数据类型的绑定和验证