jQuery Validate
jQuery Validate 外掛程式為表單提供了強大的驗證功能，讓客戶端表單驗證變得更簡單，同時提供了大量的自訂選項，滿足應用程式各種需求。該外掛程式捆綁了一套有用的驗證方法，包括 URL 和電子郵件驗證，同時提供了一個用來編寫使用者自訂方法的 API。所有的捆綁方法預設使用英語作為錯誤訊息，且已翻譯成其他 37 種語言。
該外掛程式是由 Jörn Zaefferer 編寫和維護的，他是 jQuery 團隊的一名成員，是 jQuery UI 團隊的主要開發人員，是 QUnit 的維護人員。該插件在 2006 年 jQuery 早期的時候就已經開始出現，並且一直更新至今。目前版本是 1.14.0。
造訪 jQuery Validate 官網，下載最新版的 jQuery Validate 外掛。
匯入js 函式庫
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/lib/jquery.js"></script> <script src="http://static.runoob.com/assets/jquery-validation-1.14.0/dist/jquery.validate.min.js"></script>
預設校驗規則
| #序號 | #規則 | 描述 |
|---|---|---|
| 1 | required:true | #必須輸入的欄位。 |
| 2 | remote:"check.php" | 使用 ajax 方法呼叫 check.php 驗證輸入值。 |
| 3 | email:true | 必須輸入正確格式的電子郵件。 |
| 4 | url:true | 必須輸入正確格式的網址。 |
| 5 | date:true | 必須輸入正確格式的日期。日期校驗 ie6 出錯，慎用。 |
| 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 ).",
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}." )}jQuery Validate提供了中文資訊提示包，位於下載包的dist/localization/messages_zh.js，內容如下：
(function( factory ) {if ( typeof define === "function" && define.amd ) {
define( ["jquery", "../jquery.validate"], factory );} else {
factory( jQuery );}}(function( $ ) {/*
* Translated default messages for the jQuery validation plugin.
* Locale: ZH (Chinese, 中文 (Zhōngwén), 汉语, 漢語)
*/$.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} 的数值")});}));你可以將該本地化訊息檔案dist/localization/messages_zh.js 引進到頁面：
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/dist/localization/messages_zh.js"></script>
使用方式
1、將校驗規則寫到控制項中
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>PHP中文网（php.cn）</title>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/lib/jquery.js"></script>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/dist/jquery.validate.min.js"></script>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/dist/localization/messages_zh.js"></script>
<script>
$.validator.setDefaults({
submitHandler: function() {
alert("提交事件!");
}
});
$().ready(function() {
$("#commentForm").validate();
});
</script>
<style>
.error{
color:red;
}
</style>
</head>
<body>
<form class="cmxform" id="commentForm" method="get" action="">
<fieldset>
<legend>输入您的名字，邮箱，URL，备注。</legend>
<p>
<label for="cname">Name (必需, 最小两个字母)</label>
<input id="cname" name="name" minlength="2" type="text" required>
</p>
<p>
<label for="cemail">E-Mail (必需)</label>
<input id="cemail" type="email" name="email" required>
</p>
<p>
<label for="curl">URL (可选)</label>
<input id="curl" type="url" name="url">
</p>
<p>
<label for="ccomment">备注 (必需)</label>
<textarea id="ccomment" name="comment" required></textarea>
</p>
<p>
<input class="submit" type="submit" value="Submit">
</p>
</fieldset>
</form>
</body>
</html>#試試看
#2、將校驗規則寫到js 程式碼中
$().ready(function() {// 在键盘按下并释放及提交后验证提交表单
$("#signupForm").validate({
rules: {
firstname: "required",
lastname: "required",
username: {
required: true,
minlength: 2 },
password: {
required: true,
minlength: 5 },
confirm_password: {
required: true,
minlength: 5,
equalTo: "#password" },
email: {
required: true,
email: true },
topic: {
required: "#newsletter:checked",
minlength: 2 },
agree: "required" },
messages: {
firstname: "请输入您的名字",
lastname: "请输入您的姓氏",
username: {
required: "请输入用户名",
minlength: "用户名必需由两个字母组成" },
password: {
required: "请输入密码",
minlength: "密码长度不能小于 5 个字母" },
confirm_password: {
required: "请输入密码",
minlength: "密码长度不能小于 5 个字母",
equalTo: "两次密码输入不一致" },
email: "请输入一个正确的邮箱",
agree: "请接受我们的声明",
topic: "请选择两个主题" }});messages 處，如果某個控制項沒有message，會呼叫預設的資訊
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>PHP中文网（php.cn）</title>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/lib/jquery.js"></script>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/dist/jquery.validate.min.js"></script>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/dist/localization/messages_zh.js"></script>
<script>
$.validator.setDefaults({
submitHandler: function() {
alert("提交事件!");
}
});
$().ready(function() {
// 在键盘按下并释放及提交后验证提交表单
$("#signupForm").validate({
rules: {
firstname: "required",
lastname: "required",
username: {
required: true,
minlength: 2
},
password: {
required: true,
minlength: 5
},
confirm_password: {
required: true,
minlength: 5,
equalTo: "#password"
},
email: {
required: true,
email: true
},
"topic[]": {
required: "#newsletter:checked",
minlength: 2
},
agree: "required"
},
messages: {
firstname: "请输入您的名字",
lastname: "请输入您的姓氏",
username: {
required: "请输入用户名",
minlength: "用户名必需由两个字母组成"
},
password: {
required: "请输入密码",
minlength: "密码长度不能小于 5 个字母"
},
confirm_password: {
required: "请输入密码",
minlength: "密码长度不能小于 5 个字母",
equalTo: "两次密码输入不一致"
},
email: "请输入一个正确的邮箱",
agree: "请接受我们的声明",
topic: "请选择两个主题"
}
});
});
</script>
<style>
.error{
color:red;
}
</style>
</head>
<body>
<form class="cmxform" id="signupForm" method="get" action="">
<fieldset>
<legend>验证完整的表单</legend>
<p>
<label for="firstname">名字</label>
<input id="firstname" name="firstname" type="text">
</p>
<p>
<label for="lastname">姓氏</label>
<input id="lastname" name="lastname" type="text">
</p>
<p>
<label for="username">用户名</label>
<input id="username" name="username" type="text">
</p>
<p>
<label for="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>
<label for="email">Email</label>
<input id="email" name="email" type="email">
</p>
<p>
<label for="agree">请同意我们的声明</label>
<input type="checkbox" class="checkbox" id="agree" name="agree">
</p>
<p>
<label for="newsletter">我乐意接收新信息</label>
<input type="checkbox" class="checkbox" id="newsletter" name="newsletter">
</p>
<fieldset id="newsletter_topics">
<legend>主题 (至少选择两个) - 注意：如果没有勾选“我乐意接收新信息”以下选项会隐藏，但我们这里作为演示让它可见</legend>
<label for="topic_marketflash">
<input type="checkbox" id="topic_marketflash" value="marketflash" name="topic[]">Marketflash
</label>
<label for="topic_fuzz">
<input type="checkbox" id="topic_fuzz" value="fuzz" name="topic[]">Latest fuzz
</label>
<label for="topic_digester">
<input type="checkbox" id="topic_digester" value="digester" name="topic[]">Mailing list digester
</label>
<label for="topic" class="error" style="display:none">至少选择两个</label>
</fieldset>
<p>
<input class="submit" type="submit" value="提交">
</p>
</fieldset>
</form>
</body>
</html>試試看
#required: true 值是必須的。
required: "#aa:checked" 表達式的值為真，則需要驗證。
required: function(){} 傳回為真，表示需要驗證。
後邊兩種常用於，表單中需要同時填入或不填入的元素。
常用方法及注意問題
1、用其他方式取代預設的SUBMIT
$().ready(function() {
$("#signupForm").validate({
submitHandler:function(form){
alert("提交事件!");
form.submit(); }
});});使用ajax 方式
$(".selector").validate({
submitHandler: function(form)
{
$(form).ajaxSubmit();
}
})可以設定validate 的預設值，寫法如下：
$.validator.setDefaults({
submitHandler: function(form) { alert("提交事件!");form.submit(); }});如果想提交表單, 需要使用form.submit()，而不要使用$(form).submit()。
2、debug，只驗證不提交表單
如果這個參數是true，那麼表單就不會提交，只進行檢查，調試時十分方便。
$().ready(function() {
$("#signupForm").validate({
debug:true });});如果一個頁面中有多個表單都想設定成為debug，則使用：
$.validator.setDefaults({
debug: true})3、ignore：忽略某些元素不驗證
ignore: ".ignore"
4、更改錯誤訊息顯示的位置
errorPlacement：Callback
指明錯誤放置的位置，預設是：error.appendTo(element.parent());即把錯誤訊息放在驗證的元素後面。
errorPlacement: function(error, element) {
error.appendTo(element.parent()); }實例
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>PHP中文网（php.cn）</title>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/lib/jquery.js"></script>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/dist/jquery.validate.min.js"></script>
<script src="http://static.runoob.com/assets/jquery-validation-1.14.0/dist/localization/messages_zh.js"></script>
<script>
$.validator.setDefaults({
submitHandler: function() {
alert("提交事件!");
}
});
$().ready(function() {
// 提交时验证表单
var validator = $("#form1").validate({
errorPlacement: function(error, element) {
// Append error within linked label
$( element )
.closest( "form" )
.find( "label[for='" + element.attr( "id" ) + "']" )
.append( error );
},
errorElement: "span",
messages: {
user: {
required: " (必需字段)",
minlength: " (不能少于 3 个字母)"
},
password: {
required: " (必需字段)",
minlength: " (字母不能少于 5 个且不能大于 12 个)",
maxlength: " (字母不能少于 5 个且不能大于 12 个)"
}
}
});
$(".cancel").click(function() {
validator.resetForm();
});
});
</script>
<style>
.error{
color:red;
}
</style>
</head>
<body>
<form method="get" class="cmxform" id="form1" action="">
<fieldset>
<legend>登录框</legend>
<p>
<label for="user">用户名</label>
<input id="user" name="user" required minlength="3">
</p>
<p>
<label for="password">密码</label>
<input id="password" type="password" maxlength="12" name="password" required minlength="5">
</p>
<p>
<input class="submit" type="submit" value="Login">
</p>
</fieldset>
</form>
</body>
</html>試試看
程式碼的作用是：一般情況下把錯誤訊息顯示在< td class="status"></td> 中，如果是radio 則顯示在<td></td> 中，如果是checkbox 則顯示在內容的後面。
| 參數 | 類型 | 描述 | 預設值 |
|---|---|---|---|
| errorClass | String | 指定錯誤提示的css 類別名，可以自訂錯誤提示的樣式。 | "error" |
| errorElement | String | 用什麼標籤標記錯誤，預設是 label，可以改成 em。 | "label" |
| errorContainer | #Selector | 顯示或隱藏驗證訊息，可以自動實作有錯誤訊息出現時把容器屬性變成顯示，無錯誤時隱藏，用處不大。 errorContainer: "#messageBox1, #messageBox2" | |
| errorLabelContainer | #Selector | 把錯誤訊息統一放在一個容器裡面。 | |
| wrapper | String | 用什麼標籤再把上邊的 errorELement 包起來。 |
一般這三個屬性同時使用，實現在一個容器內顯示所有錯誤提示的功能，並且沒有資訊時自動隱藏。
errorContainer: "div.error",errorLabelContainer: $("#signupForm div.error"),wrapper: "li"5、更改錯誤訊息顯示的樣式
設定錯誤提示的樣式，可以增加圖示顯示，在該系統中已經建立了一個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;}label.checked {
background:url("./demo/images/checked.gif") no-repeat 0px 0px;}6、每個欄位驗證透過執行函數
success：String,Callback
要驗證的元素通過驗證後的動作，如果跟一個字串，會當作一個css 類，也可跟一個函數。
success: function(label) { // set as text for IE
label.html(" ").addClass("checked"); //label.addClass("valid").text("Ok!")}新增 "valid" 到驗證元素，在 CSS 中定義的樣式 <style>label.valid {}</style>。
success: "valid"
7、驗證的觸發方式修改
下面的雖然是 boolean 型的，但建議除非要改為 false，否則別亂添加。
| 觸發方式 | #類型 | 描述 | 預設值 |
|---|---|---|---|
| onsubmit | Boolean | 提交時驗證。設定為 false 就用其他方法去驗證。 | |
| onfocusout | Boolean | 失去焦點時驗證（不包含複選框/單選按鈕）。 | |
| onkeyup | Boolean | 在 keyup 時驗證。 | |
| onclick | Boolean | 在點擊複選框和單選按鈕時驗證。 | |
| focusInvalid | Boolean | 提交表單後，未通過驗證的表單（第一個或提交之前獲得焦點的未通過驗證的表單）會獲得焦點。 | |
| focusCleanup | Boolean | 如果是true 那麼當未通過驗證的元素獲得焦點時，移除錯誤提示。避免和 focusInvalid 一起用。 |
// 重置表单$().ready(function() { var validator = $("#signupForm").validate({
submitHandler:function(form){
alert("submitted");
form.submit(); }
});
$("#reset").click(function() {
validator.resetForm(); });});8、非同步驗證
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"，不能有其他輸出。
9、新增自訂校驗
addMethod：name, method, message
自訂驗證方法
// 中文字两个字节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 檔案的引用。
10、radio 和 checkbox、select 的驗證
radio 的 required 表示必須選取一個。
<input type="radio" id="gender_male" value="m" name="gender" required /><input type="radio" id="gender_female" value="f" name="gender"/>
checkbox 的 required 表示必須選取。
<input type="checkbox" class="checkbox" id="agree" name="agree" required />
checkbox 的 minlength 表示必須選取的最小個數，maxlength 表示最大的選取個數，rangelength:[2,3] 表示選取個數區間。
<input type="checkbox" class="checkbox" id="spam_email" value="email" name="spam[]" required 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!" required> <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>jQuery.validate 中文API
| #名稱 | #描述 | |
|---|---|---|
| Validator | 驗證所選的FORM。 | |
| Boolean | 檢查是否驗證通過。 | |
| Options | 傳回元素的驗證規則。 | |
| Options | ||
| rules("remove",rules) | Options | |
| removeAttrs(attributes) | Options | |
| 自訂選擇器 | ||
| Validator | ||
| :filled | Array <Element> | |
Validator
validate 方法傳回一個 Validator 物件。 Validator 物件有很多方法可以用來引發校驗程式或改變 form 的內容，以下列出幾個常用的方法。
| 名稱 | 傳回類型 | 描述 |
|---|---|---|
| Boolean | 驗證form 回傳成功還是失敗。 | |
| Boolean | #驗證單一元素是成功還是失敗。 | |
| undefined | #把前面驗證的 FORM 恢復到驗證前原來的狀態。 | |
| undefined | 顯示特定的錯誤訊息。 | |
| undefined | ##改變預設的設定。 | |
| undefined | 新增一個新的驗證方法。必須包含一個獨一無二的名字，一個 JAVASCRIPT 的方法和一個預設的訊息。 | |
| undefined | 增加組合驗證類型，在一個類別裡面用多種驗證方法時比較有用。 | |
| undefined | 增加組合驗證類型，在一個類別裡面用多種驗證方法時比較有用。這個是同時加多個驗證方法。 | |
| 名稱 | 傳回類型 | 說明 |
|---|---|---|
| required () | Boolean | 必填驗證元素。 |
| required(dependency-expression) | Boolean | 必填元素依賴表達式的結果。 |
| required(dependency-callback) | Boolean | 必填元素依賴回呼函數的結果。 |
| remote(url) | Boolean | #請求遠端校驗。 url 通常是遠端呼叫方法。 |
| minlength(length) | Boolean | 設定最小長度。 |
| maxlength(length) | Boolean | 設定最大長度。 |
| rangelength(range) | Boolean | 設定一個長度範圍 [min,max]。 |
| min(value) | Boolean | #設定最小值。 |
| max(value) | Boolean | #設定最大值。 |
| email() | Boolean | 驗證電子郵件信箱格式。 |
| range(range) | Boolean | 設定值的範圍。 |
| url() | Boolean | 驗證 URL 格式。 |
| date() | Boolean | 驗證日期格式（類似30/30/2008 的格式，不驗證日期準確度只驗證格式） 。 |
| dateISO() | Boolean | #驗證 ISO 類型的日期格式。 |
| dateDE() | Boolean | #驗證德式的日期格式（29.04.1994 或 1.1.2006）。 |
| number() | Boolean | 驗證十進位數字（包括小數的）。 |
| digits() | Boolean | #驗證整數。 |
| creditcard() | Boolean | #驗證信用卡號。 |
| accept(extension) | Boolean | 驗證相同後綴名的字串。 |
| equalTo(other) | Boolean | 驗證兩個輸入框的內容是否相同。 |
| phoneUS() | Boolean | #驗證美式的電話號碼。 |
validate ()的可選項
| 描述 | #程式碼 |
|---|---|
