Pro ASP.NET MVC 3 Framework 读书笔记之数据校验

MVC3.0中提供了丰富的Model数据校验，这对于数据开发是非常方便，校验按实现方式来分，有如下几类：

1. 在controller中进行校验
2. 在Model上的属性的元数据上面加入验证逻辑
3. ModelBinder上进行校验，并可以自定义属性进行验证
4. Model自校验
5. 自定义ValidateProvider进行校验
6. 手动进行数据校验
7. 远程校验（Ajax进行校验）

从客户端和服务端来分：

1，2，3，4，5，7属于服务端校验；

2，6属于客户端校验

1、在Controller进行校验

这是一种最直接的实现方式

示例代码如下：

[HttpPost]
public ViewResult MakeBooking(Appointment appt) {
    if (string.IsNullOrEmpty(appt.ClientName)) {
        ModelState.AddModelError("ClientName", "Please enter your name");
    }
    if (ModelState.IsValidField("Date") && DateTime.Now > appt.Date) {
        ModelState.AddModelError("Date", "Please enter a date in the future");
    }
    if (!appt.TermsAccepted) {
        ModelState.AddModelError("TermsAccepted", "You must accept the terms");
    }
    if (ModelState.IsValid) {
        repository.SaveAppointment(appt);
        return View("Completed", appt);
    } else {
        return View();
    }
}

通过上面的代码把出错信息设置Controller中ModelState中，这样就可以通过判断ModelState.IsValid进行验证Model是否通过验证,上面的代码演示,如果通过验证,就返回保存成功的视图,如果失败就刷新当前页面,并显示错误信息.

2、在Model上的属性的元数据上面加入验证逻辑

在属性的元数据上面加入验证逻辑，这是一种使用比较多方式，在最早的Winform也很多的使用这种方式进行校验，这种方式不是MVC特有的方式，同时还提供了对客户端校验的支持（这种支持不知道是不是在MVC中加入的），很好的实现客户端和服务端同时进行校验的问题。

这种实现的示例如下所示：

public class Appointment {
       [Required]
       public string ClientName { get; set; }
       [DataType(DataType.Date)]
       [Required(ErrorMessage="Please enter a date")]
       public DateTime Date { get; set; }
       [Range(typeof(bool), "true", "true", ErrorMessage="You must accept the terms")]
       public bool TermsAccepted { get; set; }
   }

系统定义的属性有：

属性	示例	备注
Compare	[Conmpre(“其他属性”)]
Range	[Range(10,20)]
RegularExpression	[RegularExpression(“pattern”)]
Required	[Required]
StringLength	[StringLength(10)]

同时，我们还可以自定义校验属性，并加到Model属性或其自身上，示例属性如下：

public class MustBeTrueAttribute : ValidationAttribute {
    public override bool IsValid(object value) {
        return value is bool && (bool)value;
    }
}

