本文用原生 JavaScript 實作一個可重複使用的 AJAX 異步請求函式,不依賴任何第三方庫,並把成功與失敗的處理邏輯交給呼叫方決定。
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>原生 AJAX 封裝範例</title>
<style>
* { margin: 0; padding: 0; }
#box { float: left; width: 500px; }
#left, #right { float: left; width: 100px; height: 100px; }
#left { background: #090; }
#right { background: #C60; }
</style>
</head>
<body>
<div id="box">
<div id="left">點擊我看效果!</div>
<div id="right">fffeeee</div>
</div>
<script>
/**
* 異步請求封裝,相容 IE6 及以上瀏覽器
* @param {String} url 請求位址
* @param {Function} fnSucc 請求成功後的資料處理函式
* @param {Function} fnFaild 請求失敗時的處理函式(可選)
*/
function ajax(url, fnSucc, fnFaild) {
// 1. 建立 AJAX 物件,標準瀏覽器與 IE6 走的路徑不同
var oAjax;
if (window.XMLHttpRequest) {
oAjax = new XMLHttpRequest();
} else {
oAjax = new ActiveXObject('Microsoft.XMLHTTP');
}
// 2. 連線伺服器:open(方法, 檔名, 是否異步)
oAjax.open('get', url, true);
// 3. 送出請求
oAjax.send();
// 4. 接收回傳值
oAjax.onreadystatechange = function () {
// readyState 表示通訊進行到哪一步
if (oAjax.readyState === 4) {
// 200 為正常回應;304 代表命中瀏覽器快取,同樣視為成功
if (oAjax.status === 200 || oAjax.status === 304) {
fnSucc(oAjax.responseText);
} else if (fnFaild) {
fnFaild(oAjax.status); // 例如 404
}
}
};
}
window.onload = function () {
var oBtn = document.getElementById('left');
oBtn.onclick = function () {
ajax(
'https://28967904.jsp.jspee.cn/ext/singlePage/list/json-1-1-20',
function (str) {
var data = JSON.parse(str);
alert(data.totalRow);
},
function (error) {
console.log('請求出錯:' + error);
}
);
};
};
</script>
</body>
</html>
整個流程可以切成四段來理解:
XMLHttpRequest,IE6 及更早版本只能透過 ActiveXObject。實務上判斷 window.XMLHttpRequest 是否存在即可,未定義時不會拋錯。open(方法, 位址, 是否異步) 的第三個參數傳 true 表示異步傳輸,也就是我們通常要的效果。send() 裡並設定 Content-Type。onreadystatechange 會在通訊的每個階段被觸發,因此必須先確認 readyState === 4(讀取完成),再判斷 status。除了 200,304 也要一併接受,因為它代表瀏覽器快取命中,回應內容仍然可用。這個封裝足以說明原理,但離「能上 production」還有一段距離,值得先知道自己在省略什麼:
timeout 與 ontimeout。oAjax.abort()。async/await 會好寫得多。也就是說,把它當成理解 XHR 生命週期的最小可行範例剛剛好;真正開發時,瀏覽器原生的 fetch() 或成熟請求庫會是更合適的選擇。
希望本文對理解 JavaScript 的異步請求機制有所幫助。