jQuery.validate 詳解

武文博KevinLM發表於2017-07-28
jQuery.validate是一款非常不錯的表單驗證工具,簡單易上手,而且能達到很好的體驗效果,雖然說在專案中早已用過,但看到這篇文章寫得還是不錯的,轉載下與大家共同分享。

一、用前必備

    官方網站:http://bassistance.de/jquery-plugins/jquery-plugin-validation/(注意下載最新版)
    API: http://jquery.bassistance.de/api-browser/plugins.html當前版本:1.5.5
    需要JQuery版本:1.2.6+, 相容 1.3.2<script src="../js/jquery.js" type="text/javascript"></script>
<script src="../js/jquery.validate.js" type="text/javascript"></script>
二、預設校驗規則
(1)required:true               必輸欄位
(2)remote:"check.php"          使用ajax方法呼叫check.php驗證輸入值
(3)email:true                  必須輸入正確格式的電子郵件
(4)url:true                    必須輸入正確格式的網址
(5)date:true                   必須輸入正確格式的日期
(6)dateISO:true                必須輸入正確格式的日期(ISO),例如:2009-06-23,1998/01/22 只驗證格式,不驗證有效性
(7)number:true                 必須輸入合法的數字(負數,小數)
(8)digits:true                 必須輸入整數
(9)creditcard:                 必須輸入合法的信用卡號
(10)equalTo:"#field"           輸入值必須和#field相同
(11)accept:                    輸入擁有合法字尾名的字串(上傳檔案的字尾)
(12)maxlength:5                輸入長度最多是5的字串(漢字算一個字元)
(13)minlength:10               輸入長度最小是10的字串(漢字算一個字元)
(14)rangelength:[5,10]         輸入長度必須介於 5 和 10 之間的字串")(漢字算一個字元)
(15)range:[5,10]               輸入值必須介於 5 和 10 之間
(16)max:5                      輸入值不能大於5
(17)min:10                     輸入值不能小於10
三、預設的提示
messages: {
    required: "This field is required.",
    remote: "Please fix this field.",
    email: "Please enter a valid email address.",
    url: "Please enter a valid URL.",
    date: "Please enter a valid date.",
    dateISO: "Please enter a valid date (ISO).",
    dateDE: "Bitte geben Sie ein g眉ltiges Datum ein.",
    number: "Please enter a valid number.",
    numberDE: "Bitte geben Sie eine Nummer ein.",
    digits: "Please enter only digits",
    creditcard: "Please enter a valid credit card number.",
    equalTo: "Please enter the same value again.",
    accept: "Please enter a value with a valid extension.",
    maxlength: $.validator.format("Please enter no more than {0} characters."),
    minlength: $.validator.format("Please enter at least {0} characters."),
    rangelength: $.validator.format("Please enter a value between {0} and {1} characters long."),
    range: $.validator.format("Please enter a value between {0} and {1}."),
    max: $.validator.format("Please enter a value less than or equal to {0}."),
    min: $.validator.format("Please enter a value greater than or equal to {0}.")
},如需要修改,可在js程式碼中加入:jQuery.extend(jQuery.validator.messages, {
    required: "必選欄位",
   remote: "請修正該欄位",
   email: "請輸入正確格式的電子郵件",
   url: "請輸入合法的網址",
   date: "請輸入合法的日期",
   dateISO: "請輸入合法的日期 (ISO).",
   number: "請輸入合法的數字",
   digits: "只能輸入整數",
   creditcard: "請輸入合法的信用卡號",
   equalTo: "請再次輸入相同的值",
   accept: "請輸入擁有合法字尾名的字串",
   maxlength: jQuery.validator.format("請輸入一個長度最多是 {0} 的字串"),
   minlength: jQuery.validator.format("請輸入一個長度最少是 {0} 的字串"),
   rangelength: jQuery.validator.format("請輸入一個長度介於 {0} 和 {1} 之間的字串"),
   range: jQuery.validator.format("請輸入一個介於 {0} 和 {1} 之間的值"),
   max: jQuery.validator.format("請輸入一個最大為 {0} 的值"),
   min: jQuery.validator.format("請輸入一個最小為 {0} 的值")
});推薦做法,將此檔案放入messages_cn.js中,在頁面中引入
<script src="../js/messages_cn.js" type="text/javascript"></script>
四、使用方式
1.將校驗規則寫到控制元件中
[html] view plain copy
 print?
  1. <script src="../js/jquery.js" type="text/javascript"></script>  
  2. <script src="../js/jquery.validate.js" type="text/javascript"></script>  
  3. <script src="./js/jquery.metadata.js" type="text/javascript"></script>$().ready(function() {  
  4.        $("#signupForm").validate();  
  5. });  
  6. <form id="signupForm" method="get" action="">  
  7.     <p>  
  8.         <label for="firstname">Firstname</label>  
  9.         <input id="firstname" name="firstname" class="required" />  
  10.     </p>  
  11. <p>  
  12.    <label for="email">E-Mail</label>  
  13.    <input id="email" name="email" class="required email" />  
  14. </p>  
  15. <p>  
  16.    <label for="password">Password</label>  
  17.    <input id="password" name="password" type="password" class="{required:true,minlength:5}" />  
  18. </p>  
  19. <p>  
  20.    <label for="confirm_password">確認密碼</label>  
  21.    <input id="confirm_password" name="confirm_password" type="password" class="{required:true,minlength:5,equalTo:'#password'}" />  
  22. </p>  
  23.     <p>  
  24.         <input class="submit" type="submit" value="Submit"/>  
  25.     </p>  