public class FutureDateAttribute : RequiredAttribute {
    public override bool IsValid(object value) {
        return base.IsValid(value) &&
            value is DateTime &&
            ((DateTime)value) > DateTime.Now;
    }
}
public class AppointmentValidatorAttribute : ValidationAttribute {
    public AppointmentValidatorAttribute() {
        ErrorMessage = "Joe cannot book appointments on Mondays";
    }
public override bool IsValid(object value) {
       Appointment app = value as Appointment;
       if (app == null || string.IsNullOrEmpty(app.ClientName) || app.Date == null) {
           // we don't have a model of the right type to validate, or we don't have
           // the values for the ClientName and Date properties we require
           return true;
       } else {
           return !(app.ClientName == "Joe" && app.Date.DayOfWeek == DayOfWeek.Monday);
       }
   }

如果自定义属性实现了接口：

就会自动实现客户端校验。

3、ModelBinder上进行校验，并可以自定义属性进行验证

DefaultModelBinder实现了基本数据校验功能，在客户端提交数据到服务端后，默认ModelBinder会自动从表单中解析出相应属性并给相应的Model属性赋值，同时会自动调用属性的校验设置，如果要统一实现数据校验，可以通过继承“DefaultModelBinder”来实现自定义的通用校验，我们只需要重写此类的两个方法，如下表所示：

方法	描述	默认实现
OnModelUpdate	当ModelBinder要试着把所有属性赋值给实体时，会自动调用。	通过自动调用元数据设置进行校验，并把校验错误写入到ModelState中。
SetProperty	当ModelBinder要给指定属性进行赋值时，就就会自动调用此方法 。	如果要设置的变量值为null或没有变量进行赋值，就会在ModelState中注册“The <name> field is required”错误信息；如果变量值不能被解析，就会在ModelState中注册出错信息“The value <value> is not valid for <name>”

示例如下：

public class ValidatingModelBinder : DefaultModelBinder {
       protected override void SetProperty(ControllerContext controllerContext,
           ModelBindingContext bindingContext, PropertyDescriptor propertyDescriptor,
           object value) {
           // make sure we call the base implementation
           base.SetProperty(controllerContext, bindingContext, propertyDescriptor, value);
           // perform our property-level validation
           switch (propertyDescriptor.Name) {
               case "ClientName":
                   if (string.IsNullOrEmpty((string)value)) {
                       bindingContext.ModelState.AddModelError("ClientName",
                           "Please enter your name");
                   }
                   break;
               case "Date":
                   if (bindingContext.ModelState.IsValidField("Date") &&
                       DateTime.Now > ((DateTime)value)) {
                       bindingContext.ModelState.AddModelError("Date",
                           "Please enter a date in the future");
                   }
                   break;
               case "TermsAccepted":
                   if (!((bool)value)) {
                       bindingContext.ModelState.AddModelError("TermsAccepted",
                           "You must accept the terms");
                   }
                   break;
           }
       }
       protected override void OnModelUpdated(ControllerContext controllerContext,
           ModelBindingContext bindingContext) {
           // make sure we call the base implementation
           base.OnModelUpdated(controllerContext, bindingContext);
           // get the model
           Appointment model = bindingContext.Model as Appointment;
// apply our model-level validation
            if (model != null &&
                bindingContext.ModelState.IsValidField("ClientName") &&
                bindingContext.ModelState.IsValidField("Date") &&
                model.ClientName == "Joe" &&
                model.Date.DayOfWeek == DayOfWeek.Monday) {
                bindingContext.ModelState.AddModelError("",
                    "Joe cannot book appointments on Mondays");
            }
        }
    }
}

自定义的ModelBinder安装方法如下：

protected void Application_Start() {
    AreaRegistration.RegisterAllAreas();
    ModelBinders.Binders.Add(typeof(Appointment), new ValidatingModelBinder());
    RegisterGlobalFilters(GlobalFilters.Filters);
    RegisterRoutes(RouteTable.Routes);
}

注册方法，是对指定的类型进行设置指定的ModelBinder.

4、在Model上面实现校验接口

实现自校验的Model，就要Model实现接口：这个接口只有一个方法，

当ModelBinder赋值给Model每个属性时，会自动调用这个接口进行数据校验

示例代码如下：

public class Appointment : IValidatableObject {
    public string ClientName { get; set; }
    [DataType(DataType.Date)]
    public DateTime Date { get; set; }
    public bool TermsAccepted { get; set; }
    public IEnumerable<ValidationResult> Validate(ValidationContext validationContext) {
        List<ValidationResult> errors = new List<ValidationResult>();
        if (string.IsNullOrEmpty(ClientName)) {
            errors.Add(new ValidationResult("Please enter your name"));
       }
        if (DateTime.Now > Date) {
            errors.Add(new ValidationResult("Please enter a date in the future"));
        }
        if (errors.Count == 0 && ClientName == "Joe"
            && Date.DayOfWeek == DayOfWeek.Monday) {
            errors.Add(new ValidationResult("Joe cannot book appointments on Mondays"));
        }
        if (!TermsAccepted) {
            errors.Add(new ValidationResult("You must accept the terms"));
        }
        return errors;
    }
}

