DIV CSS 佈局教程網

自己動手寫一個 JavaScript Ajax 類:AjaxDO 設計與用法
編輯:AJAX基礎知識     

Ajax 框架很好用,但有時候你就是想搞清楚底層到底發生了什麼事。這個名為 AjaxDO 的類(AJAX v1.4,2009 年)把請求生命週期拆成了幾個語意明確的方法,讀起來比框架的原始碼親切得多。

設計思路

整個類以「屬性 + 方法」的方式組織,每個方法都會先呼叫 checkHttpRequest() 確認物件可用,若尚未建立則自動呼叫 InitHttpRequest() 補建。這種自癒式的設計讓呼叫端不必在意初始化時機。

  • openMethod/openURL/openAsync:分別保存請求方法、目標網址與是否異步
  • ProcessRequestFunction:處理回應的函式入口,可另外帶入自訂參數 ProcessRequestParam
  • LoadingImg:載入中的動畫圖示元素,請求開始時顯示、結束或中止時隱藏

跨瀏覽器建立物件

作者沒有停在單純的兩段嘗試,而是回顧了 MSXML 的版本演進:從 5.0 一路向下嘗試到 2.0,其中 i == 2 時改用別名 Microsoft.XMLHTTP。

this.InitHttpRequest = function(){
    var http;
    try {
        if (window.ActiveXObject) {
            for (var i = 5; i; i--) {
                try {
                    if (i == 2) {
                        http = new ActiveXObject("Microsoft.XMLHTTP");
                    } else {
                        http = new ActiveXObject("Msxml2.XMLHTTP." + i + ".0");
                    }
                    break;
                } catch (e) { http = false; }
            }
        } else if (window.XMLHttpRequest) {
            http = new XMLHttpRequest();
            if (http.overrideMimeType) {
                http.overrideMimeType("text/xml");
            }
        }
    } catch (e) { http = false; }

    if (!http) {
        Alert("不能創建 XMLHttpRequest 對象實例");
        return http;
    }
    this.HttpRequest = http;
    return http;
};

這段寫法在今天意義不大(現代瀏覽器都有原生 XMLHttpRequest),但它示範了一個觀念: 「向下相容」不是寫一個 if 就好,而是要真的理解各版本的差異。

建立連線與設定標頭

this.Open = function(method, url, async, username, psw){
    this.openMethod = method;
    this.openURL = url;
    this.openAsync = async;

    // 只允許 GET、POST、HEAD,並檢查 URL 是否為空
    ...
    try {
        this.HttpRequest.open(this.openMethod, this.openURL, this.openAsync, username, psw);
    } catch (e) { Alert("無法建立 HTTP 連接"); return false; }

    if (this.openMethod.toUpperCase() == "POST") {
        this.setRequestHeader("application/x-www-form-urlencoded");
    }

    if (this.openAsync) {
        var _http_request_ajax = this.HttpRequest;
        var _this_ajax = this;
        this.HttpRequest.onreadystatechange = function(){
            if (_http_request_ajax.readyState == 4) {
                if (_http_request_ajax.status == 200) {
                    _this_ajax.ProcessRequestFunction(_http_request_ajax,
                        _this_ajax.ProcessRequestParam, _this_ajax.LoadingImg);
                } else {
                    Alert("您所請求的頁面有異常。");
                    return false;
                }
            }
        };
    }
    if (this.LoadingImg != null) funShow(this.LoadingImg);
    return true;
};

這裡有兩個值得學的小細節:把 this 存成區域變數 _this_ajax 以免在回呼中失焦,以及同步模式下不掛回呼、改由呼叫端主動用 getResponseText() 取資料。

送出請求與讀取回應

this.Send = function(idata){
    var data = null;
    if (this.openMethod.toUpperCase() == "POST") {
        data = funEscapeAll(idata);       // 對每個參數值做 URL 編碼
    }
    try {
        this.HttpRequest.send(data);
        return true;
    } catch (e) { Alert("向服務器發出 HTTP 請求失敗"); return false; }
};

this.getResponseText = function(type){
    if (this.HttpRequest.readyState == 4 && this.HttpRequest.status == 200) {
        if (type != null && type.toUpperCase() == "XML") {
            return this.HttpRequest.responseXML;
        }
        return this.HttpRequest.responseText;
    }
    Alert("您所請求的頁面有異常。");
    return false;
};

this.abort = function(){
    if (this.LoadingImg != null) funHide(this.LoadingImg);
    if (this.HttpRequest.readyState > 0 && this.HttpRequest.readyState < 4) {
        this.HttpRequest.abort();
    }
};

funEscapeAll() 的做法是按 & 切開整串參數,對每一段中 = 之後的值呼叫 encodeURIComponent,再拼回去——這是避免手動 escape 每個欄位的實用技巧。

使用方式

function processRequest(http_request, _val, _loading_img){
    if (http_request.responseXML.documentElement) {
        // 處理 XML 回應
    } else {
        // 處理純文字回應
    }
    funHide(_loading_img);
}

// GET,異步模式
var ajax = new AjaxDO();
ajax.setLoadingImg(_loading_img);
ajax.setOnReadyStateChange(processRequest, _val);
ajax.Open("GET", url, true);     // 異步,程式繼續執行
ajax.Send("");

// GET,同步模式
ajax.Open("GET", url, false);    // 等待伺服器回應
ajax.Send("");
var xml_doc  = ajax.getResponseText("XML");
var text_doc = ajax.getResponseText("TEXT");

// POST,異步模式
ajax.Open("POST", url, true);
ajax.Send(data);

中文傳遞的注意事項

客戶端傳送含中文或 HTML 片段(腳本)的內容時,必須先呼叫 encodeURIComponent:

var data = encodeURIComponent($('message').value);

注意 Ajax 類內部還會再編碼一次,也就是總共編了兩次;因此伺服器端(以 Java 為例)需要對應解兩層:

String message = request.getParameter("message");
message = URLDecoder.decode(message, "UTF-8");

兩層編碼聽起來繞,但這正是「編碼次數兩端不一致」最容易引發亂碼的地方——改了一邊卻忘了另一邊,就會出現看得到問號或方框的經典症狀。

頁面範例

<button onclick="btnAjax1()">異步模式</button>
<button onclick="btnAjax2()">非異步模式</button>

<script type="text/javascript">
var url = "https://www.w3schools.com/xml/simple.xml";
var ajax = new AjaxDO();

function btnAjax1(){
    ajax.abort();
    ajax.setLoadingImg(document.getElementById("Layer1"));
    ajax.setOnReadyStateChange(processRequest);
    ajax.Open("GET", url, true);
    ajax.Send("");
}

function btnAjax2(){
    ajax.abort();
    ajax.Open("GET", url, false);
    ajax.Send("");
    alert(ajax.getResponseText("XML").documentElement.xml);
    alert(ajax.getResponseText("TEXT"));
}
</script>

整體來看,AjaxDO 的價值在於它把「載入動畫、錯誤提示、同步/異步切換、參數編碼」這些實務上一定會碰到的問題都收進同一個類裡,讀完之後再去看 jQuery 的 $.ajax,會更容易理解框架替你做了哪些事。

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