</form>使用class="{}"的方式,必須引入包:jquery.metadata.js可以使用如下的方法,修改提示內容:
class="{required:true,minlength:5,messages:{required:'請輸入內容'}}"在使用equalTo關鍵字時,後面的內容必須加上引號,如下程式碼:
class="{required:true,minlength:5,equalTo:'#password'}"另外一個方式,使用關鍵字:meta(為了後設資料使用其他外掛你要包裝 你的驗證規則 在他們自己的專案中可以用這個特殊的選項)
Tell the validation plugin to look inside a validate-property in metadata for validation rules.
例如:
[html] view plain copy
 print?
  1. meta: "validate"  
  2. <input id="password" name="password" type="password" class="{validate:{required:true,minlength:5}}" />  
  3. 再有一種方式:  
  4. $.metadata.setType("attr", "validate");這樣可以使用validate="{required:true}"的方式,或者class="required",但class="{required:true,minlength:5}"將不起作用 2.將校驗規則寫到程式碼中  
  5.   
  6. $().ready(function() {  
  7.         $("#unionRegForm").validate({  
  8.                 rules: {  
  9.                 username:{ required:true, rangelength:[6,15] },  
  10.                 email:{ required:true, email:true},  
  11.                 password:{ required:true, rangelength:[6,15]},  
  12.                 password2:{ required:true, rangelength:[6,15], equalTo: "#password"}  
  13.                 },  
  14.                 messages: {  
  15.                 username:{ required:"請輸入使用者名稱", rangelength:"使用者名稱長度在6-15位之間"},  
  16.                 email:{ required:"請輸入Email地址", email:"請輸入正確的email地址"},  
  17.                 password:{ required:"請輸入密碼", rangelength:"密碼長度在6-15位之間"},  
  18.                 password2:{ required:"請輸入確認密碼", rangelength:"確認密碼不能小於6個字元", equalTo:"兩次輸入密碼不一致不一致"}  
  19.                 }  
  20.         });  
  21. });  
  22. //messages處,如果某個控制元件沒有message,將呼叫預設的資訊  
  23. <form id="signupForm" method="get" action="">  
  24.     <p>  
  25.         <label for="firstname">Firstname</label>  
  26.         <input id="firstname" name="firstname" />  
  27.     </p>  
  28. <p>  
  29.    <label for="email">E-Mail</label>  
  30.    <input id="email" name="email" />  
  31. </p>  
  32. <p>  
  33.    <label for="password">Password</label>  
  34.    <input id="password" name="password" type="password" />  
  35. </p>  
  36. <p>  
  37.    <label for="confirm_password">確認密碼</label>  
  38.    <input id="confirm_password" name="confirm_password" type="password" />  
  39. </p>  
  40.     <p>  
  41.         <input class="submit" type="submit" value="Submit"/>  
  42.     </p>  
  43. </form>  

