DIV CSS 佈局教程網

Ajax 常用函式:建立 XMLHTTP 物件並區分 IE 與 Mozilla 系瀏覽器
編輯:AJAX基礎知識     

網路上關於「怎麼建立 XMLHTTP 物件、怎麼分辨 IE 與 Mozilla」的函式版本很多,寫法大同小異。這裡整理一份可以直接複用的版本,並順手修掉流傳過程中常見的兩個錯誤。

getRequest:取得通訊物件

function getRequest() {
    var http_request = false;

    if (window.XMLHttpRequest) {
        // Mozilla、Netscape、Safari 等支援原生建構
        http_request = new XMLHttpRequest();
        // 若伺服器回應的 header 不是 text/xml,可主動覆寫
        if (http_request.overrideMimeType) {
            http_request.overrideMimeType('text/xml');
        }
    } else if (window.ActiveXObject) {
        // 舊版 IE:新版本 MSXML 失敗再退回最通用的寫法
        try {
            http_request = new ActiveXObject("Msxml2.XMLHTTP");
        } catch (e) {
            try {
                http_request = new ActiveXObject("Microsoft.XMLHTTP");
            } catch (e) {}
        }
    }

    return http_request;
}

兩個重點:一是先判斷 window.XMLHttpRequest 再退回 ActiveX,順序反了會在標準瀏覽器上做無謂嘗試;二是 overrideMimeType 要先確認存在再呼叫,並非每個實作都有。

getResponseText:取回純文字

function getResponseText(url) {
    var http_request = getRequest();
    if (!http_request) { return ''; }

    // 第三個參數 false 代表同步:send() 返回時資料已到齊
    http_request.open('GET', url, false);
    http_request.send(null);

    if (http_request.readyState == 4) {
        // 收到完整的伺服器回應
        if (http_request.status == 200) {
            return http_request.responseText;
        }
        return http_request.status;   // 非 200 就把狀態碼交出去,方便呼叫端判斷
    }
    return '';
}

getResponseXML:取回 XML 文件

function getResponseXML(url) {
    var http_request = getRequest();
    if (!http_request) { return null; }

    http_request.open('GET', url, false);
    http_request.send(null);

    if (http_request.readyState == 4) {
        if (http_request.status == 200) {
            return http_request.responseXML;
        }
        return null;
    }
    return null;
}

流傳許久的版本裡,這段函式常被誤植為 getResponseText,導致後定義的把前一個蓋掉,responseXML 永遠沒機會被呼叫。兩個函式名稱必須不同,這是複製貼上時最容易忽略的一點。

同步或非同步?

上面兩段刻意用同步(open 的第三個參數為 false),因為它寫起來最像一般函式:呼叫、拿到結果、繼續往下。缺點是整個瀏覽器會在等待期間凍住,使用者連捲動都做不到。

實務上的正確做法是非同步 + 回呼:

function getTextAsync(url, callback) {
    var http_request = getRequest();
    if (!http_request) { return; }

    http_request.onreadystatechange = function () {
        if (http_request.readyState !== 4) { return; }
        if (http_request.status === 200) {
            callback(null, http_request.responseText);
        } else {
            callback(http_request.status, null);
        }
    };

    http_request.open('GET', url, true);   // true = 非同步
    http_request.send(null);
}

// 使用
getTextAsync('/api/news?id=1', function (err, text) {
    if (err) { console.error('請求失敗:', err); return; }
    document.getElementById('show_news').innerHTML = text;
});

幾個實務提醒

  • IE 下 responseXML 只認 .xml 副檔名。動態頁面要回傳 XML,記得在伺服器端送出 Content-Type: text/xml。
  • 快取。IE 對 GET 有明顯的快取行為,需要每次都拿新資料時,加上時戳參數或在伺服器端送出 Cache-Control: no-cache。
  • 不要用 eval 組 SQL 或執行回應。回應內容一律當資料處理,需要 HTML 時也要先過濾。
  • 今天可以直接用 fetch。
    fetch('/api/news?id=1')
      .then(function (r) {
        if (!r.ok) { throw new Error('HTTP ' + r.status); }
        return r.text();
      })
      .then(function (text) {
        document.getElementById('show_news').textContent = text;
      })
      .catch(console.error);
    
    一行 fetch 就取代上面整段 getRequest,連跨瀏覽器判斷都不必自己寫。

這份程式碼的歷史價值在於示範了「能力偵測」這個觀念:不要問瀏覽器是誰,要問它支援什麼。這個原則從 2005 年用到今天,完全沒有過時。

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