DIV CSS 佈局教程網

Ajax 入門必讀:XMLHttpRequest 事件、錯誤處理與標頭操作
編輯:JavaScript基礎知識     

Ajax 是現代 Web 開發的關鍵工具。它讓你能向伺服器非同步送出並接收資料,再用 JavaScript 解析結果。Ajax 是 Asynchronous JavaScript and XML(非同步 JavaScript 與 XML)的縮寫。

它的核心規範沿用了建立與發起請求的 JavaScript 物件名稱:XMLHttpRequest。這份規範分為兩個等級:第一級由所有主流瀏覽器實作,代表基礎功能;第二級擴充了額外事件與功能,讓它更容易與 form 元素協作。

1. Ajax 起步

理解 XMLHttpRequest 最快的方式就是看一個完整例子:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Example</title>
</head>
<body>
  <div>
    <button>apples</button>
    <button>cherries</button>
    <button>bananas</button>
  </div>
  <div id="target">Press a button</div>

  <script type="application/javascript">
    var buttons = document.getElementsByTagName("button");
    for (var i = 0; i < buttons.length; i++) {
      buttons[i].onclick = handleButtonPress;
    }

    // 腳本會呼叫此函式以回應 button 的 click 事件
    function handleButtonPress(e) {
      // 建立一個新的 XMLHttpRequest 物件
      var httpRequest = new XMLHttpRequest();

      // 為 onreadystatechange 事件設定事件處理器
      httpRequest.onreadystatechange = handleResponse;

      // 用 open 指定 HTTP 方法與要請求的 URL
      httpRequest.open("GET", e.target.innerHTML + ".html");

      // 沒有要送出任何資料,所以 send 不帶參數
      httpRequest.send();
    }

    // 處理回應
    // 一旦呼叫 send,瀏覽器就會在背景送出請求。
    // 因為是在背景處理,Ajax 依靠事件來通知請求進度。
    function handleResponse(e) {
      // 事件觸發時,瀏覽器會把一個 Event 物件傳給處理函式,
      // target 屬性會被設為與此事件關聯的 XMLHttpRequest
      if (e.target.readyState == XMLHttpRequest.DONE
          && e.target.status == 200) {
        document.getElementById("target").innerHTML = e.target.responseText;
      }
    }
  </script>
</body>
</html>

另外三個待請求的文件非常簡單:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Apples</title>
  <style>
    img {
      float: left;
      padding: 2px;
      margin: 5px;
      border: medium double black;
      background-color: lightgrey;
      width: 100px;
      height: 100px;
    }
  </style>
</head>
<body>
  <p>
    <img src="../img/show-page/img_apples.jpg"/>
    Page for apples.
  </p>
</body>
</html>

效果如下圖:

當使用者點擊各個水果按鈕時,瀏覽器會在背景執行並取回對應文件,而主文件不會被重新載入。這就是典型的 Ajax 行為。

2. 使用 Ajax 事件

第二級規範定義了一批額外事件:

這些事件大多在請求的某一特定時點觸發。readystatechange 與 progress 是例外——它們會多次觸發以提供進度更新。

調度事件時,瀏覽器對 readystatechange 使用常規的 Event 物件,對其他事件則使用 ProgressEvent 物件。ProgressEvent 定義了 Event 的所有成員,並新增了下列成員:

使用範例:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Example</title>
  <style>
    table { margin: 10px; border-collapse: collapse; float: left; }
    div { margin: 10px; }
    td, th { padding: 4px; }
  </style>
