jquery.validate 大概是 jQuery 時代最普及的表單驗證套件,但也因為版本跨度太大、教學文章又互相矛盾,成為最多人卡關的地方。以下把兩個最常見的問題與其成因整理清楚。
早期文章的寫法依賴 jquery.metadata.js,把規則塞進 class:
<input class="{required:true, email:true,
messages:{required:'輸入email地址', email:'你輸入的不是有效的郵件地址'}}" />
這種寫法的問題很直觀:class 本來是給 CSS 抓樣式用的,現在同時肩負了驗證規則,樣式一改就可能弄壞驗證,可讀性也差。
較新版本(1.9 之後)改用 data- 屬性,把規則與提示分開寫,乾淨多了:
<script src="../js/jquery.js"></script>
<script src="../js/jquery.validate.js"></script>
<script>
$().ready(function () {
$("#registerForm").validate();
});
</script>
<form id="registerForm" method="get" action="">
<fieldset>
<p>
<label for="cusername">用戶名</label>
<input id="cusername" name="username" type="text"
data-rule-required="true"
data-rule-rangelength="[2,10]"
data-msg-required="用戶名不能為空"
data-msg-rangelength="用戶名長度必須是 2 到 10 個字符">
</p>
<p>
<label for="cpassword">密碼</label>
<input id="cpassword" name="password" type="password"
data-rule-required="true" data-rule-minlength="6"
data-msg-required="密碼不能為空" data-msg-minlength="至少設置 6 位密碼">
</p>
<p>
<label for="cconfirmpassword">確認密碼</label>
<input id="cconfirmpassword" name="confirmpassword" type="password"
data-rule-equalTo="#cpassword" data-msg-equalTo="兩次密碼不一致">
</p>
<p>
<label for="cemail">郵箱</label>
<input id="cemail" name="email"
data-rule-required="true" data-rule-email="true"
data-msg-required="郵箱不能為空" data-msg-email="郵箱的格式不正確">
</p>
<p>
<label for="chasreferee">有推薦人請勾選</label>
<input type="checkbox" id="chasreferee" name="hasreferee">
</p>
<p>
<label for="creferee">推薦人</label>
<input id="creferee" name="referee"
data-rule-required="#chasreferee:checked"
data-msg-required="推薦人不能為空">
</p>
<p><input type="submit" value="提交"></p>
</fieldset>
</form>
命名規則是 data-rule-<規則名> 與 data-msg-<規則名>。最後那個「勾選了才必填」的條件寫法(data-rule-required="#chasreferee:checked")尤其方便,不必另外寫 depends 函式。
如果把驗證規則寫在 class 或自訂屬性裡,又沒有正確載入/設定 metadata,就會在 1.13 版左右跳出這個錯誤,而且 messages 完全不生效。原因是套件試圖把某個規則名稱當成驗證方法去呼叫,卻找不到對應的 function。
<!-- 這種寫法在 1.13 之後容易出問題 -->
<script type="text/javascript" src="jquery.validate1.13.js"></script>
<script type="text/javascript" src="jquery.validate.message_cn.js"></script>
<script type="text/javascript" src="jquery.metadata.js"></script>
<script type="text/javascript">
$(function () {
$.metadata.setType("attr", "validate");
$("#signupForm").validate();
// 或 $("#signupForm").validate({ meta: "validate" });
});
</script>
<input id="email" name="email"
validate="{required:true, email:true,
messages:{required:'輸入email地址', email:'你輸入的不是有效的郵件地址'}}" />
網路上大量文章說這招可用,多半是因為它們寫於 metadata 還在 bundled 內的舊版本。遇到這個錯誤時,最省事的解法不是繼續調 metadata,而是改用 data-rule-*,或直接寫在 validate() 的設定裡——這也是下面建議的做法。
$("#signupForm").validate({
rules: {
email: { required: true, email: true }
},
messages: {
email: {
required: "輸入 email 地址",
email: "你輸入的不是有效的郵件地址"
}
},
errorPlacement: function (error, element) {
error.appendTo(element.closest('p')); // 自訂提示插入的位置
},
onfocusout: function (element) {
this.element(element); // 離開欄位即驗證
}
});
規則集中在一處,HTML 保持乾淨,也不受套件版本差異影響。若表單欄位很多,再考慮用 data-rule-* 分散宣告;兩種方式可以混用,但同一個欄位不要同時用兩種寫法,否則容易互相覆蓋。
這個問題幾乎百分之百是表單被提交了兩次。
<script src="js/jquery.js"></script>
<script src="js/jquery.validate.js"></script>
<script src="js/jquery.metadata.js"></script>
<script src="js/messages_zh.js"></script>
<script>
$(document).ready(function () {
$("#commentForm").validate({ /* debug: true */ });
});
</script>
<script type="text/javascript">
function register() {
document.forms[0].action = 'register/addUser.action';
document.forms[0].submit(); // ← 問題就在這一行
}
</script>
<form id="commentForm" method="post">
<p>
user name:
<input type="text" name="username" id="username" maxlength="10"
class="{required:true, minlength:6, maxlength:12}" />
</p>
<p>
password:
<input type="password" name="password" id="password" maxlength="15" class="required" />
</p>
<p><input type="submit" value="Register" onclick="register();"></p>
</form>
流程是這樣的:使用者按送出 → onclick 呼叫 register() → document.forms[0].submit() 直接送出表單(這一步繞過了 submit 事件,因此 validate 完全沒機會執行)→ 接著瀏覽器才處理 submit 按鈕的預設行為。頁面早就跳走了,提示自然看不到。
解法:把 document.forms[0].submit(); 註解掉,改成只設定 action,讓 submit 按鈕走正常流程:
function register() {
document.forms[0].action = 'register/addUser.action';
// document.forms[0].submit(); ← 拿掉這行
}
這裡有個值得記住的知識點:form.submit() 這個方法不會觸發 submit 事件(form.requestSubmit() 才會)。因此任何綁在 submit 上的攔截——包括 validate、也包括 onsubmit="return false"——都會被 submit() 完全跳過。這也是為什麼按 Enter 送出表單時驗證會跑,程式呼叫 submit() 時卻不會。
debug: true。開啟後驗證失敗不會真的阻擋提交,並在 console 印出資訊,方便確認規則有沒有被掛上。jquery.validate.message_cn.js(或 localization/messages_zh.js)可直接載入,比自己一份份寫 messages 省事。remote 規則會在每次輸入時打後端(例如檢查帳號是否存在),記得加上 debounce,並在後端做速率限制,否則等於開了一個免費的查詢接口。這兩個問題都有一個共同點:症狀看起來像「套件壞了」,實際原因卻是「規則掛錯位置」與「提交被繞過」。養成先確認這兩件事的習慣,能省下不少時間。