DIV CSS 佈局教程網

jQuery Validation 插件完全指南:規則、提示、美化與遠程校驗
編輯:JQuery入門技巧     

前言

前端開發中最常寫的 JavaScript 邏輯之一就是表單驗證。jQuery 生態裡對此有個歷史悠久、久經考驗的答案——Validation 插件。它經過大量真實項目打磨,約定俗成地成為了表單校驗的事實標準之一。

概述與特點

Validation 為表單提供強大的校驗能力,讓客戶端驗證變得簡單,同時開放了大量定制選項。插件捆綁了一套常用校驗方法(URL、郵箱等),並提供 API 供你編寫自己的規則。默認提示信息為英文,官方已翻譯成 37 種語言。

它的幾個主要特點:

1、內置規則豐富:必填、數字、E-Mail、URL、信用卡號等共 19 類。

2、易於自定義:通過 addMethod() 添加業務規則。

3、提示機制完善:默認提示可直接用,也可自定義覆蓋。

4、實時驗證:支持 keyup、blur 等時機觸發。

引入方式

作為 jQuery 插件,必須在 jQuery 之後引入,順序不能顛倒:

 <script src="https://files.cnblogs.com/files/xiaohuochai/jquery-1.10.0.js"></script>
 <script src="https://files.cnblogs.com/files/xiaohuochai/jquery.validate-1.13.1.js"></script>

快速上手

插件 API 眾多,但起步只需要掌握 validate():

 <form id="demoForm">
 <p>
 <label for="username">用戶名:</label>
 <input type="text" id="username" name="username"/>
 </p>
 <p>
 <label for="password">密碼:</label>
 <input type="password" id="password" name="password"/>
 </p>
 <p>
 <input type="submit" value="登錄"/>
 </p>
 </form>

 <script>
 $('#demoForm').validate({
   rules:{
     username:{ required: true, minlength: 2, maxlength: 10 },
     password:{ required: true, minlength: 2, maxlength:10 }
   }
 })
 </script>

這段代碼對 name 為 username 和 password 的控件做了限制:必填,長度 2 到 10 之間。注意規則是掛在 name 屬性上的,不是 id——這是新手最常踩的坑。

內在校驗規則一覽

 序號 規則 描述
 required:true        必須輸入的字段
 remote:"check.php"   使用 ajax 方法調用 check.php 驗證輸入值
 email:true           必須輸入正確格式的電子郵件
 url:true             必須輸入正確格式的網址
 date:true            必須輸入正確格式的日期,內部調用 Date.parse() 方法進行校驗
 dateISO:true         必須輸入正確格式的日期(ISO),如:2009-06-23,1998/01/22
 number:true          必須輸入合法的數字(負數,小數)
 digits:true          必須輸入整數
 creditcard           必須輸入合法的信用卡號
 equalTo:"#field"     輸入值必須和 #field 相同
 accept               輸入擁有合法後綴名的字符串(上傳文件的後綴)
 maxlength:5          輸入長度最多是 5 的字符串(漢字算一個字符)
 minlength:10         輸入長度最小是 10 的字符串(漢字算一個字符)
 rangelength:[5,10]   輸入長度必須介於 5 和 10 之間的字符串(漢字算一個字符)
 range:[5,10]         輸入值必須介於 5 和 10 之間
 max:5                輸入值不能大於 5
 min:10               輸入值不能小於 10

下面用一個更完整的表單把這些規則串起來:

 <form id="demoForm">
 <p><label for="username">用戶名:</label><input type="text" id="username" name="username"/></p>
 <p><label for="password">密碼:</label><input type="password" id="password" name="password"/></p>
 <p><label for="confirm-password">確認密碼</label><input type="password" id="confirm-password" name="confirm-password"/></p>
 <p><label for="email">電子郵件:</label><input id="email" name="email"/></p>
 <p><label for="url">網址:</label><input id="url" name="url"/></p>
 <p><label for="date">生日:</label><input id="date" name="date"/></p>
 <p><label for="num">隨機數(0-9):</label><input id="num" name="num"/></p>
 <p><label for="card">信用卡號:</label><input id="card" name="card"/></p>
 <p><input type="submit" value="登錄"/></p>
 </form>

 <script>
 $('#demoForm').validate({
   rules:{
     username:{ required: true, maxlength: 10 },
     password:{ required: true, range:[5,10] },
     'confirm-password':{ equalTo: "#password" },
     email:{ email:true },
     url:{ url:true },
     date:{ dateISO:true },
     num:{ min:0, max:9 },
     card:{ creditcard:true }
   }
 })
 </script>

默認提示是英文的

 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 ).",
   number: "Please enter a valid number.",
   digits: "Please enter only digits.",
   creditcard: "Please enter a valid credit card number.",
   equalTo: "Please enter the same value again.",
   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}." )
 }