required:true 必須有值
required:"#aa:checked"表示式的值為真,則需要驗證
required:function(){}返回為真,表時需要驗證
後邊兩種常用於,表單中需要同時填或不填的元素

五、常用方法及注意問題

1.用其他方式替代預設的SUBMIT$().ready(function() {
$("#signupForm").validate({
        submitHandler:function(form){
            alert("submitted");    
            form.submit();
        }     
    });
});可以設定validate的預設值,寫法如下:
$.validator.setDefaults({
submitHandler: function(form) { alert("submitted!");form.submit(); }
});如果想提交表單, 需要使用form.submit()而不要使用$(form).submit()
2.debug,如果這個引數為true,那麼表單不會提交,只進行檢查,除錯時十分方便
$().ready(function() {
$("#signupForm").validate({
        debug:true
    });
});
如果一個頁面中有多個表單,用
$.validator.setDefaults({
   debug: true
})
3.ignore:忽略某些元素不驗證
ignore: ".ignore"
4.errorPlacement:Callback Default: 把錯誤資訊放在驗證的元素後面 
指明錯誤放置的位置,預設情況是:error.appendTo(element.parent());即把錯誤資訊放在驗證的元素後面 
[html] view plain copy
 print?
  1. errorPlacement: function(error, element) {     
  2.     error.appendTo(element.parent());     
  3. }//示例:  
  4. <tr>  
  5.     <td class="label"><label id="lfirstname" for="firstname">First Name</label></td>  
  6.     <td class="field"><input id="firstname" name="firstname" type="text" value="" maxlength="100" /></td>  
  7.     <td class="status"></td>  
  8. </tr>  
  9. <tr>  
  10.     <td style="padding-right: 5px;">  
  11.         <input id="dateformat_eu" name="dateformat" type="radio" value="0" />  
  12.         <label id="ldateformat_eu" for="dateformat_eu">14/02/07</label>  
  13.     </td>  
  14.     <td style="padding-left: 5px;">  
  15.         <input id="dateformat_am" name="dateformat" type="radio" value="1" />  
  16.         <label id="ldateformat_am" for="dateformat_am">02/14/07</label>  
  17.     </td>  
  18.     <td></td>  
  19. </tr>  
  20. <tr>  
  21.     <td class="label"> </td>  
  22.     <td class="field" colspan="2">  
  23.         <div id="termswrap">  
  24.             <input id="terms" type="checkbox" name="terms" />  
  25.             <label id="lterms" for="terms">I have read and accept the Terms of Use.</label>  
  26.         </div>  
  27.     </td>  
  28. </tr>errorPlacement: function(error, element) {  
  29.     if ( element.is(":radio") )  
  30.         error.appendTo( element.parent().next().next() );  
  31.     else if ( element.is(":checkbox") )  
  32.         error.appendTo ( element.next() );  
  33.     else  
  34.         error.appendTo( element.parent().next() );  
  35. }  

