Ajax 中的 x 指的是 XML,早期的資料格式偏愛 XML,回來之後再一層層解析;簡單一點的則直接回傳 HTML 片段。如今 JSON 的使用也相當普遍。面對不同需求,可以為 Ajax 物件加上三個實用方法:Ajax.text、Ajax.json、Ajax.xml。
Ajax.text:回傳純文字,也就是 responseText。Ajax.json:回傳 JSON,並自動把 responseText 解析成 JavaScript 物件。Ajax.xml:回傳 XML 文件,也就是 responseXML。使用方式與 Ajax.request 完全相同:第一個參數是請求 URL,第二個是設定參數。
var Ajax =
function(){
function request(url, opt){
function fn(){}
var async = opt.async !== false,
method = opt.method || 'GET',
type = opt.type || 'text',
encode = opt.encode || 'UTF-8',
data = opt.data || null,
success = opt.success || fn,
failure = opt.failure || fn;
method = method.toUpperCase();
if (data && typeof data == 'object'){ // 物件轉成鍵值字串
data = _serialize(data);
}
if (method == 'GET' && data){
url += (url.indexOf('?') == -1 ? '?' : '&') + data;
data = null;
}
var xhr = window.XMLHttpRequest ? new XMLHttpRequest()
: new ActiveXObject('Microsoft.XMLHTTP');
xhr.onreadystatechange = function(){
_onStateChange(xhr, type, success, failure);
};
xhr.open(method, url, async);
if (method == 'POST'){
xhr.setRequestHeader('Content-type',
'application/x-www-form-urlencoded;charset=' + encode);
}
xhr.send(data);
return xhr;
}
function _serialize(obj){
var a = [];
for (var k in obj){
var val = obj[k];
if (val.constructor == Array){
for (var i = 0, len = val.length; i < len; i++){
a.push(k + '=' + encodeURIComponent(val[i]));
}
} else {
a.push(k + '=' + encodeURIComponent(val));
}
}
return a.join('&');
}
function _onStateChange(xhr, type, success, failure){
if (xhr.readyState == 4){
var s = xhr.status, result;
if (s >= 200 && s < 300){
switch (type){
case 'text':
result = xhr.responseText;
break;
case 'json':
result = (new Function('return ' + xhr.responseText))();
break;
case 'xml':
result = xhr.responseXML;
break;
}
success(result);
} else {
failure(xhr);
}
}
}
return (function(){
var _Ajax = { request: request },
types = ['text', 'json', 'xml'];
for (var i = 0, len = types.length; i < len; i++){
_Ajax[types[i]] = function(i){
return function(url, opt){
opt = opt || {};
opt.type = types[i];
return request(url, opt);
};
}(i);
}
return _Ajax;
})();
}();
用 IIFE 動態產生三個方法:外層的立即執行函式回傳真正的物件,內部再用迴圈為 text、json、xml 各產生一個函式。注意 (i) 這個立即傳值是必要的——若不透過參數把迴圈變數傳進去,閉包會共用同一個 i,最後三個方法全都指向 xml。這是 JavaScript 閉包最經典的陷阱之一。
把 type 交給 _onStateChange 決定結果型別:請求邏輯只有一份,差異集中在回應處理的 switch 中,後續要加 html、script 等型別時,只需多一個 case 與陣列項目。
成功與失敗的分工:成功時回呼收到的是「已解析的結果」(文字、物件或 XML 文件),失敗時收到的仍是 xhr 本身,以便呼叫端讀取狀態碼與狀態文字來決定如何提示。
// 取得純文字
Ajax.text('servlet/Hello', {
success : function(text){
document.getElementById('tip').innerHTML = text;
}
});
// 取得 JSON 物件,可直接存取屬性
Ajax.json('servlet/UserInfo', {
data : { uid : 1024 },
success : function(user){
alert(user.name + ' / ' + user.email);
},
failure : function(xhr){
alert('載入失敗:' + xhr.status);
}
});
// 取得 XML 文件,用 DOM 方式導航
Ajax.xml('servlet/OrderList', {
success : function(doc){
var items = doc.getElementsByTagName('item');
for (var i = 0; i < items.length; i++){
// 處理每個節點
}
}
});
關於 JSON 的解析,這裡用 new Function 是為了示範最簡短的寫法;在真實專案中應改用 JSON.parse(),並在伺服器端確保輸出正確的 Content-Type。直接執行來自伺服器的字串,等於把 eval 的風險引進前端,若回應遭竄改或被注入,後果與跨網站腳本攻擊相同。
至此,這個小工具庫已具備三項能力:以物件傳參、序列化表單、依格式取得回應。下一篇可以往更實用的方向走——例如跨域的 JSONP 請求。