</head>
<body>
  <div>
    <button>apples</button>
    <button>cherries</button>
    <button>bananas</button>
  </div>
  <table id="events" border="1"></table>
  <div id="target">Press a button</div>

  <script type="application/javascript">
    var buttons = document.getElementsByTagName("button");
    for (var i = 0; i < buttons.length; i++) {
      buttons[i].onclick = handleButtonPress;
    }

    var httpRequest;

    function handleButtonPress(e) {
      clearEventDetails();
      httpRequest = new XMLHttpRequest();
      httpRequest.onreadystatechange = handleResponse;
      httpRequest.onerror = handleError;
      httpRequest.onload = handleLoad;
      httpRequest.onloadend = handleLoadEnd;
      httpRequest.onloadstart = handleLoadStart;
      httpRequest.onprogress = handleProgress;
      httpRequest.open("GET", e.target.innerHTML + ".html");
      httpRequest.send();
    }

    function handleResponse(e) {
      displayEventDetails("readystate(" + httpRequest.readyState + ")");
      if (e.target.readyState == XMLHttpRequest.DONE
          && e.target.status == 200) {
        document.getElementById("target").innerHTML = e.target.responseText;
      }
    }

    function handleError(e)      { displayEventDetails("error", e); }
    function handleLoad(e)       { displayEventDetails("load", e); }
    function handleLoadEnd(e)    { displayEventDetails("loadend", e); }
    function handleLoadStart(e)  { displayEventDetails("loadstart", e); }
    function handleProgress(e)   { displayEventDetails("progress", e); }

    function clearEventDetails() {
      document.getElementById("events").innerHTML =
        "<tr><th>Event</th><th>lengthComputable</th><th>loaded</th><th>total</th>";
    }

    function displayEventDetails(eventName, e) {
      if (e) {
        document.getElementById("events").innerHTML +=
          "<tr><td>" + eventName + "</td><td>" + e.lengthComputable +
          "</td><td>" + e.loaded + "</td><td>" + e.total + "</td></tr>";
      } else {
        document.getElementById("events").innerHTML +=
          "<tr><td>" + eventName + "</td><td>NA</td><td>NA</td><td>NA</td></tr>";
      }
    }
  </script>
</body>
</html>

這是前一個範例的變型,為多個事件註冊了處理函式,並在 table 元素中為每個事件建立一筆紀錄。下圖可以看到 Firefox 實際觸發這些事件的順序:

3. 處理錯誤

使用 Ajax 時必須留意兩類錯誤,差別源於觀察的視角不同。

第一類是從 XMLHttpRequest 物件的角度看到的問題:某個因素阻止了請求被送出。例如 DNS 無法解析主機名稱、連線被拒絕、或 URL 格式無效。

第二類是從應用程式的角度看到的問題:請求成功送達伺服器、伺服器也處理並回應了,但回應的內容並不是你期待的。例如請求的 URL 不存在就是典型案例。

有三種方式可以處理這些錯誤。

3.1 處理設定錯誤

第一種情況是傳給 XMLHttpRequest 的資料本身有問題,比如格式不正確的 URL。這類錯誤在使用者輸入拼湊 URL 時特別容易發生。按下範例中標示 Bad URL 的按鈕,會以這種形式呼叫 open:

httpRequest.open("GET", "https://")

這會阻止請求執行,而 XMLHttpRequest 會直接拋出錯誤。這意味著必須用 try...catch 包住設定請求的程式碼:

try {
  // ...
  httpRequest.open("GET", "https://");
  // ...
  httpRequest.send();
} catch (error) {
  displayErrorMsg("try/catch", error.message);
}

catch 區塊讓你有機會從錯誤中恢復:可以提示使用者重新輸入、退回預設 URL,或單純捨棄這次請求。範例中只是呼叫 displayErrorMsg 顯示訊息。

3.2 處理請求錯誤

第二類錯誤發生在請求已建立、但其他方面出錯時。範例中標示 Bad Host 的按鈕會呼叫 open 去存取一個不可用的 URL:

httpRequest.open("GET", "https://www.ycdoitt.com/nopage.html")

這個 URL 有兩個問題。

第一,主機名稱無法被 DNS 解析,瀏覽器根本無法建立伺服器連線。這個問題直到 XMLHttpRequest 開始建立請求時才會顯現,因此它以兩種方式發出訊號:如果你註冊了 error 事件的監聽器,瀏覽器會向你的監聽函式送出一個 Event 物件:

function handleError(e) {
  displayErrorMsg("Error event", httpRequest.status + httpRequest.statusText);
}