5、自定义ValidateProvider进行校验

自定义ValidateProvider，通常都是从“ ModelValidationProvider ”继承并重载方法“GetValidators”来实现，接口签名如下：

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

这个方法由Model的每个属性调用一次，再Model自身调用一次，如果不对Model进行校验，可以返回“Enumerable.Empty<ModelValidator>()”

接口参数“ModelMetadata metadata”关键属性说明如下：

属性	描述
ContainerType	属性类型
PropertyName	属性名称
ModelType	Model类型

示例代码如下：

public class CustomValidationProvider : ModelValidatorProvider {
    public override IEnumerable<ModelValidator> GetValidators(ModelMetadata metadata,
        ControllerContext context) {
if (metadata.ContainerType == typeof(Appointment)) {
           return new ModelValidator[] {
           new AppointmentPropertyValidator(metadata, context)
       };
       } else if (metadata.ModelType == typeof(Appointment)) {
           return new ModelValidator[] {
           new AppointmentValidator(metadata, context)
       };
       }
       return Enumerable.Empty<ModelValidator>();
   }

public class AppointmentPropertyValidator : ModelValidator {
    public AppointmentPropertyValidator(ModelMetadata metadata, ControllerContext context)
        : base(metadata, context) {
    }
    public override IEnumerable<ModelValidationResult> Validate(object container) {
        Appointment appt = container as Appointment;
        if (appt != null) {
            switch (Metadata.PropertyName) {
                case "ClientName":
                    if (string.IsNullOrEmpty(appt.ClientName)) {
                        return new ModelValidationResult[] {
                        new ModelValidationResult {
                            MemberName = "ClientName",
                            Message = "Please enter your name"
                        }};
                    }
                    break;
                case "Date":
                    if (appt.Date == null || DateTime.Now > appt.Date) {
                        return new ModelValidationResult[] {
                        new ModelValidationResult {
                        MemberName = "Date",
                        Message = "Please enter a date in the future"
                    }};
                    }
break;
               case "TermsAccepted":
                   if (!appt.TermsAccepted) {
                       return new ModelValidationResult[] {
                       new ModelValidationResult {
                           MemberName = "TermsAccepted",
                           Message = "You must accept the terms"
                       }};
                   }
                   break;
           }
       }
       return Enumerable.Empty<ModelValidationResult>();
   }
public class AppointmentValidator : ModelValidatorCustomValidator<Appointment> {
    public AppointmentValidator(ModelMetadata metadata, ControllerContext context)
        : base(metadata, context) {
    }
    public override void Validate(Appointment container,
        IList<ModelValidationResult> errors) {
        Appointment appt = (Appointment)Metadata.Model;
        if (appt.ClientName == "Joe" && appt.Date.DayOfWeek == DayOfWeek.Monday) {
            errors.Add(new ModelValidationResult {
                MemberName = "",
                Message = "Joe cannot book appointments on Mondays"
            });
        }
    }
}

注册方法:

protected void Application_Start() {
    AreaRegistration.RegisterAllAreas();
    ModelValidatorProviders.Providers.Add(new CustomValidationProvider());
    RegisterGlobalFilters(GlobalFilters.Filters);
    RegisterRoutes(RouteTable.Routes);
}

7、远程校验

远程校验通过Ajax调用Controller的Action来实现

样例Action如下：

public JsonResult ValidateDate(string Date) {
        DateTime parsedDate;
        if (!DateTime.TryParse(Date, out parsedDate)) {
            return Json("Please enter a valid date (mm/dd/yyyy)",
                JsonRequestBehavior.AllowGet);
        } else if (DateTime.Now > parsedDate) {
            return Json("Please enter a date in the future", JsonRequestBehavior.AllowGet);
        } else {
            return Json(true, JsonRequestBehavior.AllowGet);
        }
    }

注:所有代码都来源于（仅仅作样例）：