用原生 $.ajax 提交表單,需要自己調 serialize() 處理參數、自己處理文件上傳。jQuery.Form 插件把這些封裝成了兩行代碼,還能搞定 ajax 上傳文件這個老大難。
不需要任何特殊標記,就是最普通的表單:
<form id="myForm" method="post" action="/Home/AjaxForm">
<div>
Name: <input id="username" name="username" type="text" />
Password: <input id="password" name="password" type="text" />
<br />
<input type="submit" value="submit async" id="lnkSubmit" />
</div>
</form>
此時提交表單,頁面會進入阻塞狀態,等待服務端響應後整頁刷新。
<head>
<script type="text/javascript" src="path/to/jquery.js"></script>
<script type="text/javascript" src="path/to/form.js"></script>
<script type="text/javascript">
$(document).ready(function () {
// 為 myForm 綁定 ajaxForm 異步提交事件,並提供簡單回調
$('#myForm').ajaxForm(function () {
alert("Thank you for your comment!");
});
});
</script>
</head>
加上插件後,提交時頁面不再同步刷新,而是由 js 做異步提交。
$(document).ready(function () {
var options = {
// target: '#output1', // 用服務端響應更新的目標元素
// beforeSubmit: showRequest, // 提交前回調
success: callBackFunc, // 提交後回調
// url: 表單 action 的覆寫值
// type: 'get' 或 'post'
// dataType: 'xml' / 'script' / 'json'
// clearForm: true, // 成功後清空所有表單字段
// resetForm: true, // 成功後重置表單
// timeout: 3000 // $.ajax 的其他選項也可直接寫在這裡
};
$('#myForm').ajaxForm(options);
});
// responseText 是服務端響應值,statusText 是提交狀態
function callBackFunc(responseText, statusText) {
if (statusText == 'success') {
alert(responseText);
} else {
alert("服務端錯誤!");
}
}
如果後端返回的是 JSON,回調裡可以直接按對象取值:
function resultFunction(responseText, statusText) {
if (statusText == 'success') {
if (responseText.code == 1) {
alert(responseText.message);
} else {
alert('error occurs!');
}
} else {
alert('服務器錯誤!');
}
}
後端示例(ASP.NET MVC):
[HttpPost]
public ActionResult AjaxForm(FormCollection form) {
string message = "Name:" + form["username"] + " PWD: " + form["password"];
return Json(new { code = 1, message = message });
}
給 options 加上 beforeSubmit 屬性即可。返回 false 會中止提交,返回其他任何值則繼續:
var options = {
beforeSubmit: checkData, // 提交前回調
success: callBackFunc // 提交後回調
};
$('#myForm').ajaxForm(options);
function checkData(formData, jqForm, options) {
// formData 是數組;jqForm 是封裝了表單元素的 jQuery 對象
var formElement = jqForm[0];
if ($(formElement).find("#username").val() == "") {
alert("please enter username!");
return false; // 中止提交
} else {
return true; // 允許提交
}
}
三個參數各有用途:formData 即將被提交的數據數組,可以用它做更複雜的數據加工;jqForm 是表單的 jQuery 對象;第三個參數是 options 本身。
插件提供兩個方法,容易混淆:
ajaxForm(options)——綁定。它攔截表單的 submit 事件,用戶點擊提交按鈕或在輸入框按回車時才真正發送請求。用於「表單由用戶觸發提交」的常規場景。ajaxSubmit(options)——立即執行。調用當下就發一次請求,不依賴用戶操作。用於「腳本主動提交」的場景。兩者可以配合:先用 ajaxForm 準備好配置,需要在別的交互裡提交時調 $('#myForm').ajaxSubmit()。
最後提醒一點,插件的老版本為了兼容不支持 XHR2 的瀏覽器,文件上傳會退化成在頁面裡插入隱藏 iframe 的方式。如果目標瀏覽器都支持 FormData,其實用原生 $.ajax 加 new FormData(form) 就能完成同樣的事,不必額外引入插件。