用原生 JavaScript 寫 AJAX 前面已經談過,最麻煩的地方在於不同瀏覽器要寫不同一套程式,狀態判斷與錯誤處理也相當囉嗦。
改用 jQuery 內建的 AJAX 相關物件,不但不必操心瀏覽器差異,程式碼量也能大幅縮減。
jQuery 把 ajax() 函式掛在全域物件 jQuery(也就是 $)上,用來處理 AJAX 請求。ajax(url, settings) 接受一個 URL 與一個選填的 settings 物件,常用選項如下:
async:是否以非同步方式送出請求,預設 true,強烈建議不要設成 false;
method:請求方法,預設 'GET',也可指定 'POST'、'PUT' 等;
contentType:POST 內文的格式,預設 'application/x-www-form-urlencoded; charset=UTF-8',也能改成 text/plain 或 application/json;
data:要送出的資料,可以是字串、陣列或物件。GET 請求時它會被轉成 query 附加到 URL 後面,POST 請求時則依 contentType 序列化成對應格式;
headers:額外的 HTTP 標頭,必須是物件;
dataType:預期收到的資料格式,可指定 'html'、'xml'、'json'、'text' 等,不指定時 jQuery 會依回應的 Content-Type 自行推測。
下面這個例子送出一個 GET 請求,並取回 JSON 格式的資料:
var jqxhr = $.ajax('/api/categories', { dataType: 'json' }); // 請求已經發送了
那麼,返回的資料與出錯時的回應要用什麼方式接?
還記得 Promise 物件嗎?jQuery 的 jqXHR 就很接近 Promise,可以用鏈式寫法把各種回調串起來:
'use strict';
function ajaxLog(s) {
var txt = $('#test-response-text');
txt.val(txt.val() + '\n' + s);
}
$('#test-response-text').val('');
var jqxhr = $.ajax('/api/categories', {
dataType: 'json'
}).done(function (data) {
ajaxLog('成功, 收到的數據: ' + JSON.stringify(data));
}).fail(function (xhr, status) {
ajaxLog('失敗: ' + xhr.status + ', 原因: ' + status);
}).always(function () {
ajaxLog('請求完成: 無論成功或失敗都會調用');
});
針對常見的 AJAX 操作,jQuery 另外提供了幾個輔助方法。GET 最為普遍,所以有了 get():
var jqxhr = $.get('/path/to/resource', { name: 'Bob Lee', check: 1 });
第二個參數若是物件,jQuery 會自動把它轉成 query string 接在 URL 後面,實際請求的地址是:
/path/to/resource?name=Bob%20Lee&check=1
URL 編碼與 query string 的組裝都交給 jQuery,我們不必自己處理。
post() 的寫法與 get() 幾乎一致,只是第二個參數預設會被序列化成 application/x-www-form-urlencoded:
var jqxhr = $.post('/path/to/resource', { name: 'Bob Lee', check: 1 });
組出的 name=Bob%20Lee&check=1 會作為 POST 的 body 送出。
JSON 的用量越來越大,因此 jQuery 也備好了 getJSON(),用 GET 直接取回並解析成物件:
var jqxhr = $.getJSON('/path/to/resource', { name: 'Bob Lee', check: 1 }).done(function (data) {
// data已經被解析為JSON對象了
});
jQuery 的 AJAX 終究只是把原生 JavaScript 的 AJAX 包裝了一層,因此同源策略等安全限制與前面提到的原生寫法完全相同。
若需要 JSONP,可以在 ajax() 中設定 jsonp: 'callback',讓 jQuery 以 JSONP 的方式跨域載入資料。
大致上,日常開發只要熟悉 ajax() 的常用選項,再搭配 get/post/getJSON 這幾個捷徑,九成的請求場景都能寫得乾淨俐落。