Easy.Ajax 是我自己封裝的一層 Ajax 工具,特色是同時支援一般請求與表單檔案上傳,並在 XDomainRequest、ActiveXObject 各家實作之間做了相容處理。以下拆解主要成員。
Easy.Ajax = {
proxyPool: {
length: function () {
var i = 0;
for (var p in this) i++;
return i - 1;
}
},
index: 0,
async: true,
xmlData: false,
timeout: 1,
defaultHeader: 'application/json; charset=utf-8',
clearCache: true,
emptyFn: function () { },
defaultHandlers: {
empty: function () { },
onerror: this.empty,
onload: this.empty,
ontimeout: this.empty,
onprogress:this.empty
},
proxyPool 以 id 為索引保存每一個連線物件,length 用來統計當前活跃連線數(減 1 是為了扣掉 length 自身這個屬性)。
createXhr: function (id) {
var py, pxy;
try {
var md = ["Msxml2.XMLHTTP", "Microsoft.XMLHTTP"];
try {
pxy = new XMLHttpRequest();
} catch (e) { }
if (!pxy && window.XDomainRequest)
pxy = new XDomainRequest();
for (var i = 0; !pxy; i++)
try {
pxy = new ActiveXObject(md[i]);
} catch (e) { }
py = {
conn: pxy,
isLoading: false,
id: id
};
this.proxyPool[id] = py;
} catch (e) {
return new Easy.Error(e, e.message);
} finally {
return pxy ? py : new Easy.Error('Null pointer');
}
},
順序很關鍵:先試標準 XMLHttpRequest,再退回 XDomainRequest(IE 的跨域方案),最後才落到 ActiveXObject 的兩個 ProgID。外層用 py 包住 conn,是為了在原生物件之外掛上 isLoading、id 等自家狀態。
setEvents: function (pxy, cfg, override) {
try {
var dh = this.defaultHandlers,
props = cfg,
conn = pxy.conn,
me = this;
for (var p in dh) {
if (!override && conn.hasOwnProperty(p)) continue;
try {
conn[p] = props[p] || dh[p];
} catch (e) { }
}
conn.onreadystatechange = function () {
if (conn.readyState == 4) {
pxy.isLoading = false;
(cfg.callback || me.callback).call(conn,
conn.responseText || conn.responseXML.xml, cfg);
me.destroy(pxy.id);
}
}
} catch (e) { } finally {
return conn;
}
},
callback: function (rsp, cfg) {
var emptyFn = function () { };
if (this.status == 200) {
(cfg.success || emptyFn).call(this, rsp);
} else {
(cfg.failure || emptyFn).call(this, rsp, this.statue);
}
},
open: function (method, url, async, cfg, uname, pwd) {
var me = this,
pxy = this.createXhr(this.index++);
var conn = pxy.conn;
conn.open(method, url, async);
conn.setRequestHeader("Content-Type", cfg.xmlData || this.xmlData
? "text/xml" : this.defaultHeader);
conn.setRequestHeader("timeout", this.timeout);
return pxy;
},
toRequstCfg: function (cfg) {
if (Easy.getType(cfg) == "string")
cfg = { url: cfg }
cfg.url = Easy.util.urlAppend(cfg.url, Math.random(5))
var form = Easy.DOM.get(cfg.form);
if (form) {
if (cfg.isUpload || /multipart\/form-data/i.test(form.getAttribute("enctype")))
cfg.isUpload = true;
else
cfg.params = Easy.util.serializeForm(form);
}
return cfg;
},
toRequstCfg 負責把「傳入一個字串」的簡便寫法正規化成設定物件,順帶用隨機數破壞快取,並判斷目標表單是否為 multipart——若是,就切換到 iframe 上傳通道。
request: function (cfg, method) {
var pxy = this.open(method || "POST", cfg.url, true, cfg),
proxy = pxy.conn;
proxy = this.setEvents(pxy, cfg, true);
var params = this.getParam(cfg.params),
bl = cfg.beforeLoad;
if (bl && Easy.getType(bl) == "function" && bl.call(proxy) === false)
return;
proxy.send(params);
pxy.isLoading = true;
return pxy.id;
},
get: function (cfg) {
cfg = this.toRequstCfg(cfg);
if (cfg.isUpload) return this.upload(cfg);
return this.request(cfg, "GET");
},
post: function (cfg) {
cfg = this.toRequstCfg(cfg);
if (cfg.isUpload) return this.upload(cfg);
return this.request(cfg);
},
XHR 無法直接傳送檔案,因此做法是建立一個隱藏 iframe,讓表單 target 指向它,再從 iframe 讀回伺服器回應:
upload: function (cfg) {
var form = Easy.DOM.get(cfg.form);
var iframe = document.createElement("iframe");
var iframeID = "Easy_Ajax_Form_Submit";
Easy.DOM.setAttributes(iframe, {
id: iframeID,
name: iframeID,
width: "0px",
height: "0px",
style: "display:none;",
src: "about:blank"
});
Easy.DOM.render(iframe, form);
if (Easy.util.isIE)
document.frames[iframeID].name = iframeID;
var complete = function () {
Easy.DOM.destroy(iframe);
};
cfg.url = cfg.url || form.action;
Easy.DOM.setAttributes(form, {
action: Easy.util.urlAppend(cfg.url, cfg.params),
target: iframeID,
enctype: "multipart/form-data",
method: "POST"
});
var cb = function () {
try {
var me = this,
r = { responseText: '', responseXML: null },
doc, firstChild;
try {
doc = iframe.contentWindow.document
|| iframe.contentDocument
|| window.frames[id].document;
if (doc) {
if (doc.body) {
if (/textarea/i.test((firstChild = doc.body.firstChild || {}).tagName)) {
r.responseText = firstChild.value;
} else {
r.responseText = doc.body.innerHTML;
}
}
r.responseXML = r.responseText;
}
} catch (e) { }
(cfg.callback || cfg.success || complete).call(r,
r.responseText || r.responseXML.xml, cfg);
} catch (e) {
(cfg.failure || cfg.callback || complete).call(r, e.message, cfg);
}
};
Easy.DOM.on(iframe, "load", cb, iframe);
form.submit();
},
這裡有兩個實務細節值得注意:IE 需要額外設定 document.frames[id].name,target 才會正確指向;讀取回應時要優先取 textarea 的 value,因為部分瀏覽器會把伺服器輸出包成 textarea 節點。
destroy: function (id) {
this.abort(id);
delete this.proxyPool[id];
},
abort: function (id) {
if (!Easy.util.isIE6)
(((this.proxyPool[id] || {}).conn.abort) || this.emptyFn)();
}
整體設計思路清楚:以 proxyPool 集中管理連線生命週期,請求完成即 destroy 回收,避免高頻呼叫下的記憶體累積。若要沿用這套寫法於今日專案,建議把 XDomainRequest 與 ActiveXObject 分支移除,改用標準 XHR 加 CORS,並把 onreadystatechange 換成 onload/onerror,程式碼可再精簡一半。