MVC3项目总结

1.验证 Validation

多样化验证规则

最常见的验证方式是:在实体的属性上加 特性(Attribute) 的方式来完成基本的数据验证. 比如 Required, StringLength, Range 等. 为了保持实体类的POCO ( Plain Old CLR Objects, 所谓的POCO就是那些不包括INSERT、ADD、DEL等数据持久化操作的以及不包括任何业务逻辑功能的原始类。只包含最基本的GETTER 和SETTER).,一般是对实体类声明一个伴随类(MetadataTypeAttribute),在伴随类里声明各种特性.但是伴随类只能声明一个(可以尝试对实体类加多个 MetadataType 看看).

实际情况下, 不同的系统可能要求不一样的验证规则,但是又用的是同一套实体.

比如旅客信息的邮件地址,电话号码等, 在线下系统下是非必填的,但是在线上预订的时候,又是必填的. 你可以定意两个不同的实体. 我采用的是另外一种方法:

先声明一个伴随类:

 
 
 
 

  
  
  
  
public class EContactMetadata {  
  
  
  
  
 
  
  
  
  
[RegularExpression(@"\d{8}" , ErrorMessage = "請輸入8位有效的號碼")]  
  
  
  
  
 
  
  
  
  
[Required]  
  
  
  
  
 
  
  
  
  
public object PhoneNo1 { get; set; }  
  
  
  
  
 
  
  
  
  
}  
 
 
 
 

在 Global 里把这个伴随类注册到实体类上:

 
 
 
 

  
  
  
  
protected void Application_Start() {  
  
  
  
  
 
  
  
  
  
…  
  
  
  
  
 
  
  
  
  
TypeDescriptor.AddProviderTransparent(new AssociatedMetadataTypeTypeDescriptionProvider(typeof(EContact) , typeof(EContactMetadata)) , typeof(EContact));  
  
  
  
  
 
  
  
  
  
…  
  
  
  
  
 
  
  
  
  
}  
 
 
 
 

用这种方式可以对同一个实体类添加多个伴随类,后注册的会覆盖先注册的.没有发生覆盖的会保留.

部分验证

某个实体类的属性对应到数据库里的某个字段是必填的,但是在填写界面里,又用不到这个字段,而且这个字段暂时也没有办法生成.

比如旅客信息的 OrderNo 是必填的,但是在填写信息页面, OrderNo 还没有生成. 所以在 Action 里, ModelState.IsValid 一直是 false. 为了避免这个 false, 你可以新定义一个类, 但是又不能每一种变化都搞个类出来吧.

使用 BindAttribute 接合 ModelBinder

BindAttribute 有 Include 和 Exclude , Include 是只接收 Include 指定的属性, Exclude 是排除.

 
 
 
 

  
  
  
  
[HttpPost]  
  
  
  
  
 
  
  
  
  
