本文討論如何把 jQuery validate(表單驗證)與 jQuery form(Ajax 提交)配合使用,並記錄一個在實作中反覆折騰的樣式 bug 及其排查過程。
· 方式一:利用 validate 的 submitHandler 選項。表單通過驗證後會執行這個回調,在其中調用 jQuery form 提交。
· 方式二:利用 jQuery form 的 beforeSubmit。它返回 true 才繼續提交,返回 false 則中止;配合 validate 提供的 valid() 方法即可在提交前完成校驗。
· 方式三:直接調用 validate 的 validate() 方法拿到驗證器實例,控制粒度最細,重置表單、手動觸發驗證都很方便。
CSS 樣式:
input { height: 25px; line-height: 25px; padding-left: 4px; }
span.checked {
padding: 0 5px 0 25px; margin: 0 0 3px 10px;
height: 25px; line-height: 25px; font-size: 12px;
white-space: nowrap; text-align: left; color: #E6594E;
background: url("images/acion2.png") no-repeat 3px;
}
span.unchecked {
padding: 0 5px 0 25px; margin: 0 0 3px 10px;
height: 23px; line-height: 23px; font-size: 12px;
border: 1px solid #E6594E; white-space: nowrap;
text-align: left; color: #E6594E;
background: #FCEAE8 url("images/acion.png") no-repeat 3px;
}
引入的腳本:
<script src="js/jQuery1.6.2.js"></script> <script src="js/jquery.form.js"></script> <script src="js/jquery.validate.js"></script> <script src="js/localization/messages_tw.js"></script>
HTML 結構:
<body>
<span id="result"></span>
<form id="commentForm">
<fieldset>
<legend>jquery.validate + jquery.form 提交的三種方式</legend>
<p>
<label for="cusername">姓名</label><em>*</em>
<input id="cusername" name="username" size="25" />
</p>
<p>
<label for="cemail">電子郵件</label><em>*</em>
<input id="cemail" name="email" size="25" />
</p>
<p><input class="submit" type="submit" value="提交"></p>
</fieldset>
</form>
</body>
function showResponse(responseText, statusText) {
if (statusText == 'success') {
$("#result").html(responseText);
}
}
$(document).ready(function () {
$('#commentForm').validate({
focusCleanup: true,
focusInvalid: false,
errorClass: "unchecked",
validClass: "checked",
errorElement: "span",
submitHandler: function (form) {
$(form).ajaxSubmit({
type: "post",
url: "test_save.php?time=" + (new Date()).getTime(),
success: showResponse
});
},
errorPlacement: function (error, element) {
var s = element.parent().find("span[for='" + element.attr("id") + "']");
if (s != null) { s.remove(); }
error.appendTo(element.parent());
},
success: function (label) {
label.removeClass("unchecked").addClass("checked");
},
rules: {
username: { required: true, minlength: 3 },
email: { required: true }
}
});
});
function showRequest(formData, jqForm, options) {
return $("#commentForm").valid();
}
$(document).ready(function () {
$('#commentForm').submit(function () {
$(this).ajaxSubmit({
type: "post",
url: "test_save.php?time=" + (new Date()).getTime(),
beforeSubmit: showRequest,
success: showResponse
});
return false; // 必須返回 false,阻止表單的常規提交
});
$('#commentForm').validate({
focusCleanup: true,
focusInvalid: false,
errorClass: "unchecked",
validClass: "checked",
errorElement: "span",
errorPlacement: function (error, element) {
var s = element.parent().find("span[for='" + element.attr("id") + "']");
if (s != null) { s.remove(); }
error.appendTo(element.parent());
},
success: function (label) {
label.removeClass("unchecked").addClass("checked");
},
rules: {
username: { required: true, minlength: 3 },
email: { required: true }
}
});
});
var options = {
focusCleanup: true,
focusInvalid: false,
errorClass: "unchecked",
validClass: "checked",
errorElement: "span",
errorPlacement: function (error, element) {
var s = element.parent().find("span[for='" + element.attr("id") + "']");
if (s != null) { s.remove(); }
error.appendTo(element.parent());
},
success: function (label) {
label.removeClass("unchecked").addClass("checked");
},
rules: {
username: { required: true, minlength: 3 },
email: { required: true }
}
};
$(document).ready(function () {
var validator = $('#commentForm').validate(options);
$("#reset").click(function () {
validator.resetForm(); // 重置表單與驗證狀態
});
$("button").click(function () {
validator.form(); // 手動觸發整表驗證
});
$('#commentForm').submit(function () {
$(this).ajaxSubmit({
type: "post",
url: "test_save.php?time=" + (new Date()).getTime(),
beforeSubmit: showRequest,
success: showResponse
});
return false;
});
});
現象是這樣的:頁面頭部使用 <!DOCTYPE html> 時,輸入框與錯誤提示的樣式會出問題。以「姓名」為例(規則是最少三個字符),輸入第一、第二個字符時錯誤提示正常顯示,輸入第三個字符時提示消失並出現代表通過的「勾」;但繼續輸入第四、第五個字符時,錯誤提示又冒出來了:

