插件優勢
- 自動序列化表單 → AJAX 提交
- 支援文件上傳(iframe 載體 / FormData)
- 內建驗證鉤子
beforeSubmit、成功回調 success
- 極簡 API:
$('#form').ajaxSubmit(options)
引入順序(關鍵)
<script src="jquery-1.7.min.js"></script> <!-- 必須完整版,slim 版缺 ajax 模塊 -->
<script src="jquery.form.js"></script>
最簡單示例
<form id="loginForm" action="/api/login" method="post">
<input name="username" required>
<input name="password" type="password" required>
<button type="submit">登錄</button>
</form>
<div id="msg"></div>
<script>
$('#loginForm').ajaxForm({
target: '#msg', // 服務端返回 HTML 直接填入
beforeSubmit: function(arr, $form, opts) {
// arr: [{name:'username',value:'...'}, ...]
return true; // false 取消提交
},
success: function(responseText, statusText, xhr, $form) {
console.log('登錄響應:', responseText);
}
});
</script>
options 完整參數
| 參數 | 類型 | 說明 |
| target | Selector/Element | 響應 HTML 注入容器 |
| url | String | 覆蓋 form action |
| type | String | 覆蓋 form method (GET/POST) |
| dataType | String | 預期響應類型: null/html/xml/json/script/jsonp |
| beforeSubmit | Function/Array | 提交前驗證/修改數據,返回 false 取消 |
| success | Function | 成功回調 (responseText, status, xhr, $form) |
| error | Function | 失敗回調 (xhr, status, error, $form) |
| resetForm | Boolean | 提交成功後重置表單 |
| clearForm | Boolean | 提交成功後清空表單 |
| timeout | Number | 請求超時 ms |
JSON 模式最佳實踐
$('#form').ajaxForm({
dataType: 'json',
beforeSubmit: function(arr) {
// 可在此添加額外字段
arr.push({name: 'csrf_token', value: getToken()});
return validate(arr); // 自定義驗證
},
success: function(json, status, xhr, $form) {
if (json.code === 0) {
toast.success(json.msg);
router.push('/dashboard');
} else {
toast.error(json.msg);
}
}
});
文件上傳注意事項
enctype="multipart/form-data" 必須設置
- 舊瀏覽器 (IE9-) 插件自動用隱藏 iframe 模擬,現代瀏覽器用
FormData + XHR2
- 進度條:綁定
xhr.upload.onprogress 需自定義 beforeSend 回調
常見坑點
- **引用 slim 版 jQuery** → 缺
$.ajax 導致插件報錯
- **重複綁定** → 每次提交疊加事件,用
ajaxForm 替代 submit + ajaxSubmit
- **返回 HTML 片段含 script** →
target 模式會執行腳本,可能污染頁面,JSON 模式更安全
- **跨域** → 需後端配置 CORS,且
xhrFields: {withCredentials: true}