遺憾的是,這類錯誤發生時能從 XMLHttpRequest 取得的資訊相當有限,多數情況下你只會拿到 status 為 0、statusText 為空字串。

第二,該 URL 與產生請求的頁面來源不同,預設情況下這是不允許的——你通常只能向載入腳本的同源 URL 送出 Ajax 請求。瀏覽器回報這個問題時可能拋出 Error 也可能觸發 error 事件,各家處理方式不一;而且不同瀏覽器檢查來源的時機不同,這意味著同一個問題不一定每次都會被明確提示。要繞過同源限制,需要使用跨來源資源共享(CORS, Cross-Origin Resource Sharing)。

3.3 處理應用程式錯誤

最後一類錯誤發生在請求成功完成(從 XMLHttpRequest 的角度看),但沒有回傳你想要的資料時。範例中標示 cucumber 的按鈕會產生與其他按鈕相同形式的請求 URL,但伺服器上並不存在 cucumber.html。

這個過程本身沒有錯誤——請求確實完成了。要判斷發生了什麼,必須看 status 屬性。請求不存在的文件時會得到 404,代表伺服器找不到該文件。範例中就是這樣處理 200 以外的狀態碼:

if (httpRequest.status == 200) {
  target.innerHTML = httpRequest.responseText;
} else {
  document.getElementById("statusmsg").innerHTML =
    "Status:" + httpRequest.status + " " + httpRequest.statusText;
}

範例只是單純顯示 status 與 statusText。真實應用中,應該以對使用者有用且有意義的方式恢復——例如顯示備用內容、提示可能出了問題,或引導至錯誤頁。

4. 獲取與設定標頭

透過 XMLHttpRequest,你可以設定送給伺服器的請求標頭,也可以讀取伺服器回應中的標頭。

4.1 覆寫請求的 HTTP 方法

通常不需要更動 Ajax 請求的標頭——瀏覽器知道該送什麼,伺服器也知道該怎麼回。但有幾種例外,第一種是 X-HTTP-Method-Override。

HTTP 標準定義了許多方法。大多數人熟悉 GET 與 POST,因為它們用得最廣;但也存在 PUT、DELETE 等方法,它們用來向伺服器請求的 URL 賦予語意,而且這種用法正在上升。舉例來說,要查看某筆使用者記錄,可以產生這樣的請求:

httpRequest.open("GET", "https://myserver/records/freeman/adam");

關鍵在於透過 HTTP 方法表達「想讓伺服器做什麼」,而不是把它編碼進 URL 裡。若要刪除資料,就可以寫成:

httpRequest.open("DELETE", "https://myserver/records/freeman/adam");

問題是:許多主流 Web 技術只支援 GET 與 POST,而且不少防火牆也只放行這兩種請求。有個常見的變通做法是送出 POST,同時用 X-HTTP-Method-Override 標頭表明真正想用的方法:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Example</title>
</head>
<body>
  <div>
    <button>apples</button>
    <button>cherries</button>
    <button>bananas</button>
  </div>
  <div id="target">Press a button</div>

  <script>
    var buttons = document.getElementsByTagName("button");
    for (var i = 0; i < buttons.length; i++) {
      buttons[i].onclick = handleButtonPress;
    }

    var httpRequest;

    function handleButtonPress(e) {
      httpRequest = new XMLHttpRequest();
      httpRequest.onreadystatechange = handleResponse;
      httpRequest.open("GET", e.target.innerHTML + ".html");
      httpRequest.setRequestHeader("X-HTTP-Method-Override", "DELETE");
      httpRequest.send();
    }

    function handleError(e) {
      displayErrorMsg("Error event", httpRequest.status + httpRequest.statusText);
    }

    function handleResponse() {
      if (httpRequest.readyState == 4 && httpRequest.status == 200) {
        document.getElementById("target").innerHTML = httpRequest.responseText;
      }
    }
  </script>
</body>
</html>

這裡用 setRequestHeader 表明希望請求以 HTTP DELETE 的形式被處理。請注意:設定標頭必須在 open 方法之後呼叫,否則 XMLHttpRequest 會拋出錯誤。