而改用 <html>(不寫 DOCTYPE,瀏覽器進入 quirks 模式)時一切正常。可現代前端又必須寫 DOCTYPE,這個矛盾必須解決。
先在 errorPlacement 裡加一句打印,看看父元素的 HTML 結構:
errorPlacement: function (error, element) {
alert(element.parent().html());
var s = element.parent().find("span[htmlFor='" + element.attr("id") + "']");
if (s != null) { s.remove(); }
error.appendTo(element.parent());
}
輸入第一個字符時:

輸入三個字符、驗證通過後:

繼續輸入更多字符:

由此可見兩個事實:其一,無論驗證成功還是失敗,errorPlacement 都會被調用;其二,s.remove() 根本沒起作用,舊的提示節點一直沒被清掉。
further對比發現,不寫 DOCTYPE 時彈出的結構裡屬性名是 htmlFor="cusername":

而在標準模式下,生成的節點屬性名是 for。原來是選擇器寫錯了,把 htmlFor 改為 for 即可正確定位並刪除舊節點:
errorPlacement: function (error, element) {
var s = element.parent().find("span[for='" + element.attr("id") + "']");
if (s != null) { s.remove(); }
error.appendTo(element.parent());
}
既然 errorPlacement 的成功/失敗分支都會進來,更穩妥的寫法是先判斷內容是否為空,只在真的有錯誤時才插入:
errorPlacement: function (error, element) {
if (error.html() != '') {
error.appendTo(element.parent());
}
}
改完之後 Chrome、Firefox 下仍有異常:焦點離開輸入框時不觸發驗證,必須點擊「提交」按鈕才會校驗。把 jQuery 從 1.6.2 降到 1.3.2 或 1.4 可以規避(更低版本未逐一測試)。因此筆者的建議是:老項目中若這套插件出現難以定位的行為異常,優先排查 jQuery 版本兼容性。
這個例子還改善了 validate 原生 remote 只能返回 true/false 的局限,可以同時帶回錯誤文案。做法是把返回結果包裝成一個配置對象:
function GetRemoteInfo(postUrl, data) {
var remote = {
type: "POST",
async: false,
url: postUrl,
dataType: "xml",
data: data,
dataFilter: function (dataXML) {
var result = new Object();
result.Result = jQuery(dataXML).find("Result").text();
result.Msg = jQuery(dataXML).find("Msg").text();
if (result.Result == "-1") {
result.Result = false;
} else {
result.Result = result.Result == "1" ? true : false;
}
return result;
}
};
return remote;
}
$(document).ready(function () {
var dataInfo = { email: function () { return $("#cemail").val(); } };
var remoteInfo = GetRemoteInfo('check-email.php?time=' + (new Date()).getTime(), dataInfo);
$('#commentForm').validate({
rules: {
username: { required: true, minlength: 3 },
email: { required: true, remote: remoteInfo }
}
});
});
後端返回 XML:
<?php header("Content-Type:text/xml"); ?>
<AjaxClass>
<Msg>用戶名格式不正確,用戶名必須包含 testa,請重新輸入!</Msg>
<Result>0</Result>
</AjaxClass>
Result 為 0 表示驗證失敗,為 1 表示通過;Msg 則直接作為提示文案展示給用戶,比單調的 true/false 友好得多。