程式碼的作用是:一般情況下把錯誤資訊顯示在<td class="status"></td>中,如果是radio顯示在<td></td>中,如果是checkbox顯示在內容的後面errorClass:String Default: "error" 
指定錯誤提示的css類名,可以自定義錯誤提示的樣式errorElement:String Default: "label" 
用什麼標籤標記錯誤,預設的是label你可以改成emerrorContainer:Selector 
顯示或者隱藏驗證資訊,可以自動實現有錯誤資訊出現時把容器屬性變為顯示,無錯誤時隱藏,用處不大
errorContainer: "#messageBox1, #messageBox2"errorLabelContainer:Selector 
把錯誤資訊統一放在一個容器裡面。wrapper:String
用什麼標籤再把上邊的errorELement包起來一般這三個屬性同時使用,實現在一個容器內顯示所有錯誤提示的功能,並且沒有資訊時自動隱藏errorContainer: "div.error",
errorLabelContainer: $("#signupForm div.error"),
wrapper: "li" 設定錯誤提示的樣式,可以增加圖示顯示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; }
label.checked { background:url("./demo/images/checked.gif") no-repeat 0px 0px;}success:String,Callback 
要驗證的元素通過驗證後的動作,如果跟一個字串,會當做一個css類,也可跟一個函式
success: function(label) {
    // set &nbsp; as text for IE
    label.html("&nbsp;").addClass("checked");
    //label.addClass("valid").text("Ok!")
}
新增"valid" 到驗證元素, 在CSS中定義的樣式<style>label.valid {}</style>
success: "valid" nsubmit: Boolean Default: true 
提交時驗證. 設定唯false就用其他方法去驗證
onfocusout:Boolean Default: true 
失去焦點是驗證(不包括checkboxes/radio buttons) 
onkeyup:Boolean Default: true 
在keyup時驗證.
onclick:Boolean Default: true 
在checkboxes 和 radio 點選時驗證
focusInvalid:Boolean Default: true 
提交表單後,未通過驗證的表單(第一個或提交之前獲得焦點的未通過驗證的表單)會獲得焦點
focusCleanup:Boolean Default: false 
如果是true那麼當未通過驗證的元素獲得焦點時,移除錯誤提示。避免和 focusInvalid 一起用 // 重置表單
$().ready(function() {
var validator = $("#signupForm").validate({
        submitHandler:function(form){
            alert("submitted");    
            form.submit();
        }     
    });
    $("#reset").click(function() {
        validator.resetForm();
    });}); remote:URL
使用ajax方式進行驗證,預設會提交當前驗證的值到遠端地址,如果需要提交其他的值,可以使用data選項remote: "check-email.php"remote: {
    url: "check-email.php",     //後臺處理程式
    type: "post",               //資料傳送方式
    dataType: "json",           //接受資料格式    
    data: {                     //要傳遞的資料
        username: function() {
            return $("#username").val();
        }
    }
}
遠端地址只能輸出 "true" 或 "false",不能有其它輸出 addMethod:name, method, message
自定義驗證方法
[html] view plain copy
 print?
  1.   
