如果 Ajax 請求是由 jQuery 的 $.ajax 發起的,預設可以用 jQuery 的 Global Ajax Event Handlers 監聽。但我遇到的是原生 JavaScript 發起的請求,這招就行不通了。
其他選項像是 Pub/Sub 也有問題——發請求的那段程式碼我無權改動,自然無法往裡頭塞 publish;同理,jQuery 的 .bind 與 .trigger 也用不上。
最後決定直接 override XMLHttpRequest,搭配自訂事件來做。
在 StackOverflow 上找到一個不太可靠的解法,貼出來給大家看看:
;(function () { var open = window.XMLHttpRequest.prototype.open, send = window.XMLHttpRequest.prototype.send, onReadyStateChange; function openReplacement(method, url, async, user, password) { // some code return open.apply(this, arguments); } function sendReplacement(data) { // some code if(this.onreadystatechange) this._onreadystatechange = this.onreadystatechange; this.onreadystatechange = onReadyStateChangeReplacement; return send.apply(this, arguments); } function onReadyStateChangeReplacement() { // some code if (this._onreadystatechange) return this._onreadystatechange.apply(this, arguments); } window.XMLHttpRequest.prototype.open = openReplacement; window.XMLHttpRequest.prototype.send = sendReplacement; })();
這個寫法有幾個硬傷:無法監聽全部的 XHR Events;readystatechange 是在呼叫 send 之後才掛上,因此攔不到 readyState = 1 的事件;更麻煩的是,如果呼叫 send 之後才設定 onreadystatechange,會把 override 的程式碼又覆蓋一次,完全達不到預期效果。
;(function() { function ajaxEventTrigger(event) { var ajaxEvent = new CustomEvent(event, { detail: this }); window.dispatchEvent(ajaxEvent); } var oldXHR = window.XMLHttpRequest; function newXHR() { var realXHR = new oldXHR(); realXHR.addEventListener('abort', function () { ajaxEventTrigger.call(this, 'ajaxAbort'); }, false); realXHR.addEventListener('error', function () { ajaxEventTrigger.call(this, 'ajaxError'); }, false); realXHR.addEventListener('load', function () { ajaxEventTrigger.call(this, 'ajaxLoad'); }, false); realXHR.addEventListener('loadstart', function () { ajaxEventTrigger.call(this, 'ajaxLoadStart'); }, false); realXHR.addEventListener('progress', function () { ajaxEventTrigger.call(this, 'ajaxProgress'); }, false); realXHR.addEventListener('timeout', function () { ajaxEventTrigger.call(this, 'ajaxTimeout'); }, false); realXHR.addEventListener('loadend', function () { ajaxEventTrigger.call(this, 'ajaxLoadEnd'); }, false); realXHR.addEventListener('readystatechange', function() { ajaxEventTrigger.call(this, 'ajaxReadyStateChange'); }, false); return realXHR; } window.XMLHttpRequest = newXHR; })();
差別在於:不去動 prototype,而是用一個函式包住建構子,每次 new XMLHttpRequest() 時回傳一個掛滿監聽器的真實 XHR 物件。這樣所有事件都能攔到,也不會被後續的設定覆蓋。
使用方式:
var xhr = new XMLHttpRequest(); window.addEventListener('ajaxReadyStateChange', function (e) { console.log(e.detail); // XMLHttpRequest Object }); window.addEventListener('ajaxAbort', function (e) { console.log(e.detail.responseText); // XHR 返回的內容 }); xhr.open('GET', 'info.json'); xhr.send();
這裡有兩個容易踩空的地方。第一,原生 readystatechange 等事件的 handler 收到的 e 是 XMLHttpRequest 物件,但自訂事件收到的是 CustomEvent,真正的 XHR 在 e.detail 裡,所以取回應內容要寫成 e.detail.responseText。第二,addEventListener 必須掛在 window 上,掛在 XHR 實例上是收不到的。
由於用到了 CustomEvent 建構子,現代瀏覽器沒問題,但 IE 連 IE11 都不支援,因此需要補一段:
;(function () { if ( typeof window.CustomEvent === "function" ) return false; function CustomEvent ( event, params ) { params = params || { bubbles: false, cancelable: false, detail: undefined }; var evt = document.createEvent( 'CustomEvent' ); evt.initCustomEvent( event, params.bubbles, params.cancelable, params.detail ); return evt; } CustomEvent.prototype = window.Event.prototype; window.CustomEvent = CustomEvent; })(); ;(function () { function ajaxEventTrigger(event) { var ajaxEvent = new CustomEvent(event, { detail: this }); window.dispatchEvent(ajaxEvent); } var oldXHR = window.XMLHttpRequest; function newXHR() { var realXHR = new oldXHR(); realXHR.addEventListener('abort', function () { ajaxEventTrigger.call(this, 'ajaxAbort'); }, false); realXHR.addEventListener('error', function () { ajaxEventTrigger.call(this, 'ajaxError'); }, false); realXHR.addEventListener('load', function () { ajaxEventTrigger.call(this, 'ajaxLoad'); }, false); realXHR.addEventListener('loadstart', function () { ajaxEventTrigger.call(this, 'ajaxLoadStart'); }, false); realXHR.addEventListener('progress', function () { ajaxEventTrigger.call(this, 'ajaxProgress'); }, false); realXHR.addEventListener('timeout', function () { ajaxEventTrigger.call(this, 'ajaxTimeout'); }, false); realXHR.addEventListener('loadend', function () { ajaxEventTrigger.call(this, 'ajaxLoadEnd'); }, false); realXHR.addEventListener('readystatechange', function() { ajaxEventTrigger.call(this, 'ajaxReadyStateChange'); }, false); return realXHR; } window.XMLHttpRequest = newXHR; })();
加上 polyfill 之後,IE 9+、Chrome 15+、Firefox 11+、Edge、Safari 6.1+、Opera 12.1+ 都能正常使用。這套做法的適用情境很明確:當你無法改動發請求的程式碼,卻需要全域性地觀察所有請求狀態時,包裝建構子會是最省事的路線。