Jquery Validation 验证控件的使用说明

2023-08-10 08:35:28

转载自：http://blog.csdn.net/huang100qi/article/details/52453970，做了一些简化及修改

一、导入jqery库

<script src="../js/jquery.js" type="text/JavaScript"></script>
<script src="../js/jquery.validate.js" type="text/javascript"></script>

二、默认校验规则及提示

required:true	必填字段
remote:"check.action"	使用ajax验证输入值
email:true	必须输入正确格式的电子邮件
url:true	必须输入正确格式的网址
date:true	必须输入正确格式的日期日期校验ie6出错，慎用
dateISO:true	必须输入正确格式的日期(ISO)，例如：2009-06-23，1998/01/22 只验证格式，不验证有效性
number:true	必须输入合法的数字(负数，小数)
digits:true	必须输入整数
creditcard:	必须输入合法的信用卡号
equalTo:"#field"	输入值必须和#field相同
maxlength:5	输入长度最多是5的字符串(汉字算一个字符)
minlength:10	输入长度最小是10的字符串(汉字算一个字符)
rangelength:[5,10]	输入长度必须介于 5 和 10 之间的字符串")(汉字算一个字符)
range:[5,10]	输入值必须介于 5 和 10 之间
max:5	输入值不能大于5
min:10	输入值不能小于10
accept:	输入拥有合法后缀名的字符串（上传文件的后缀）

默认为英文提示，若使用中文提示信息，需引入localization下的messages_zh.js文件
或修改默认的提示信息：

jQuery.extend(jQuery.validator.messages, {
  required: "必选字段"
});

三、两种使用方式

1. 将校验规则写到表单控件中：

　　引入包：jquery.metadata.js，使用方式如下：class="{required:true,equalTo:'#password'}"

<script src="../js/jquery.js" type="text/javascript"></script>
<script src="../js/jquery.validate.js" type="text/javascript"></script>
<script src="./js/jquery.metadata.js" type="text/javascript">
<script type="text/javascript">
$().ready(function() {
 　　$("#signupForm").validate();
});
</script>
<form id="signupForm" method="get">
    <p>
        <label for="firstname">姓名</label>
        <input id="firstname" name="firstname" class="required" />
    </p>
 <p>
  <label for="email">邮箱</label>
  <input id="email" name="email" class="required email" />
 </p>
 <p>
  <label for="password">密码</label>
  <input id="password" name="password" type="password" class="{required:true,minlength:5}" />
 </p>
 <p>
  <label for="confirm_password">确认密码</label>
  <input id="confirm_password" name="confirm_password" type="password" class="{required:true,minlength:5,equalTo:'#password'}" />
 </p>
    <p>
        <input class="submit" type="submit" value="Submit"/>
    </p>
</form>

2. 将校验规则写到js代码中

$().ready(function() {
　　$("#signupForm").validate({
　　　　rules: {
　　　　　　firstname: "required",
   　　　　 email: {
    　　　　　required: true,
    　　　　　email: true
   　　　　 },
   　　　　　password: {
    　　　　　　required: true,
    　　　　　　minlength: 5
   　　　　　},
   　　　　　confirm_password: {
    　　　　　　required: true,
    　　　　 　 minlength: 5,
    　　　　　　equalTo: "#password"
  　　　　　 }
  　　　},
       messages: {
   　　　　password: {
    　　　　　　minlength: jQuery.format("密码不能小于{0}个字 符")
   　　　  }
    　　}
　　});
});
</script>

<form id="signupForm" method="get">
    <p>
        <label for="firstname">Firstname</label>
        <input id="firstname" name="firstname" />
    </p>
 <p>
  <label for="email">E-Mail</label>
  <input id="email" name="email" />
 </p>
 <p>
  <label for="password">Password</label>
  <input id="password" name="password" type="password" />
 </p>
 <p>
  <label for="confirm_password">确认密码</label>
  <input id="confirm_password" name="confirm_password" type="password" />
 </p>
    <p>
        <input class="submit" type="submit" value="Submit"/>
    </p>
</form>

四、常用方法及注意问题

1. 用其他方式替代默认的submit