另外要提醒的是,覆寫 HTTP 方法需要伺服器端的 Web 框架能理解 X-HTTP-Method-Override 這個慣例,並且要設定成會去尋找並處理那些較少用的方法。

4.2 停用內容快取

第二個實用的標頭是 Cache-Control,在開發與除錯階段尤其有用。部分瀏覽器會快取透過 Ajax 取得的內容,在同一個瀏覽工作階段中不再重新請求。這意味著你對 apples.html 的修改不會立即反映到頁面上。寫法如下:

httpRequest = new XMLHttpRequest();
httpRequest.onreadystatechange = handleResponse;
httpRequest.open("GET", e.target.innerHTML + ".html");
httpRequest.setRequestHeader("Cache-Control", "no-cache");
httpRequest.send();

設定方式與前一例相同,只是這次用的標頭是 Cache-Control,值為 no-cache。加上這行之後,只要透過 Ajax 請求的內容有變動,下一次請求就會反映新版本。

4.3 讀取回應標頭

可以用 getResponseHeader 與 getAllResponseHeaders 讀取伺服器回應的 HTTP 標頭。多數情況下你不需要關心標頭內容,因為它們只是瀏覽器與伺服器互動的一部分。使用範例:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta content="width=device-width,user-scalable=no" name="viewport" />
  <meta name="author" content="葉超Luka" />
  <meta name="description" content="A simple example" />
  <title>Example</title>
  <link href="../img/ycdoit.ico" type="image/x-icon" rel="shortcut icon" />
  <style>
    #allheaders, #ctheader {
      border: medium solid black;
      padding: 2px;
      margin: 2px;
    }
  </style>
</head>
<body>
  <div>
    <button>apples</button>
    <button>cherries</button>
    <button>bananas</button>
  </div>
  <div id="ctheader"></div>
  <div id="allheaders"></div>
  <div id="target">Press a button</div>

  <script>
    var buttons = document.getElementsByTagName("button");
    for (var i = 0; i < buttons.length; i++) {
      buttons[i].onclick = handleButtonPress;
    }

    var httpRequest;

    function handleButtonPress(e) {
      httpRequest = new XMLHttpRequest();
      httpRequest.onreadystatechange = handleResponse;
      httpRequest.open("GET", e.target.innerHTML + ".html");
      httpRequest.setRequestHeader("Cache-Control", "no-cache");
      httpRequest.send();
    }

    function handleResponse() {
      if (httpRequest.readyState == 2) {
        document.getElementById("allheaders").innerHTML =
          httpRequest.getAllResponseHeaders();
        document.getElementById("ctheader").innerHTML =
          httpRequest.getResponseHeader("Content-Type");
      } else if (httpRequest.readyState == 4 && httpRequest.status == 200) {
        document.getElementById("target").innerHTML = httpRequest.responseText;
      }
    }
  </script>
</body>
</html>

效果圖如下:

從圖中可以看到,開發伺服器運行的 Web 伺服器軟體是 IntelliJ IDEA 15.0.4,最後修改 apples.html 的時間是 6 月 27 日(雖然截圖是 7 月 5 日)。

值得注意的是程式在 readyState == 2(HEADERS_RECEIVED)階段就讀取標頭,因為此時回應標頭已完整可用,但主體內容還沒下載完畢——這是讀取標頭的正確時機。

補充:現代做法

以上內容是理解 Ajax 底層運作的基礎。在實際專案中,除非有特殊需求,通常會使用 fetch 或 axios 這類包裝過的 API,它們把事件模型轉換成 Promise/async-await,錯誤處理也直觀得多。但無論用哪一層,底層的請求生命週期、狀態碼、標頭與同源政策規則都完全相同——把這些搞懂,上層工具才不會是黑箱。

fetch('apples.html', { cache: 'no-store' })
  .then(function (response) {
    if (!response.ok) {
      throw new Error('Status: ' + response.status);
    }
    return response.text();
  })
  .then(function (html) {
    document.getElementById('target').innerHTML = html;
  })
  .catch(function (err) {
    console.error(err);
  });
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved