DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> JavaScript入門知識 >> AJAX入門 >> AJAX詳解
Ajax 封裝實作(一):把基本請求收攏成一個物件
編輯:AJAX詳解     

Ajax 或許已是老話題,但每次重寫一遍,理解就更紮實一層。這個系列打算從最基本的請求出發,逐步走向進階應用,最後收攏成一個實用的 Ajax 工具庫。第一篇先把地基打好。

一、三個步驟就足夠

建立一個基本的 Ajax 應用不需要太多程式碼,大致三步、數十行即可:

  1. 建立 Ajax 的核心物件 XMLHttpRequest。
  2. 設定並送出請求(open 與 send)。
  3. 處理回應(onreadystatechange)。

步驟一:建立 XMLHttpRequest

由於瀏覽器之間的不相容,IE7 之前的版本並沒有原生的 XMLHttpRequest,而是實作為 ActiveX 物件。網路上有各種建立方式,有的冗長、有的簡潔,差別主要在於考慮了多少種例外情況。較完整的寫法幾乎涵蓋了 IE 的所有變體:

function createXHR(){
    try{ return new XMLHttpRequest(); }catch(e){}
    try{ return new ActiveXObject('Msxml2.XMLHTTP.6.0'); }catch(e){}
    try{ return new ActiveXObject('Msxml2.XMLHTTP.4.0'); }catch(e){}
    try{ return new ActiveXObject('Msxml2.XMLHTTP.3.0'); }catch(e){}
    try{ return new ActiveXObject('Msxml2.XMLHTTP'); }catch(e){}
    try{ return new ActiveXObject('MSXML3.XMLHTTP'); }catch(e){}
    try{ return new ActiveXObject('MSXML.XMLHTTP'); }catch(e){}
    try{ return new ActiveXObject('Microsoft.XMLHTTP'); }catch(e){}
    try{ return new ActiveXObject('MSXML2.ServerXMLHTTP'); }catch(e){}
    return null;
}

若偏好簡潔,也可以用特性偵測一行搞定:

var xhr = window.XMLHttpRequest ? new XMLHttpRequest()
                                : new ActiveXObject('Microsoft.XMLHTTP');

本文採用精簡寫法,暫不考慮建立失敗的例外。

步驟二與步驟三:送出與接收

xhr.open(method, url, async);
xhr.send(data);

xhr.onreadystatechange = function(){
    if (xhr.readyState == 4){
        if (xhr.status == 200){
            // callback 在這裡處理回應
        }
    }
};

到這裡都沒有特別之處,任何一本書都是這三步。對初學者而言,真正的門檻在於如何把這幾步妥善封裝成一個結構良好的模組。全域變數满天飛、不知道程式碼該怎麼組織,是每個人走過的階段;回頭看,那通常是因為對語言本身掌握不足,尤其是閉包(closure)。

二、用單例模式封裝

這裡採用單例模式,只暴露一個全域變數 Ajax,它有一個 request 方法。方法接受兩個參數:第一個是請求的 URL(必要,字串);第二個 opt 是設定參數(選填,物件)。回應的處理收在內部私有的 _onStateChange 函式中。

/**
 * 執行基本 Ajax 請求,並建立 XMLHttpRequest
 * Ajax.request(url, {
 *     async    是否非同步,預設 true
 *     method   請求方式,POST 或 GET(預設)
 *     data     請求參數(鍵值字串)
 *     success  成功後的回呼函式,參數為 xhr
 *     failure  失敗後的回呼函式,參數為 xhr
 * });
 */
var Ajax =
function(){
    function request(url, opt){
        function fn(){}
        var async   = opt.async !== false,
            method  = opt.method  || 'GET',
            data    = opt.data    || null,
            success = opt.success || fn,
            failure = opt.failure || fn;

        method = method.toUpperCase();

        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, success, failure);
        };

        xhr.open(method, url, async);

        if (method == 'POST'){
            xhr.setRequestHeader('Content-type',
                                 'application/x-www-form-urlencoded;');
        }

        xhr.send(data);
        return xhr;
    }

    function _onStateChange(xhr, success, failure){
        if (xhr.readyState == 4){
            var s = xhr.status;
            if (s >= 200 && s < 300){
                success(xhr);
            } else {
                failure(xhr);
            }
        }
    }

    return { request: request };
}();

三、使用方式

呼叫後端的一個 servlet,傳送參數 name=jack&age=20,預設使用非同步與 GET:

Ajax.request('servlet/ServletJSON', {
    data : 'name=jack&age=20',
    success : function(xhr){
        // 在這裡處理 xhr
    },
    failure : function(xhr){
        // 失敗時的處理
    }
});

不到四十行,就完成了一個可用的封裝。這裡有幾個設計細節值得留意:

  • 把 method 統一轉為大寫,避免 'get' 與 'GET' 的判斷失準。
  • GET 模式下若帶有參數,自動拼到 URL 後並把 data 清空,避免重複傳送。
  • 狀態判斷用 200 <= s < 300 而非只寫 == 200,可一併涵蓋 204、206 乃至 304 等成功情況。
  • 用閉包把 _onStateChange 藏起來,外部只看到 request 一個方法,介面乾淨。

目前的限制是 data 只能是鍵值字串。若希望能直接傳入 JavaScript 物件、讓傳參更靈活,就必須多一個序列化步驟——下一篇就從這裡開始改進。

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