public ActionResult Reserve([Bind(Include = "FG,FB,Hotels,OptionUseDates")]Reserve r , string act) {  
  
  
  
  
 
  
  
  
  
…  
 
 
 
 

意思是参数 r 只接收 Post 过来的 FG, FB,Hotels,OptionUseDates 数据,其它的传过来也不要

在ModelBinder 中把非 Include 的或 Exclude 的验证错误剔除

 
 
 
 

  
  
  
  
public class SmartModelBinder : DefaultModelBinder {  
  
  
  
  
protected override void OnModelUpdated(ControllerContext controllerContext , ModelBindingContext bindingContext) {  
  
  
  
  
Dictionary startedValid = new Dictionary(StringComparer.OrdinalIgnoreCase);  
  
  
  
  
//获取模型的验证结果  
  
  
  
  
var results = ModelValidator.GetModelValidator(bindingContext.ModelMetadata , controllerContext).Validate(bindingContext.Model);  
  
  
  
  
foreach(ModelValidationResult validationResult in results) {  
  
  
  
  
string subPropertyName = CreateSubPropertyName(bindingContext.ModelName , validationResult.MemberName);  
  
  
  
  
//if(bindingContext.PropertyFilter(subPropertyName)) {  
  
  
  
  
//bindingContext.PropertyFilter 是一个 delegate, 如果指定的 member 在 BindAttribute 的 Include 的列表内（或者非 Exclude 的列表内），返回 true, 否则为 false  
  
  
  
  
//部分验证的功能就是通过它的结果来实现的  
  
  
  
  
if(bindingContext.PropertyFilter(validationResult.MemberName)) {  
  
  
  
  
if(!startedValid.ContainsKey(subPropertyName)) {  
  
  
  
  
startedValid[subPropertyName] = bindingContext.ModelState.IsValidField(subPropertyName);  
  
  
  
  
}  
  
  
  
  
if(startedValid[subPropertyName]) {  
  
  
  
  
bindingContext.ModelState.AddModelError(subPropertyName , validationResult.Message);  
  
  
  
  
}  
  
  
  
  
}  
  
  
  
  
}  
  
  
  
  
}  
 
 
 
 

在 Global 里注册该 ModelBinder

 
 
 
 

  
  
  
  
protected void Application_Start() {  
  
  
  
  
…  
  
  
  
  
ModelBinders.Binders.DefaultBinder = new SmartModelBinder();  
  
  
  
  
… 
 
 
 
 

自验证 IValidatableObject

某些情况下，简单的在用 DataAnnoation 不足以做完业务逻辑的验证。比如旅客信息中，儿童的年龄要在返程日期的为准，2 到 11 岁之间, 当机票订票要求是护照时，出生日期、护照号码，签发国家、签发地为必填；当要求是回乡证时，回乡证号必填；当要求护照或回乡证时，其中之一的信息必须完整。

这种情况下，就需要用到 IValidatableObject , 只要按需求实现 Validate 方法就可以了。

 
 
 
 

  
  
  
  
public class Traveller : IValidatableObject {  
  
  
  
  
public int TravellerID { get; set; }  
  
  
  
  
[Required]  
  
  
  
  
public string FirstName { get; set; }  
  
  
  
  
[Required]  
  
  
  
  
public string LastName { get; set; }  
  
  
  
  
public DateTime Birthday { get; set; }  
  
  
  
  
public bool IsAdult { get; set; }  
  
  
  
  
public IEnumerable Validate(ValidationContext validationContext) {  
  
  
  
  
if(!this.IsAdult && this.Birthday.Date < DateTime.Now.AddYears(-12)) {  
  
  
  
  
yield return new ValidationResult("儿童年龄必须在 12 岁以内");  
  
  
  
  
}  
  
  
  
  
}  
  
  
  
  
} 
 
 
 
 

另外注意，如果标注有 DataAnnation 的属性没有验证没有通过，是不会去执行 Validate 方法的。

手动验证

暂未整理

启用客服端验证

AppSetting 里

或

 
 
 
 

  
  
  
  
Html.EnableClientValidation(true);  
  
  
  
  
Html.EnableUnobtrusiveJavaScript(true) 
 
 
 
 

另外，如果以启用了客户端验证，但是表单项并没有在 Form （Html.BeginForm()） 内，也是不会有客户端验证的.

自定义客户端验证

具体请参考该 js 文件。

以下所述的客户端验证都是基于 jQuery.validate 1.9 + jquery.validate.unobtrusive (项目自带) 的

默认的，要在客户端实时看到验证信息（js 验证），需要使用 Html.ValidationMessageFor() 来生成一个容器，供 js 往里填写错误信息.但是，一个页面如果有很多个表单对象，而又不能使用 EditorForModel ， 一个一个敲，也是一件很头痛的事。其实可以通过修改，来自动生成: 重写 jQuery validator 的 setting 中的 errorPlacement 和 success 。写这两个是做到最小的修改，如果有必要，你也可以重写 其它的方法。

 
 
 
 

  
  
  
  
mode1_error 即 errorPlacement  
  
  
  
  
var mode1_error = function(error, inputElement){  
  
  
  
  
//查找错误提示容器  
  
  
  
  
var container = $("span[data-valmsg-for='" + inputElement[0].name + "']", inputElement[0].form);  
  
  
  
  
//如果没有，生成一个  
  
  
  
  
if(container.length == 0){  
  
  
  
  
container = $("")  
  
  
  
  
.attr({"data-valmsg-replace":true, "data-valmsg-for":inputElement[0].name}).appendTo(form)  
  
  
  
  
}  
  
  
  
  
container.addClass("floatValidationError shadow radius hide");  
  
  
  
  
//调用原来的 errorPlacement  
  
  
  
  
errorPlacement(error, inputElement);  
  
  
  
  
//这块为选择器做的  
  
  
  
  
var flow = inputElement;  
  
  
  
  
var flag = inputElement.attr("data-flag");  
  
  
  
  
if(flag != undefined){  
  
  
  
  
container.data("data-for",flag);  
  
  
  
  
var display = $("*[data-for='" + flag + "']", inputElement[0].form);  
  
  
  
  
display.addClass("input-validation-error");  
  
  
  
  
if(display.length > 0){  
  
  
  
  
flow = display;  
  
  
  
  
}  
  
  
  
  
}  
  
  
  
  
//下拉列表不能设置border，需要包装一个 span ，在 span 上显示border  
  
  
  
  
if(inputElement[0].tagName == "SELECT" && inputElement.hasClass("input-validation-error") && !inputElement.parent().hasClass("input-validation-error-wrapper")){  
  
  
  
  
inputElement.wrap("")  
  
  
  
  
}  
  
  
  
  
//这一步能过 css hide 做，优化性能  
  
  
  
  
//container.hide();  
  
  
  
  
flow.focus(elementFocus).blur(elementBlur);  
  
  
  
  
}  
  
  
  
  
mode2_success 即 success  
  
  
  
  
var mode2_success = function(error){  
  
  
  
  
var container = error.data("unobtrusiveContainer");  
  
  
  
  
//调用原有的 success  
  
  
  
  
success(error);  
  
  
  
  
//为选择器所做  
  
  
  
  
var dataFor = container.data("data-for");  
  
  
  
  
if(dataFor != undefined){  
  
  
  
  
$("*[data-for='" + dataFor + "']").removeClass("input-validation-error");  
  
  
  
  
}  
  
  
  
  
//如果该error对应的表单对象是下拉列表，要清除包装的 span   
  
  
  
  
var ele = $("[name='" + container.data("valmsg-for") + "']");  
  
  
  
  
if(ele[0].tagName == "SELECT" && ele.hasClass("input-validation-error")){  
  
  
  
  
var par = ele.parent();  
  
  
  
  
ele.appendTo(par.parent());  
  
  
  
  
par.remove();  
  
  
  
  
}  
  
  
  
  
} 
 
 
 
 

使用这个 js 后，即使不Html.ValidationMessageFor() 也一样会在客户端有个提示

效果如下：

优化

如果一个页面里的表单很多，每个表单又有N个验证规则，在 IE7(包括)以下，会提示：

是否停止运行此脚本？

此页面上的脚本造成 Internet Explorer 运行速度减慢。XXXX

为了该问题，测试打了很多小报告，我也很烦，jquery validation 造成的问题，我有什么办法，但是问题总归要解决，我花了两天时间，用 ie 调试工具里的探测器及dynaTrace 收集了很多运行数据，***发现，验证是很快，但是显示错误却很慢，因为有大量的非Id查找的 jquery selector。具体表现在 jquery.validate 的 showLabel 方法，和 jquery.validate.unobtrusive 的 onError 方法。我对这两个地方做了修改，在测，整个验证过程在 ie7下执行的很快！

具体改动如下：

jquery.validate.unobtrusive.js

第40行由：

 
 
 
 

  
  
  
  
var container = $(this).find("[data-valmsg-for='" + inputElement[0].name + "']"), 
 
 
 
 

改为：

 
 
 
 

  
  
  
  
var container = $(this).find("span[data-valmsg-for='" + inputElement[0].name + "']"), 
 
 
 
 

目的：减少 dom 节少遍历次数

第48行由：

 
 
 
 

  
  
  
  
error.removeClass("input-validation-error").appendTo(container); 
 
 
 
 

改为:

 
 
 
 

  
  
  
  
error  
  
  
  
  
//.removeClass("input-validation-error")  
  
  
  
  
.appendTo(container); 
 
 
 
 

原因：在 jquery.validate 1.9 中的 showLabel 方法的

 
 
 
 

  
  
  
  
var label = this.errorsFor(element) 
 
 
 
 

这个方法又调 errors() 方法

errors 方法又是跟据 errorClass 去查找

errorClass 即 input-validation-error

在 showLabel 方法里，如果

label = this.errorsFor(element) 没有结果,就又会新建一个 label (DOM创建)

所以在 jquery.validate.unobtrusive 的第48行不应该 removeClass("input-validation-error")

jquery.validate.js 改动：

showLabel 方法：

在开头处加入

 
 
 
 

  
  
  
  
if (message == undefined)  
  
  
  
  
return; 
 
 
 
 

errorsFor 方法改为：

 
 
 
 

  
  
  
  
errorsFor: function (element) {  
  
  
  
  
var name = this.idOrName(element);  
  
  
  
  
return $(this.settings.errorElement + "." + this.settings.errorClass + "[for='" + name + "']", this.errorContext);  
  
  
  
  
// return this.errors().filter(function () {  
  
  
  
  
// return $(this).attr('for') == name;  
  
  
  
  
// });  
  
  
  
  
}, 
 
 
 
 

修改后的 js 文件：

[[84104]][[84105]]

#p#

扩展 DataTypeAttribute

DataTypeAttribute 只是用来显示值，而不用于验证（不知是否有误，请指教）。

但是我就是想要用 DataTypeAttribute 做验证怎么办呢？自定义一个 DataTypeValidator

 
 
 
 

  
  
  
  
public class DataTypeValidator : DataAnnotationsModelValidator {  
  
  
  
  
 
  
  
  
  
//和 jQuery 里的email 验证保持一致  
  
  
  
  
 
  
  
  
  
private static readonly string EmailReg = @"^((([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+(\.([a-z]|\d|[!#\$%&'\*\+\-\/=\?\^_`{\|}~]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])+)*)|((\x22)((((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(([\x01-\x08\x0b\x0c\x0e-\x1f\x7f]|\x21|[\x23-\x5b]|[\x5d-\x7e]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(\\([\x01-\x09\x0b\x0c\x0d-\x7f]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]))))*(((\x20|\x09)*(\x0d\x0a))?(\x20|\x09)+)?(\x22)))@((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.?$";  
  
  
  
  
 
  
  
  
  
private static readonly string UrlReg = @"^(https?|ftp):\/\/(((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:)*@)?(((\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]))|((([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|\d|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.)+(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])*([a-z]|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])))\.?)(:\d*)?)(\/((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)+(\/(([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)*)*)?)?(\?((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|[\uE000-\uF8FF]|\/|\?)*)?(\#((([a-z]|\d|-|\.|_|~|[\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF])|(%[\da-f]{2})|[!\$&'\(\)\*\+,;=]|:|@)|\/|\?)*)?$";  
  
  
  
  
 
  
  
  
  
public DataTypeValidator(ModelMetadata metadata , ControllerContext context , DataTypeAttribute attribute)  
  
  
  
  
: base(metadata , context , attribute) {  
  
  
  
  
this.message = attribute.ErrorMessage;  
  
  
  
  
}  
  
  
  
  
string message;  
  
  
  
  
public override IEnumerable Validate(object container) {  
  
  
  
  
var value = Metadata.Model;  
  
  
  
  
if(value != null) {  
  
  
  
  
var dataType = (DataType)Enum.Parse(typeof(DataType) , Metadata.DataTypeName);  
  
  
  
  
var flag = true;  
  
  
  
  
switch(dataType) {  
  
  
  
  
case DataType.EmailAddress:  
  
  
  
  
if(!Regex.IsMatch(value.ToString() , EmailReg, RegexOptions.IgnoreCase)) {  
  
  
  
  
flag = false;  
  
  
  
  
}  
  
  
  
  
break;  
  
  
  
  
case DataType.Url:  
  
  
  
  
if(!Regex.IsMatch(value.ToString() , UrlReg , RegexOptions.IgnoreCase))  
  
  
  
  
flag = false;  
  
  
  
  
break;  
  
  
  
  
}  
  
  
  
  
if(!flag) {  
  
  
  
  
yield return new ModelValidationResult() {  
  
  
  
  
//下面这句不能加，会影响 SmartModelBinder 里的 CreateSubPropertyName  
  
  
  
  
//MemberName = Metadata.PropertyName ,  
  
  
  
  
Message = ErrorMessage 
  
  
  
  
};  
  
  
  
  
}  
  
  
  
  
}  
  
  
  
  
}  
  
  
  
  
public override IEnumerable GetClientValidationRules() {  
  
  
  
  
List rules = new List();  
  
  
  
  
ModelClientValidationRule rule;  
  
  
  
  
switch(Attribute.DataType) {  
  
  
  
  
case DataType.EmailAddress:  
  
  
  
  
rule = new ModelClientValidationRule() { ErrorMessage = message , ValidationType = "email" };  
  
  
  
  
//rule.ValidationParameters.Add("email" , "true");  
  
  
  
  
rules.Add(rule);  
  
  
  
  
break;  
  
  
  
  
case DataType.Url:  
  
  
  
  
rule = new ModelClientValidationRule() { ErrorMessage = message , ValidationType = "url" };  
  
  
  
  
//rule.ValidationParameters.Add("url" , "true");  
  
  
  
  
rules.Add(rule);  
  
  
  
  
break;  
  
  
  
  
case DataType.Date:  
  
  
  
  
rule = new ModelClientValidationRule() { ErrorMessage = message , ValidationType = "date" };  
  
  
  
  
//rule.ValidationParameters.Add("date" , "true");  
  
  
  
  
rules.Add(rule);  
  
  
  
  
break;  
  
  
  
  
}  
  
  
  
  
return rules;  
  
  
  
  
}  
  
  
  
  
} 
 
 
 
 

然后在 Global 里：

 
 
 
 

  
  
  
  
DataAnnotationsModelValidatorProvider.RegisterAdapter(typeof(DataTypeAttribute) , typeof(DataTypeValidator)); 
 
 
 
 

该类的方法：GetClientValidationRules 里，将 Date 的 ValidationType 设为 date 。但是在 jquery.validate 里，date 方法是去验证 new Date(value) 是不是 NaN, 这在 ie 下有问题, 比如 new Date("2012-01-01") 是 NaN ，也许你说可以用 dateISO 去验证，但是 dateISO 要求如下格式：yyyy-MM-dd 或 yyyy/MM/dd, 换一种格式呢？当然是验证不通过了！

这种情况下，只能重写 jquery.validate 的 date 验证规则了(在上文我贴出的 site.js 里有)：

 
 
 
 

  
  
  
  
var checkDate = function(value, element){  
  
  
  
  
return this.optional(element) || value.toDate() != null;  
  
  
  
  
}  
  
  
  
  
…  
  
  
  
  
$.validator.addMethod("date", checkDate); 
 
 
 
 

该部分是覆盖 jquery.validate 里的 date 处理方法, toDate方法在我贴出的 site.js 里有，请自行参考。另外，我还提供了 DateRange 验证,用以解决复杂的验证逻辑，用法如下：

 
 
 
 

  
  
  
  
@Html.TextBoxFor(m => m[i].BirthDay , new { Value = Model[i].BirthDay.ToString(dateFmt) , @data_val_required = "必填" , @data_val_dateRange_min = min.ToString(dateFmt) , @data_val_dateRange_max = max.ToString(dateFmt) , @data_val_dateRange = @msg , title = "輸入格式：2012/01/01" }) 
 
 
 
 

RequiredIf 验证

做复杂验证的时候，可以像上面的 DateRange 的用法一样去处理大部分问题，但是当某值为XX时，某XX为必填，DataAnnoation 里没提供，jquery.validate 里也没有提供, 那只能自定义了：

 
 
 
 

  
  
  
  
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]  
  
  
  
  
public class RequiredIfAttribute : ValidationAttribute , IClientValidatable {  
  
  
  
  
 
  
  
  
  
private RequiredAttribute required = new RequiredAttribute();  
  
  
  
  
 
  
  
  
  
/// 
  
  
  
  
  
/// 依赖于哪个属性  
  
  
  
  
/// 必须是本对象下的一个属性  
  
  
  
  
///   
  
  
  
  
public string DependentProperty { get; set; }  
  
  
  
  
 
  
  
  
  
private List