宋黎晓的空间

我们一直在努力....

javaScript前台校验jQuery.validate

标签: javaScript校验 jQuery.validate jQuery.validate扩展

        做网页表单经常要用到数据校验的功能.JavaScript校验是一种比较常用的手段。最近写页面写得比较多,发现了一个比较好用的js校验框架--jQuery.validate。她是一款基于jquery校验工具,基本可以满足我们大多数的页面校验需要,且支持ajax校验。支持各种自定义的扩展,包括自定义校验规则,自定义错误显示的方式等。

        通过一段时间的使用,感觉用起来还是非常简单的。这里做一下使用方法的简单介绍,而后会介绍一个我自己扩展的一种错误提示方式(感觉默认的信息提示的方式比较一般实在不怎么好看)。
        闲话少说,先说下用法:
        先导入必要的两个js文件

XML/HTML代码
  1. <script type="text/javascript" src="lib/jquery-1.4.2.min.js"></script>  
  2. <script type="text/javascript" src="lib/jquery.validate.js"></script>  

    另外还有一段css,用来突出显示出错的表单控件和错误信息的显示样式:

CSS代码
  1. input.error { border1px dotted red; }   
  2. label.error {   
  3.     colorred;displaynone;   
  4. }   

         label.error 的display: none是为了让我们可以在页面上任意位置放置显示错误的label以及上面的内容,并在没有进行校验时不显示出来。
        需要的东西都齐了,我们可以为我们的表单元素添加校验了。添加校验的方法总的说有两种:一种写在控件的标签上;另一种写在js脚本中。并且两种方法可混合使用。
        第一种写在标签中的如下:

XML/HTML代码
  1. <input type="text" class="required number" max="10" name="t1">  

         class="required number" 表示必须字段且为数值型,max="10" 表示最大值为10。
        另一种使用JavaScript脚本的写法如下:

 

XML/HTML代码
  1. <script type="text/javascript">  
  2. $('#test_form').validate({   
  3. rules:{   
  4.  t2 : {required:true,number:true}   
  5. },   
  6. messages:{t2:{required :"这个字段你必须填~~!",number:"这个字段真可以是数字"}}   
  7. });   
  8. </script>  

         其中test_form是表单form的id,t2是需要校验的控件的名字。rules后面的json描述的是校验规则,messages是自定义的错误信息。顺便说一句,有时候我们form中控件的name中是带“.”的,比如:user.name,这时候用js脚本定义校验规则时,需要加上引号:”user.name”。
        这两种写法各有利弊,直接写在控件标签上的比较简单直观,相对来说js的写法过于复杂,可灵活性更强。而且有时候我们可能没机会在控件的标签上写规则,假如我们用了标签库,如struts标签库,有些标签我们写上max=“10”这样的东西,标签库将无法解析直接报错。总之,这两种写法jQuery.validate都认识,我们在合适的场景选择合适的方式就可以了。
        另外,如果你想把规则写在控件的标签上,仅仅写上规则是不行的,还需要在页面加载完的时候调用一下$('#test_form').validate();为form添加校验,这样在你点提交按钮的时候就会自动校验了。
        说了这么多,该上个图了,看看校验的效果:

 默认校验样式

        成功了,校验的效果有了,表单也不会被提交。可能有的同学要说了,“要不要这么难看啊?”。这正是我下面要解决的问题。
        我们来自定义一个错误显示的方式,效果如下:

修改后的样式

         错误控件突出显示的方式没有改,为了兼容有些浏览器有些控件比如火狐中单选按钮没法标注红框的问题,在每个错误的控件后面放了一个红色的小叉号,另外当鼠标移动到错误控件或者小叉号上时显示错误的信息。
        实现这个效果的主要js代码如下:

JavaScript代码
  1. function showErrors(){   
  2.         var t = this;   
  3.         for ( var i = 0; this.errorList[i]; i++ ) {   
  4.             var error = this.errorList[i];   
  5.             this.settings.highlight && this.settings.highlight.call( this, error.element, this.settings.errorClass, this.settings.validClass );   
  6.                
  7.             var elename = this.idOrName(error.element);   
  8.             // 错误信息div   
  9.             var errdiv = $('div[htmlfor='+ elename + ']');   
  10.             var errimg = $('img[htmlfor='+ elename + ']');   
  11.             if(errdiv.length == 0){ // 没有div则创建   
  12.                    
  13.                 // 纯css不用图片的圆角div,存在在IE6下显示过长的问题   
  14. //              errdiv = $('<div>'    
  15. //              +   '<b class="rtop"><b class="r1"></b><b class="r2"></b><b class="r3"></b><b class="r4"></b></b>'   
  16. //              +   '<span class="errmsg"> </span>'   
  17. //              +   '<b class="rbottom"><b class="r4"></b><b class="r3"></b><b class="r2"></b><b class="r1"></b></b> '   
  18. //              +   '</div> ');   
  19.                    
  20.                 // 带图片的圆角div在所有浏览器兼容   
  21.                 errdiv = $('<div>'    
  22.                         + '<img src="img/left_icon.gif" width="6" height="24" align="absmiddle" class="fl" />'  
  23.                         + '<div class="errmsgdiv fl errmsg"></div>'  
  24.                         + '<img src="img/right_icon.gif" width="6" height="24" align="absmiddle" class="fl" />'  
  25.                         + '</div>');   
  26.                    
  27.                    
  28.                 errdiv.attr({"for":  this.idOrName(error.element), generated: true})   
  29.                 .addClass(this.settings.errorClass);   
  30. //              errdiv.css({left : $.getLeft(error.element) + 'px',top : $.getTop(error.element) + 'px'}); // 显示在控件的下面   
  31.                 errdiv.appendTo($('body'));   
  32.             }   
  33.             if(errimg.length == 0){ // 没有img则创建   
  34.                 errimg = $('<img alt="错误" src="img/unchecked.gif">')   
  35.                 errimg.attr({"for":  this.idOrName(error.element), generated: true});   
  36.                 errimg.insertAfter(error.element);   
  37.             }   
  38.             errimg.show();   
  39.             errdiv.find(".errmsg").html(error.message || "");   
  40.             // 鼠标放到图片显示错误   
  41.             $(errimg).hover(function(e){   
  42.                 $('div[htmlfor="'+ $(this).attr('htmlfor') + '"]').css({left : (e.pageX+20) + 'px',top : (e.pageY+20) + 'px'}); // 显示在鼠标位置偏移20的位置   
  43.                 $('div[htmlfor="'+ $(this).attr('htmlfor') + '"]').fadeIn(200);   
  44.             },   
  45.             function(){   
  46.                 $('div[htmlfor="'+ $(this).attr('htmlfor') + '"]').fadeOut(200);   
  47.             });   
  48.             // 鼠标放到控件上显示错误   
  49.             $(error.element).hover(function(e){   
  50.                 $('div[htmlfor="'+ t.idOrName(this) + '"]').css({left : (e.pageX+20) + 'px',top : (e.pageY+20) + 'px'}); // 显示在鼠标位置偏移20的位置   
  51.                 $('div[htmlfor="'+ t.idOrName(this) + '"]').fadeIn(200);   
  52.             },   
  53.             function(){   
  54.                 $('div[htmlfor="'+ t.idOrName(this) + '"]').fadeOut(200);   
  55.             });   
  56.         }   
  57.            
  58.         // 校验成功的去掉错误提示   
  59.         for ( var i = 0; this.successList[i]; i++ ) {   
  60.                 $('div[htmlfor="'this.idOrName(this.successList[i]) + '"]').remove();   
  61.                 $('img[htmlfor='this.idOrName(this.successList[i]) + ']').hide();   
  62.         }   
  63.            
  64.         // 自定义高亮   
  65.         if (this.settings.unhighlight) {   
  66.             for ( var i = 0, elements = this.validElements(); elements[i]; i++ ) {   
  67.                 this.settings.unhighlight.call( this, elements[i], this.settings.errorClass, this.settings.validClass );   
  68.             }   
  69.         }   
  70.     }   
  71. $.extend({   
  72.         getLeft : function(object) {   
  73.             var go = object;   
  74.             var oParent, oLeft = go.offsetLeft;   
  75.             while (go.offsetParent != null) {   
  76.                 oParent = go.offsetParent;   
  77.                 oLeft += oParent.offsetLeft;   
  78.                 go = oParent;   
  79.             }   
  80.             return oLeft;   
  81.         },   
  82.         getTop : function(object) {   
  83.             var go = object;   
  84.             var goHeight = go.height;   
  85.             var oParent, oTop = go.offsetTop;   
  86.             while (go.offsetParent != null) {   
  87.                 oParent = go.offsetParent;   
  88.                 oTop += oParent.offsetTop;   
  89.                 go = oParent;   
  90.             }   
  91.             return oTop + 22;// 之所以加22不加控件高度,为了兼容ie6.   
  92.         }   
  93. });   
  94. // 本地语言   
  95. jQuery.extend(jQuery.validator.messages, {   
  96.         required: "必选字段",   
  97.         remote: "请修正该字段",   
  98.         email: "请输入正确格式的电子邮件",   
  99.         url: "请输入合法的网址",   
  100.         date: "请输入合法的日期",   
  101.         dateISO: "请输入合法的日期 (ISO).",   
  102.         number: "请输入合法的数字",   
  103.         digits: "只能输入整数",   
  104.         creditcard: "请输入合法的信用卡号",   
  105.         equalTo: "请再次输入相同的值",   
  106.         accept: "请输入拥有合法后缀名的字符串",   
  107.         maxlength: jQuery.validator.format("请输入一个长度最多是 {0} 的字符串"),   
  108.         minlength: jQuery.validator.format("请输入一个长度最少是 {0} 的字符串"),   
  109.         rangelength: jQuery.validator.format("请输入一个长度介于 {0} 和 {1} 之间的字符串"),   
  110.         range: jQuery.validator.format("请输入一个介于 {0} 和 {1} 之间的值"),   
  111.         max: jQuery.validator.format("请输入一个最大为 {0} 的值"),   
  112.         min: jQuery.validator.format("请输入一个最小为 {0} 的值")   
  113. });   

         自定义一个showErrors的方法,然后在为表单添加校验时,指定使用这个方法显示错误信息。

JavaScript代码
  1. $('#test_form').validate({   
  2. rules:{   
  3.  t2 : {required:true,number:true}   
  4. },   
  5. messages:{t2:{required :"这个字段你必须填~~!",number:"这个字段真的可以是数字"}},   
  6. showErrors: showErrors  //使用自定义的错误显示方法   
  7. });  

        这样子我们想要的效果就实现了,是不是感觉比原来的样子好多了呢?
        jQuery.validate是一个非常灵活的JavaScript校验框架,上面只是介绍了一下基本的用法和自定义了一个错误显示的样式。一般的表单校验基本可以搞定了,不过一些比较特殊,比如身份证号的校验,页面上FCK编辑器的校验,还是需要我们自己来扩展的。个人感觉这是个很不错的js校验框架,所以介绍给大家,希望有所帮助。

附件:


    评分: 请先登录再投票,同一篇博客一月只能投票一次!
    无人投票

相关博客:


评论


发表评论

关注此文的人们还关注