改成中文只需在頁面裡追加一段擴展:

 $.extend($.validator.messages, {
   required: "這是必填字段",
   remote: "請修正此字段",
   email: "請輸入有效的電子郵件地址",
   url: "請輸入有效的網址",
   date: "請輸入有效的日期",
   dateISO: "請輸入有效的日期 (YYYY-MM-DD)",
   number: "請輸入有效的數字",
   digits: "只能輸入數字",
   creditcard: "請輸入有效的信用卡號碼",
   equalTo: "你的輸入不相同",
   extension: "請輸入有效的後綴",
   maxlength: $.validator.format("最多可以輸入 {0} 個字符"),
   minlength: $.validator.format("最少要輸入 {0} 個字符"),
   rangelength: $.validator.format("請輸入長度在 {0} 到 {1} 之間的字符串"),
   range: $.validator.format("請輸入范圍在 {0} 到 {1} 之間的數值"),
   max: $.validator.format("請輸入不大於 {0} 的數值"),
   min: $.validator.format("請輸入不小於 {0} 的數值")
 });

這段全局翻譯通常單獨放在一個 messages_zh.js 文件裡,全站複用。

第二種寫法:把規則寫進 HTML

除了 JS 配置,還可以直接用 class 或 HTML 屬性聲明規則,風格接近 HTML5 的 required、pattern。此時 validate() 的參數留空即可。

 <form id="demoForm">
 <p><label for="username">用戶名:</label><input type="text" id="username" name="username" class="required" minlength="2"/></p>
 <p><label for="email">電子郵件:</label><input id="email" name="email" class="required email"/></p>
 <p><label for="url">網址:</label><input id="url" name="url" class="url"/></p>
 <p><input type="submit" value="登錄"/></p>
 </form>

 <script>
 $('#demoForm').validate({})
 </script>

兩種方式可以混用,實踐中常見的做法是通用規則寫在 JS 裡集中管理,特殊字段則就近用 class 標註。

自定義提示文字

項目文案往往和插件默認不同,用 messages 覆蓋即可。某字段沒寫就沿用默認。其中 {0} 會被替換為該規則的參數值。

 <form id="demoForm">
 <p><label for="username">用戶名:</label><input type="text" id="username" name="username" /></p>
 <p><label for="email">電子郵件:</label><input id="email" name="email" /></p>
 <p><label for="url">網址:</label><input id="url" name="url"/></p>
 <p><input type="submit" value="登錄"/></p>
 </form>

 <script>
 $('#demoForm').validate({
   rules:{
     username:{ required: true, minlength: 2, maxlength: 10 },
     email:{ required: true, email:true },
     url:{ required: true, url:true }
   },
   messages:{
     username:{
       required:"請輸入用戶名",
       minlength:"至少輸入{0}個字符"
     },
     email:{
       required:"請輸入郵箱",
       email:"郵箱格式不正確"
     },
     url:{
       required:"請輸入網址",
       url:"網址格式不正確(完整的網址應包括https://或https://)"
     }
   }
 })
 </script>

美化提示樣式

插件的做法是:在輸入框右側插入一個 label,id 為「輸入控件id-error」,class 為 error。

相關配置項:

 參數 類型 默認值 描述
 errorClass String "error"          指定錯誤提示的 css 類名
 errorElement String "label"        用什麼標簽標記錯誤
 errorContainer Selector 無         顯示或者隱藏驗證信息,可以自動實現有錯誤信息出現時把容器屬性變為顯示,無錯誤時隱藏,用處不大。如 errorContainer: "#messageBox1, #messageBox2"
 errorLabelContainer Selector 無    把錯誤信息統一放在一個容器裡面
 wrapper String 無                  用什麼標簽再把上邊的 errorElement 包起來

【成功樣式】

插件提供 success 選項,用於設置校驗通過後的行為,可傳字符串(當作 css 類)或函數:

success:String, Callback

 success: function(label) {
   label.html(" ").addClass("success");
 }

 // 或者
 success: "success"

但實測中發現一個問題:success 只是給 label 追加了 success 類,原有的 error 類並沒有被移除;而若手動刪除 error 類,插件在下次校驗通過時又會重新生成一個 label。結果就是成功樣式很難正常呈現,這基本可以判定為插件自身的一個缺陷。實踐中若確有該需求,建議通過 errorPlacement 自行控制 DOM,繞開這一限制。

常見做法是自己寫一段 CSS 給 label.error 加個小圖標:

 <style>
 label.error{
   background: no-repeat 0 4px;
   background-image:url('unchecked.gif');
   margin-left:6px;
   padding-left:14px;
   color:red;
 }
 </style>

自定義驗證規則

內置規則覆蓋不了業務需求時,用 addMethod() 擴展。

【addMethod(name, method, message)】

name 是方法名;method 是驗證函數,接收 (value, element, param) 三個參數,分別是元素值、元素本身、額外參數,返回 true 表示通過;message 是提示文案。

以手機號為例。大陸號碼一般 11 位,前 3 位是號段,開頭可能帶 0 或 +86:

 // 開頭 (0|\+86)?
 // 前3位 13\d|14[579]|15[0-35-9]|17[0135-8]|18\d
 // 後8位 \d{8}

 // 手機號碼
 var phone = /^(0|\+86)?(13\d|14[579]|15[0-35-9]|17[0135-8]|18\d)\d{8}$/;

