直接和 XMLHttpRequest 打交道向來不是愉快的事,jQuery 把這一切封裝成幾個高階方法,讓非同步請求的程式碼量縮短好幾倍。以下把常用的幾個入口一次整理清楚,並說明各自的適用時機。
參數意義:url 為請求位址,data 為要送出的資料,callback 是成功後的回呼,可接受「回應內容」與「狀態」兩個參數。
$.get("data.php", $("#firstName.val()"), function(data){
$("#getResponse").html(data); // 這裡的 data 是字串
});
注意回傳的是字串,並非自動解析後的物件。
比 $.get 多一個 type 參數,用來宣告回應的資料型別(html、xml、json 等)。指定為 json 時,回呼收到的就是已解析的物件:
$.post("data.php", $("#firstName.val()"), function(data){
$("#postResponse").html(data.name);
}, "json");
$.ajax({
url: "ajax/ajax_selectPicType.aspx",
data: { Full: "fu" },
type: "POST",
dataType: 'json',
success: CallBack,
error: function(er){ BackErr(er); }
});
需要對快取、逾時、同步與否、全域事件等細節做精細控制時,只有這個方法辦得到。
$.getJSON("data.php", $("#firstName.val()"), function(jsonData){
$("#getJSONResponse").html(jsonData.id); // 直接以 jsonData.id 取值
});
它其實就是預先設好 dataType 的 ajax() 簡化版,並支援跨域(搭配 callback 參數的 JSONP 形式)。
load( url, [data], [callback] );
$('#ajax-div').load('data.html');
data.html 的內容會被塞進 id 為 ajax-div 的元素中。加上錨點還能做到局部載入:
$('#ajax-div').load('data.html#my-section');
getScript( url, [callback] );
$.getScript('ajaxEvent.js', function() {
alert("Scripts Loaded!");
});
這個方法可以跨域載入 JS 並立即執行,因此能把非必要的腳本延後到使用者互動時才載入,有效縮短首屏的程式碼量。
以下是實務上最常被調整的幾個:
url / type:請求位址與方法,type 預設 GET。PUT、DELETE 也可使用,但僅部分瀏覽器支援。
timeout:逾時毫秒數,會覆蓋全域設定。加上它才能避免請求卡住時使用者完全沒有回饋。
async:預設 true。設為 false 會鎖住瀏覽器直到請求結束,除非有特殊需求否則不建議。
cache:設為 false 可避免從瀏覽器快取取得資料,抓取即時性資料時很實用。
beforeSend:可在送出前修改 XHR 物件,例如加上自訂標頭。
complete / success / error:分別對應請求結束、成功與失敗。error 回呼有三個參數:XHR 物件、狀態字串、錯誤物件。
data / processData / contentType:送出的資料會自動轉成查詢字串格式;若要傳送 DOM 樹或不希望被轉換的內容,把 processData 設為 false。若 data 是陣列且有多個同名的值,jQuery 會自動展開成 &foo=bar1&foo=bar2。
dataType:不指定時 jQuery 會依回應的 MIME 型別自動判斷。可選值包含 xml、html、script、json、jsonp,其中 jsonp 會自動把 myurl?callback=? 裡的問號替換成正確的函式名稱。
global / ifModified:global 設為 false 可讓此請求不觸發全域事件;ifModified 則只在伺服器資料有變動時才取新資料,判斷依據是 Last-Modified 標頭。
jQuery 依觸發順序提供:ajaxStart、beforeSend、ajaxSend、success、ajaxSuccess、error、ajaxError、complete、ajaxComplete、ajaxStop。其中帶有全域字樣的會影響頁面上所有請求,適合用來統一處理 loading 指示與錯誤提示:
$("#loading").ajaxStart(function(){
$(this).show();
});
$("#msg").beforeSend(function(e, xhr, o) {
$(this).html("正在請求" + o.url);
}).ajaxSuccess(function(e, xhr, o) {
$(this).html(o.url + "請求成功");
}).ajaxError(function(e, xhr, o) {
$(this).html(o.url + "請求失敗");
});
除 ajaxStart、ajaxStop 之外,其餘事件都會收到 event、XMLHttpRequest、ajaxOptions 三個參數,第三個參數可以帶入自訂資訊。若要讓某個請求獨立於全域事件之外:
$.ajax({
url: "request.php",
global: false // 停用全域 Ajax 事件
});
想一次改寫所有請求的預設值,則用 ajaxSetup:
$.ajaxSetup({
url: "request.php",
global: false,
type: "POST"
});
val() 可取得任何表單元件的值,配合選擇器就能精準取值:
$("input[name='info']:text").val(); // 文字框
$("input[name='pass']:password").val(); // 密碼框
$("input[name='save']:radio").val(); // 單選鈕
serialize() 會把整個表單的值序列化成查詢字串,寫 GET 請求時非常方便;serializeArray() 行為類似,但回傳的是 JSON 結構的陣列,更適合再加工。
選擇哪一種,取決於需求:只是替換頁面片段用 load(),簡單查詢用 get/getJSON,需要完整控制就上 ajax()。