MVC系统学习5——验证

其实关于Mvc的验证在上一篇已经有讲过一些了，可以通过在我们定义的Model上面添加相应的System.ComponentModel.DataAnnotations空间下的验证属性。在服务器端通过ModelBinder来接受提交的数据就能实现自动验证。如下例子.

定义一个PriceModel

public class PriceModel
    {
        [Required]//通过定义这个实现Title字段为必输
        [DisplayName("标题")]
        public string Title { get; set; }

        [DisplayName("价格")]
        public double Price { get; set; }
    }

在页面我们定义的代码如下：

<% using (Html.BeginForm())
           { %>
        <%= Html.TextBoxFor(m=>m.Title) %>
        <%= Html.ValidationMessageFor(m => m.Title) %>
        <%= Html.TextBoxFor(m => m.Price) %>
        <%= Html.ValidationMessageFor(m => m.Price) %>  <%--通过在前台添加Html.ValidationMessageFor能实现错误信息的显示--%>
        <input type="submit" value="提交" />
        <% } %>

在控制器定义的代码如下：

[HttpPost]
        public ActionResult Index(PriceModel model)
        {
            return View(model);
        }

当我们在页面上面不填写Title时，页面上会提示，标题字段必须填写。这就自动实现了验证。接下来对PriceModel的Price字段添加特殊的验证规则。添加一个PriceAttribute类。添加自定义的验证规则需要继承自ValidationAttribute，并且重写实现IsValid方法，在这个方法里面实现验证。定义完PriceAttribute后，在PriceModel的Price字段上面添加特性，这样就能启用对这个字段的验证，当在页面上面输入的数值后三位不是99到995之间时就会提示出错。

public class PriceAttribute : ValidationAttribute
    {
        public double MinPrice { get; set; }

        public override bool IsValid(object value)
        {
            if (value == null)
            {
                return true;
            }
            var price = (double)value;
            if (price < MinPrice)
            {
                return false;
            }
            double cents = price - Math.Truncate(price);
            if (cents < 0.99 || cents >= 0.995)
            {
                return false;
            }

            return true;
        }

 }

之所以能实现上面的验证是由于在使用DefualtModelBinder的时候会自动调用ModelValidatorProviders.Providers.GetValidators方法获取ModelValidator进行验证(疑问：如果使用自定义的ModelBinder验证能起作用吗？)。但是这里的验证会有一个问题，就是我们这样还是将数据发送到服务器端进行验证，验证失败向ModelState添加数据，通过Html.ValidationMessageFor获取验证失败的ErrorMessage然后再发送回客户端浏览器进行显示。我们能不能直接自动在客户端浏览器进行js验证？

Mvc提供了这样的功能。在前面一节我们提到过ClientDataTypeModelValidator ,其用于生成ModelClientValidationRules(这个验证规则只是针对类型而已，如向Price字段输入字符则会马上提示出错)，这个类存放着要发送到客户端的验证规则。除了ClientDataTypeModelValidator能生成ModelClientValidationRules，继承自泛型类DataAnno-tationModelValidator<TAttribute>的类也会提供相应的客户端Rule(如：RangeAttributeAdapter会产生ModelClientValidationRangeRule)，当我们在页面启用客户端验证的时候(添加这句代码：<%Html.EnableClientValidation(); %>)，ModelClientValidationRules客户端验证规则将会被以json的格式发送到浏览器。例如当我在页面启用客户端验证后，会看到页面增加了如下的代码.

//<![CDATA[
if (!window.mvcClientValidationMetadata) { window.mvcClientValidationMetadata = []; }
window.mvcClientValidationMetadata.push({"Fields":[{"FieldName":"Title","ReplaceValidationMessageContents":true,"ValidationMessageId":"Title_validationMessage","ValidationRules":[{"ErrorMessage":"标题 字段是必需的。","ValidationParameters":{},"ValidationType":"required"}]},{"FieldName":"Price","ReplaceValidationMessageContents":true,"ValidationMessageId":"Price_validationMessage","ValidationRules":[{"ErrorMessage":"价格 字段是必需的。","ValidationParameters":{},"ValidationType":"required"},{"ErrorMessage":"字段 价格 必须是一个数字。","ValidationParameters":{},"ValidationType":"number"}]}],"FormId":"form0","ReplaceValidationSummary":false});
//]]>