$().ready(function() {
 　　$("#signupForm").validate({
        submitHandler:function(form){
            form.submit();
        }
     });
});

2. 使用ajax方式提交表单

$(".selector").validate({
 　　submitHandler: function(form) {
      　　$(form).ajaxSubmit();
 　　}
})

3. 设置validate的默认值

$.validator.setDefaults({
  debug:true,
　submitHandler: function(form) { alert("submitted!");
});

4. ignore: ".ignore"，忽略某些不需要验证的元素

5. errorPlacement，更改错误信息显示的位置

默认如下，即把错误信息放在验证的元素后面

errorPlacement: function(error, element) {
    error.appendTo(element.parent());
}

修改默认提示位置:

$().ready(function() { 　　
　　$("#signupForm").validate({
　　　　errorPlacement: function(error, element) { 
　　　　　　if ( element.is(":radio") ) 
　　　　　　　　error.appendTo( element.parent().next().next() ); 
　　　　　　else if ( element.is(":checkbox") ) 
　　　　　　　　error.appendTo ( element.next() ); 
　　　　　　else error.appendTo( element.parent().next() ); 
　　　　}
　　}
}

<form id="signupForm" method="get">
<tr>
    <td class="label"><label id="lfirstname" for="firstname">First Name</label></td>
    <td class="field"><input id="firstname" name="firstname" type="text" value="" maxlength="100" /></td>
    <td class="status"></td>
</tr>
<tr>
    <td style="padding-right: 5px;">
        <input id="dateformat_eu" name="dateformat" type="radio" value="0" />
        <label id="ldateformat_eu" for="dateformat_eu">14/02/07</label>
    </td>
    <td style="padding-left: 5px;">
        <input id="dateformat_am" name="dateformat" type="radio" value="1"  />
        <label id="ldateformat_am" for="dateformat_am">02/14/07</label>
    </td>
    <td></td>
</tr>
<tr>
    <td class="label">&nbsp;</td>
    <td class="field" colspan="2">
        <div id="termswrap">
            <input id="terms" type="checkbox" name="terms" />
            <label id="lterms" for="terms">I have read and accept the Terms of Use.</label>
        </div>
    </td>
</tr>
</form>

代码的作用是：一般情况下把错误信息显示在<td class="status"></td>中，如果是radio显示在<td></td>中，如果是 checkbox 显示在内容的后面

errorClass："error" 指定错误提示的css类名，可以自定义

errorElement："label"

errorContainer：Selector，显示或者隐藏验证信息，可以自动实现有错误信息出现时把容器属性变为显示，无错误时隐藏，用处不大，如：errorContainer: "#messageBox1, #messageBox2"

errorLabelContainer：Selector，把错误信息统一放在一个容器里面。

wrapper：String，用什么标签再把上边的errorELement包起来

一般这三个属性同时使用，实现在一个容器内显示所有错误提示的功能，并且没有信息时自动隐藏

errorContainer: "div.error",
errorLabelContainer: $("#signupForm div.error"),
wrapper: "li"

6. 更改错误信息显示的样式

设置错误提示的样式，可以增加图标显示，在该系统中已经建立了一个默认的validation.css专门用于维护校验文件的样式

input.error { border: 1px solid red; }
label.error {
  background:url("./demo/images/unchecked.gif") no-repeat 0px 0px;
  padding-left: 16px;
  padding-bottom: 2px;
  font-weight: bold;
  color: #EA5200;
}

//校验成功时的class值必须为valid
label.valid {
  background:url("./demo/images/checked.gif") no-repeat 0px 0px;
}

7. 每个字段验证通过执行函数

success：String,Callback，要验证的元素通过验证后的动作，如果跟一个字符串，会当做一个css类，也可跟一个函数

success:"valid"
success: function(label) {
    // set &nbsp; as text for IE
    label.html("&nbsp;").addClass("valid");
    //label.addClass("valid").text("Ok!")
}

8. 自定义添加验证失败回调方法

jQuery Validation Plugin - v1.16.0

第774行左右：
if( !result ) {
   this.formatAndAdd( element, rule );
   return false;
}
改成
if( !result ) {
   this.formatAndAdd( element, rule );
   var errorCallback=this.settings.fail;
   if($.type(errorCallback)==='function'){
      errorCallback(element);
   }
   return false;
}

调用如下

$("#form").validate({
    fail: function(element,e) {
        success: function(label) {
            label.addClass("checked");
        },
        //失败时的回调函数
        fail:function(element){
            $(element).next("label").removeClass("checked");
        },
    }
}

9. 验证的触发方式修改

下面的虽然是boolean型的，但建议除非要改为false,否则别乱添加。

onsubmit："true"，提交时验证. 设置唯false就用其他方法去验证
onfocusout："true"，失去焦点是验证(不包括checkboxes/radio buttons)，
onkeyup："true"，在keyup时验证.
onclick："true"，在checkboxes 和 radio 点击时验证
focusInvalid："true"，提交表单后，未通过验证的表单(第一个或提交之前获得焦点的未通过验证的表单)会获得焦点
focusCleanup："false"，如果是true那么当未通过验证的元素获得焦点时，移除错误提示。避免和 focusInvalid 一起用

重置表单

$().ready(function() {
    var validator = $("#signupForm").validate({
        submitHandler:function(form){
            alert("submitted");
            form.submit();
        }
    });
    $("#reset").click(function() {
        validator.resetForm();
    });
});

10. 异步验证

remote: "check-email.php"

remote: {
    url: "check-email.php",     //后台处理程序
    type: "post",               //数据发送方式
    dataType: "json",           //接受数据格式
    data: {                     //要传递的数据
        username: function() {
            return $("#username").val();　　//不能直接写字符串 "$("#username").val()"
        }
    }
}

11. 添加自定义校验

// 中文字两个字节
jQuery.validator.addMethod("byteRangeLength", function(value, element, param) {
    var length = value.length;
    for(var i = 0; i < value.length; i++){
        if(value.charCodeAt(i) > 127){
            length++;
        }
    }
  return this.optional(element) || ( length >= param[0] && length <= param[1] );
}, $.validator.format("请确保输入的值在{0}-{1}个字节之间(一个中文字算2个字节)"));

// 邮政编码验证
jQuery.validator.addMethod("isZipCode", function(value, element) {
    var tel = /^[0-9]{6}$/;
    return this.optional(element) || (tel.test(value));
}, "请正确填写您的邮政编码");

要在additional-methods.js文件中添加或者在jquery.validate.js添加，建议一般写在additional-methods.js文件中
在messages_cn.js文件添加：isZipCode: "只能包括中文字、英文字母、数字和下划线"，调用前要添加对additional-methods.js文件的引用。

12. radio和checkbox、select的验证

1).radio的required表示必须选中一个

<input type="radio" id="gender_male" value="m" name="gender" class="{required:true}" />
<input type="radio" id="gender_female" value="f" name="gender"/>

2).checkbox的required表示必须选中

checkbox的minlength表示必须选中的最小个数,maxlength表示最大的选中个数,rangelength:[2,3]表 示选中个数区间

<input type="checkbox" class="checkbox" id="agree" name="agree" class="{required:true}" />
<input type="checkbox" class="checkbox" id="spam_email" value="email" name="spam[]" class="{required:true, minlength:2}" />
<input type="checkbox" class="checkbox" id="spam_phone" value="phone" name="spam[]" />
<input type="checkbox" class="checkbox" id="spam_mail" value="mail" name="spam[]" />

).select的required表示选中的value不能为空

<select id="jungle" name="jungle" title="Please select something!" class="{required:true}">
    <option value=""></option>
    <option value="1">Buga</option>
    <option value="2">Baga</option>
    <option value="3">Oi</option>
</select>

select的minlength表示选中的最小个数（可多选的select）,maxlength表示最大的选中个数,rangelength:[2,3]表示选中个数区间

<select id="fruit" name="fruit" title="Please select at least two fruits" class="{required:true, minlength:2}" multiple="multiple">
    <option value="b">Banana</option>
    <option value="a">Apple</option>
    <option value="p">Peach</option>
    <option value="t">Turtle</option>
</select>

码农公寓