[html] view plain copy
 print?
  1. // 中文字兩個位元組  
  2. jQuery.validator.addMethod("byteRangeLength", function(value, element, param) {  
  3.     var length = value.length;  
  4.     for(var i = 0; i < value.length; i++){  
  5.         if(value.charCodeAt(i) > 127){  
  6.             length++;  
  7.         }  
  8.     }  
  9. return this.optional(element) || ( length >= param[0] && length <= param[1] );      
  10. }, $.validator.format("請確保輸入的值在{0}-{1}個位元組之間(一箇中文字算2個位元組)"));  
  11. // 郵政編碼驗證      
  12. jQuery.validator.addMethod("isZipCode", function(value, element) {      
  13.     var tel = /^[0-9]{6}$/;  
  14.     return this.optional(element) || (tel.test(value));  
  15. }, "請正確填寫您的郵政編碼");  
  16. radio和checkbox、select的驗證radio的required表示必須選中一個  
  17. <input type="radio" id="gender_male" value="m" name="gender" class="{required:true}" />  
  18. <input type="radio" id="gender_female" value="f" name="gender"/>checkbox的required表示必須選中  
  19. <input type="checkbox" class="checkbox" id="agree" name="agree" class="{required:true}" />checkbox的minlength表示必須選中的最小個數,maxlength表示最大的選中個數,rangelength:[2,3]表示選中個數區間  
  20. <input type="checkbox" class="checkbox" id="spam_email" value="email" name="spam[]" class="{required:true, minlength:2}" />  
  21. <input type="checkbox" class="checkbox" id="spam_phone" value="phone" name="spam[]" />  
  22. <input type="checkbox" class="checkbox" id="spam_mail" value="mail" name="spam[]" />  
  23. select的required表示選中的value不能為空  
  24. <select id="jungle" name="jungle" title="Please select something!" class="{required:true}">  
  25.     <option value=""></option>  
  26.     <option value="1">Buga</option>  
  27.     <option value="2">Baga</option>  
  28.     <option value="3">Oi</option>  
  29. </select>  
  30. select的minlength表示選中的最小個數(可多選的select),maxlength表示最大的選中個數,rangelength:[2,3]表示選中個數區間  
  31. <select id="fruit" name="fruit" title="Please select at least two fruits" class="{required:true, minlength:2}" multiple="multiple">  
  32.     <option value="b">Banana</option>  
  33.     <option value="a">Apple</option>  
  34.     <option value="p">Peach</option>  
  35.     <option value="t">Turtle</option>  
  36. </select>  
  37. // 手機號碼驗證   
  38. jQuery.validator.addMethod("mobile", function(value, element) {   
  39. var length = value.length;   
  40. var mobile = /^(((13[0-9]{1})|(15[0-9]{1}))+\d{8})$/   
  41. return this.optional(element) || (length == 11 && mobile.test(value));   
  42. }, "手機號碼格式錯誤");   
  43.   
  44. // 電話號碼驗證   
  45. jQuery.validator.addMethod("phone", function(value, element) {   
  46. var tel = /^(0[0-9]{2,3}\-)?([2-9][0-9]{6,7})+(\-[0-9]{1,4})?$/;   
  47. return this.optional(element) || (tel.test(value));   
  48. }, "電話號碼格式錯誤");   
  49.   
  50. // 郵政編碼驗證   
  51. jQuery.validator.addMethod("zipCode", function(value, element) {   
  52. var tel = /^[0-9]{6}$/;   
  53. return this.optional(element) || (tel.test(value));   
  54. }, "郵政編碼格式錯誤");   
  55.   
  56. // QQ號碼驗證   
  57. jQuery.validator.addMethod("qq", function(value, element) {   
  58. var tel = /^[1-9]\d{4,9}$/;   
  59. return this.optional(element) || (tel.test(value));   
  60. }, "qq號碼格式錯誤");   
  61.   
  62. // IP地址驗證   
  63. jQuery.validator.addMethod("ip", function(value, element) {   
  64. var ip = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;   
  65. return this.optional(element) || (ip.test(value) && (RegExp.$1 < 256 && RegExp.$2 < 256 && RegExp.$3 < 256 && RegExp.$4 < 256));   
  66. }, "Ip地址格式錯誤");   
  67.   
  68. // 字母和數字的驗證   
  69. jQuery.validator.addMethod("chrnum", function(value, element) {   
  70. var chrnum = /^([a-zA-Z0-9]+)$/;   
  71. return this.optional(element) || (chrnum.test(value));   
  72. }, "只能輸入數字和字母(字元A-Z, a-z, 0-9)");   
  73.   
  74. // 中文的驗證   
  75. jQuery.validator.addMethod("chinese", function(value, element) {   
  76. var chinese = /^[\u4e00-\u9fa5]+$/;   
  77. return this.optional(element) || (chinese.test(value));   
  78. }, "只能輸入中文");   
  79.   
  80. // 下拉框驗證   
  81. $.validator.addMethod("selectNone", function(value, element) {   
  82. return value == "請選擇";   
  83. }, "必須選擇一項");   
  84.   
  85. // 位元組長度驗證   
  86. jQuery.validator.addMethod("byteRangeLength", function(value, element, param) {   
  87. var length = value.length;   
  88. for (var i = 0; i < value.length; i++) {   
  89. if (value.charCodeAt(i) > 127) {   
  90. length++;   
  91. }   
  92. }   
  93. return this.optional(element) || (length >= param[0] && length <= param[1]);   
  94. }, $.validator.format("請確保輸入的值在{0}-{1}個位元組之間(一箇中文字算2個位元組)"));  

轉自 : http://blog.csdn.net/lufeng20/article/details/7629813