通过启用验证规则，能对Title字段实现在客户端的自动验证，但是Price字段只能自动实现非空验证。对于自定义的PriceAttribute验证在客户端并不能实现验证。这个原因在上面一段已经说过，就是PriceAttribute没有相应的继承自DataAnnotationModelValidator<TAttribute>的类来产生相应的客户端验证规则。因此添加一个类来实现这样的功能。

public class PriceValidator : DataAnnotationsModelValidator<PriceAttribute>
{
  double _minPrice;
  string _message;

  public PriceValidator(ModelMetadata metadata, ControllerContext context
    , PriceAttribute attribute)
    : base(metadata, context, attribute)
  {
    _minPrice = attribute.MinPrice;
    _message = attribute.ErrorMessage;
  }

  public override IEnumerable<ModelClientValidationRule>   GetClientValidationRules()
  {
    var rule = new ModelClientValidationRule {
      ErrorMessage = _message,
      ValidationType = "price"
    };
    rule.ValidationParameters.Add("min", _minPrice);

    return new[] { rule };
  }
}

接下来要做的事情就是在全局文件下，添加这个ModelValidator了。

protected void Application_Start() {
  RegisterRoutes(RouteTable.Routes);
  DataAnnotationsModelValidatorProvider
    .RegisterAdapter(typeof(PriceAttribute), typeof(PriceValidator));
}

最后还要在客户端也要实现相应的Js逻辑。

<script type="text/javascript">
  Sys.Mvc.ValidatorRegistry.validators["price"] = function(rule) {
    // initialization code can go here.
    var minValue = rule.ValidationParameters["min"];

    // we return the function that actually does the validation
    return function(value, context) {
      if (value > minValue) {
        var cents = value - Math.floor(value);
        if (cents >= 0.99 && cents < 0.995) {
          return true; /* success */
        }
      }

      return rule.ErrorMessage;
    };
  };
</script>

本文参考自(包括代码出处)：http://haacked.com/archive/2009/11/19/aspnetmvc2-custom-validation.aspx

后续讨论：在进行项目设计的时候我们通常会在客户端利用js进行提交表单前的数据验证，在服务器端我们再次会进行验证，理由是我们不相信任何来自客户端的数据。因此我们通常需要在服务器端和客户端实现相同的验证逻辑。我原来以为MVC框架能够实现当我们在服务器端实现相应的验证规则后，框架能够自动在客户端帮助我们自动实现脚本验证，不用自己书写代码。但是通过上面的PriceAttribute代码得知，对于自定义的验证规则，同样还要在页面添加脚本，而且还要实现PriceValidator这样的类并且在全局进行注册。这不是更加麻烦，而且一样要维护两份逻辑相同的代码？

如果在系统不复杂，验证数据合法性不是很复杂的时候，是可以通过Mvc框架自带的ModelBinder和验证功能帮助减少工作量。

其实系统的验证可以分为三个部分。

1.前端验证：就是利用js实现提交数据前的数据合法性验证。 还是利用js实现验证

2.服务器端数据合法性验证，这个实现逻辑基本和前者一致只是通过服务器端语言在服务器端进行验证.利用ModelBinder和System.ComponentModel.DataAnnotations，这样做的好处就是能让框架自动帮助我们实现验证。而且将验证规则的特性和模型放到一起更能体现模型的基本特征。

3.业务操作验证：在进行业务操作的时候进行验证，如权限商品数量是否足够出售等，这一点可以理解为业务操作是要在一定的操作条件下才能进行的，验证就是验证这些条件是否成立。感觉这些验证可以利用AOP来实现。

上面的观点还没有经过实践进行证明，只是猜想而已，做个备忘，等以后再回头来看。感觉MVC的有些功能有如鸡肋，食之无味，弃之可惜！