註冊為校驗方法:

 $.validator.addMethod(
   'phone',
   function(value, element, param){
     var reg = /^(0|\+86)?(13\d|14[579]|15[0-35-9]|17[0135-8]|18\d)\d{8}$/;
     return reg.test(value);
   },
   '請輸入正確的手機號碼'
 );

然後就能像內置規則一樣使用:

 <style>
 label.error{
   margin-left:6px;
   padding-left:14px;
   color:red;
   background: no-repeat 0 4px;
   background-image:url('data:image/gif;base64,R0lGODlhDgAOAMQAAOpSAPWpgPvf0O5zMPGIUPe+n////+tdEPjJsP718POecO1oIPrUwPzq4Pa0kPKTYPSof////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAUUABEALAAAAAAOAA4AAAVcYCQm0AAAA5SIbHGcMHAULazEJ528AGIsgADDIUsEYAYDopBsAAOmXDLpOkVPB0ETFxskpjeY6fD4GhrJBAF1zCYDBx/jFYi8DoEH9yAqcGM0fTwxMywsUFZ1LCEAOw==');
 }
 </style>

 <form id="demoForm">
 <p><label for="phone">手機號碼:</label><input type="text" id="phone" name="phone" /></p>
 <p><input type="button" value="提交"></p>
 </form>

 <script>
 $.validator.addMethod( 'phone', function(value,element,param){
   var reg = /^(0|\+86)?(13\d|14[579]|15[0-35-9]|17[0135-8]|18\d)\d{8}$/;
   return reg.test(value);
 }, '請輸入正確的手機號碼' );

 $('#demoForm').validate({
   rules:{
     phone:{ required: true, phone:true }
   },
   messages:{
     phone:{ required:"請輸入手機號碼" }
   }
 })
 </script>

手機號段是會隨時間變化的(新號段不斷放出),這段正則建議按當前最新號段維護,或者放寬規則改由後端校驗。

調整觸發時機

以下選項多為 boolean 型,一般保持默認即可,除非明確需要關閉某個:

 觸發方式 類型 描述 默認值
 onsubmit Boolean       提交時驗證。設置為 false 就用其他方法去驗證          true
 onfocusout Boolean     失去焦點時驗證(不包括復選框/單選按鈕)                 true
 onkeyup Boolean        在 keyup 時驗證                                        true
 onclick Boolean        在點擊復選框和單選按鈕時驗證                            true
 focusInvalid Boolean   提交表單後,未通過驗證的表單會獲得焦點                   true
 focusCleanup Boolean   如果是 true,當未通過驗證的元素獲得焦點時,移除錯誤提示   false

遠程校驗

有些校驗只能靠服務端完成,比如「用戶名是否已被註冊」。用 remote 即可,插件會自動把當前字段的值 POST 到指定地址。若需提交其他字段,用 data 選項(支持函數)。

[注意] 遠程地址只能輸出 "true" 或 "false",不能有其他輸出,否則解析會失敗。

 remote: {
   url: "check-email.php",  //後台處理程序
   type: "post",            //數據發送方式
   dataType: "json",        //接受數據格式
   data: {                  //要傳遞的數據
     username: function() {
       return $("#username").val();
     }
   }
 }

完整示例:

 <form id="demoForm">
 <p>
 <label for="num">請選擇數字</label>
 <select name="num" id="num">
 <option value="1">1</option>
 <option value="2">2</option>
 <option value="3">3</option>
 </select>
 </p>
 <p><input type="button" value="提交"></p>
 </form>

 <script>
 $('#demoForm').validate({
   rules:{
     num:{ remote:"validateTest.php" }
   },
   messages:{
     num:{ remote:"選擇的數字不正確" }
   }
 });
 </script>

對應的服務端:

 <?php
 function test_input($data) {
   $data = trim($data);
   $data = stripslashes($data);
   $data = htmlspecialchars($data);
   return $data;
 }

 $data = test_input($_REQUEST['num']);

 if($data == '2'){
   echo "true";
 }else{
   echo "false";
 }
 ?>

需要提醒的是,遠程校驗會在每次 keyup 時都發一次請求,字段多、用戶輸入快時容易打出大量無效請求。實踐中建議加防抖(debounce)延遲,或者把 onkeyup 關掉只留 onfocusout。

最後

Validation 的能力不止於此,本文覆蓋了日常開發中的主力功能。更高級的用法建議直接查閱官方文檔。

順帶說一個有趣的細節:validate、validation、validator 三個詞中文都是「驗證」,但它們在這個插件裡各有所指——插件的 js 文件名是 validate.js;最常用的調用方法是 validate(),幾乎所有校驗配置都通過它完成;而自定義規則則要掛在 validator 對象的靜態方法 addMethod() 上。三者層級不同,別混用。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved