CommunityServer 內建了一套自己的 Ajax 機制,沒有依賴任何第三方控制項,其中客戶端 XMLHttpRequest 的封裝尤其值得一看——多數瀏覽器都能順利跑起來。要欣賞它,得先把這個物件的底子摸清楚。
客戶端可以用 XMLHTTP 物件送出任意 HTTP 請求、接收回應,甚至直接解析回應中的 XML 文件。這是所有無刷新互動的地基。
open(bstrMethod, bstrUrl, varAsync, bstrUser, bstrPassWord):初始化請求,指定方式、網址與驗證資訊。bstrMethod 為 GET 或 POST;bstrUrl 為服務網頁網址;varAsync 是否同步(預設 true,一般建議設為 false 走非同步);帳號與密碼可省略。send(varBody):送出請求並取得回應。是否同步取決於 open() 的 varAsync:設為 true 時呼叫立即返回;設為 false 則會等到整個回應接收完畢才返回。setRequestHeader(bstrHeader, bstrvalue):設定標頭。若要模擬表單上傳,加上
Content-Type: application/x-www-form-urlencoded。onreadystatechange:狀態改變時呼叫的事件常式。responseBody:回應以無符號整數陣列(位元組)形式傳回。responseStream:回應以串流形式傳回。responseText:回應為字串。responseXML:回應為 XML 格式,可直接用 DOM 操作。最精彩的部分在於建立物件的策略——先看看有沒有標準的 XMLHttpRequest,沒有就回頭逐一嘗試 IE 各版本的 ActiveX ProgID,而且成功一次就把結果記住,後續呼叫不必再試:
function getXMLHttpRequest() {
if (window.XMLHttpRequest) {
return new XMLHttpRequest();
}
// 已經知道哪個 ProgID 可用,直接用它
if (window.ajax_XMLHttpRequestProgID) {
return new ActiveXObject(window.ajax_XMLHttpRequestProgID);
}
var progIDs = ["Msxml2.XMLHTTP.5.0", "Msxml2.XMLHTTP.4.0",
"MSXML2.XMLHTTP.3.0", "MSXML2.XMLHTTP",
"Microsoft.XMLHTTP"];
for (var i = 0; i < progIDs.length; ++i) {
try {
var x = new ActiveXObject(progIDs[i]);
window.ajax_XMLHttpRequestProgID = progIDs[i]; // 記住成功的版本
return x;
} catch (e) { }
}
return null;
}
把探測結果快取下來這個小動作,看似不起眼,卻能省掉每次請求都要重跑一輪 try/catch 的 overhead。
真正的 ajax_CallBack() 函式,參數雖然多,職責卻很清楚:
function ajax_CallBack(type, id, method, args, clientCallBack,
debugRequestText, debugResponseText, debugErrors,
includeControlValuesWithCallBack, url) {
if (!url) {
url = window.location.href;
url = url.replace(/#.*$/, ''); // 去掉錨點部分
url += (url.indexOf('?') > -1)
? "&ajax_CallBack=true"
: "?ajax_CallBack=true";
}
var x = getXMLHttpRequest();
if (!x) {
var result = { value: null, error: "NOXMLHTTP" };
if (debugErrors) { alert("error: " + result.error); }
if (clientCallBack) { clientCallBack(result); }
return result;
}
// 有回呼走非同步,沒有則同步
x.open("POST", url, clientCallBack ? true : false);
x.setRequestHeader("Content-Type", "application/x-www-form-urlencoded; charset=utf-8");
if (clientCallBack) {
x.onreadystatechange = function () {
if (x.readyState != 4) { return; }
var result;
try {
result = eval("(" + x.responseText + ")");
if (debugErrors && result.error) { alert("error: " + result.error); }
} catch (err) {
result = { error: "回應格式不正確" };
}
clientCallBack(result);
};
}
var encodedData = "ajax_CallBackType=" + type;
if (id) { encodedData += "&ajax_CallBackID=" + id.split("$").join(":"); }
encodedData += "&ajax_CallBackMethod=" + method;
if (args) {
for (var i in args) {
encodedData += "&ajax_CallBackArgument" + i
+ "=" + encodeURIComponent(args[i]);
}
}
x.send(encodedData);
if (!clientCallBack) {
return eval("(" + x.responseText + ")");
}
}
幾個設計細節值得留意:回呼的有無決定同步與否,呼叫端不必自己想;參數逐一 encode,避免特殊字元污染查詢字串;eval 解析 JSON 之外還包了 try/catch,讓格式錯誤不至於讓整個頁面中斷。
同樣的原理也能拿來寫爬蟲類的小工具,但那已超出本文重點。真正該記住的是:open 決定「怎麼連」、send 決定「送什麼」、onreadystatechange 決定「回來後做什麼」,三者釐清之後,這個物件就不再有祕密。
今日若在新專案中實作,請以標準 XMLHttpRequest 或 fetch 為主,並用 JSON.parse 取代 eval;文中的探測與快取思路,仍然值得沿用。