DIV CSS 佈局教程網

AJAX 客戶端核心:XMLHttpRequest 物件用法與跨瀏覽器封裝實作
編輯:AJAX基礎知識     

CommunityServer 內建了一套自己的 AJAX 機制,沒有依賴任何第三方控制項。其中對客戶端 XMLHttpRequest 物件的封裝寫得相當漂亮,足以在多數瀏覽器上跑起非同步更新。今天我們就來拆解這個核心角色,順便看看 CommunityServer 是怎麼包它的。

一、XMLHTTP 物件能做什麼

客戶端可以透過 XMLHTTP 物件送出任意 HTTP 請求、接收 HTTP 應答,並進一步解析回傳的 XML 文件。它主要提供三個動作:Open 建立請求、Send 送出、setRequestHeader 設定標頭。

Open 方法

初始化一個 Msxml2.XMLHTTP 請求,指定請求方式、URL 與認證資訊。

Open(bstrMethod, bstrUrl, varAsync, bstrUser, bstrPassword)
  • bstrMethod:資料傳輸方式,GET 或 POST。
  • bstrUrl:目標伺服器網頁的 URL。
  • varAsync:是否同步執行。預設 True 為同步,且只能在 DOM 環境中同步執行;實務上通常設為 False 走非同步。
  • bstrUser/bstrPassword:使用者名稱與口令,皆可省略。

Send 方法

把 HTTP 請求送到伺服器並取得應答。

oXMLHttpRequest.send(varBody)

是否同步取決於 Open 的 varAsync:設為 True 時呼叫立即返回;設為 False 則會等到整個應答接收完畢才返回。

setRequestHeader 方法

setRequestHeader(bstrHeader, bstrvalue)

兩個參數分別是 HTTP 標頭名稱與標頭值。若 Open 定義為 POST,還可以搭配表單風格的上傳:

xmlhttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded")

常用屬性

  • onreadystatechange:狀態切換時觸發的事件處理常式,只能在 DOM 中呼叫。
  • responseBody:結果以無號整數陣列回傳。
  • responseStream:結果以 IStream 串流回傳。
  • responseText:結果以字串回傳。
  • responseXML:結果以 XML 格式資料回傳。

順帶一提,這個原理也正是爬蟲程式的基礎——用程式模擬瀏覽器發請求、抓回應。我還沒動手做過,也許哪天會寫一個來玩玩。不過這裡的重點是:CommunityServer 究竟如何封裝它。

二、建立跨瀏覽器的 XMLHTTP 物件

第一段程式碼負責「取得物件」。策略是先判斷標準的 window.XMLHttpRequest,若不存在則回頭嘗試 IE 的 ActiveX 版本,並把成功的 ProgID 快取下來,下次直接重用,避免每次都把五個版本逐一試錯。

// Ajax Start
/**
 * 建立回呼物件。若存在 window.XMLHttpRequest() 則直接建立並回傳;
 * 否則在 IE 下依序嘗試 Msxml2.XMLHTTP 各版本與 Microsoft.XMLHTTP。
 */
function Ajax_GetXMLHttpRequest() {
    if (window.XMLHttpRequest) {
        return new XMLHttpRequest();
    } else {
        if (window.Ajax_XMLHttpRequestProgID) {
            return new ActiveXObject(window.Ajax_XMLHttpRequestProgID);
        } else {
            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) {
                var progID = progIDs[i];
                try {
                    var x = new ActiveXObject(progID);
                    window.Ajax_XMLHttpRequestProgID = progID;
                    return x;
                } catch (e) { }
            }
        }
    }
    return null;
}

三、Ajax_CallBack:把整趟往返包成一個函式

這個函式的參數不少,但責任很清楚:組出請求 URL、拼出表單風格的參數字串、送出,再把結果交給呼叫端指定的回呼函式。參數意義如下:

  • type:服務端函式所在的類別(含命名空間),例如 NExplus.Controls.SiteHeader。
  • id:對應的客戶端標記 ID。
  • method:被 AjaxMethod 標記的服務端方法名稱。
  • args:要送到伺服器的字串。
  • clientCallBack:指定走同步或非同步回呼。
  • debugRequestText/debugResponseText/debugErrors:分別用來顯示請求字串、回應字串與錯誤訊息。
  • includeControlValuesWithCallBack:是否一併送出控制項及其值。
  • url:請求位址。

URL 的處理有幾個細節值得注意:先移除 # 之後的片段,再視情況補上 Ajax_CallBack=true;若網址以斜線結尾,會自動補上 default.aspx。

function Ajax_CallBack(type, id, method, args, clientCallBack,
                       debugRequestText, debugResponseText, debugErrors,
                       includeControlValuesWithCallBack, url) {

    if (!url) {
        url = window.location.href;
        url = url.replace(/\#.*$/, '');   // 去除 # 之後的片段
        if (url.indexOf('?') > -1)
            url += "&Ajax_CallBack=true";
        else {
            if (url.substr(url.length - 1, 1) == "/")
                url += "default.aspx";
            url += "?Ajax_CallBack=true";
        }
    }

    var x = Ajax_GetXMLHttpRequest();
    var result = null;
    if (!x) {
        result = { "value": null, "error": "NOXMLHTTP" };
        if (debugErrors) alert("error: " + result.error);
        if (clientCallBack) clientCallBack(result);
        return result;
    }

    x.open("POST", url, clientCallBack ? true : false);  // 以 POST 開啟,服務端可用 Request.Form 取參數
    x.setRequestHeader("Content-Type", "application/x-www-form-urlencoded; charset=utf-8");

    if (clientCallBack) {
        x.onreadystatechange = function () {
            var result = null;
            if (x.readyState != 4) return;
            if (debugResponseText) alert(x.responseText);
            try {
                var result = eval("(" + x.responseText + ")");
                if (debugErrors && result.error) alert("error: " + result.error);
            } catch (err) {
                if (window.confirm('The following error occured while processing an AJAX request: '
                    + err.message + '\n\nWould you like to see the response?')) {
                    var w = window.open();
                    w.document.open('text/plain');
                    w.document.write(x.responseText);
                    w.document.close();
                }
                result = new Object();
                result.error = 'An AJAX error occured.  The response is invalid.';
            }
            clientCallBack(result);
        }
    }

接著組字串。參數會先經過 encodeURIComponent 編碼,控制項的值則依標籤類型分別處理:INPUT 只取 TEXT、PASSWORD、HIDDEN,以及勾選狀態下的 CHECKBOX 與 RADIO;SELECT 與 TEXTAREA 直接取值。最後送出的 body 大致如下:

    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]);
        }
    }
    // 需要時一併帶上表單控制項的值(此處省略逐元素判斷的細節)
    if (debugRequestText) alert(encodedData);
    x.send(encodedData);

    if (!clientCallBack) {
        if (debugResponseText) alert(x.responseText);
        result = eval("(" + x.responseText + ")");
        if (debugErrors && result.error) alert("error: " + result.error);
    }
    delete x;
    return result;
}
// Ajax End

其餘部分看註解應該就夠了。這個封裝最值得學的一點是:它把「跨瀏覽器建立物件」「同步與非同步兩條路徑」「除錯輸出」三件事收在一個入口後面,呼叫端只需要給一個回呼函式。若有理解不到位之處,歡迎批評指正。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved