分享JavaScript監(jiān)聽全部Ajax請求事件的方法

更新時間：2016年08月28日 16:22:07 投稿：daisy

最近在做一個小項目，引入了第三方js文件，這個文件會調用XMLHttpRequest向服務器發(fā)送 Ajax請求，但是我有需要監(jiān)聽其Ajax請求的某些事件，以便額外地執(zhí)行其他腳本。于是稍微看了看監(jiān)聽 Ajax請求的事件方法，在這里分享給大家。有需要的朋友們可以參考借鑒。

若Ajax請求是由jQuery的$.ajax發(fā)起的，默認情況下可以使用 jQuery的Global Ajax Event Handlers監(jiān)聽到Ajax事件，然而我遇到的卻是用原生JavaScript發(fā)起的Ajax請求，所以這種方法行不通。

然后呢，還有其他方法，比如說 Pub/Sub，但是這個發(fā)起請求的 js 代碼我是無法改動的，也就不存在向代碼里添加 publish 的問題。同理，jQuery 的 .bind 和 .trigger 也無法使用。

最后，決定使用直接 override XMLHttpRequest，同時配合使用自定義事件。

在 StackOverflow 上搜索，發(fā)現(xiàn)有個歪果仁給出了一個不靠譜的解決方法，嗯，貼出來給大家看看：

;(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;
})();

這個解決方案，無法監(jiān)聽全部的 XHR Events ，而且 readystatechange 事件是在調用 send 方法后才監(jiān)聽，也就無法監(jiān)聽到 readyState = 1 時的事件。同時，如果在使用 send 方法后再對 onreadystatechange 設置回調函數(shù)，會將 override 的代碼又一次 override，也就無法產(chǎn)生預想的效果。

那如何才能正確地 override XHR 呢？貼上代碼，一起來看看：

;(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;
})();

這樣，就為 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 對象，但是自定義方法 ajaxReadyStateChange 等事件 handler 返回的 e 是 CustomEvent 對象，而 e.detail 才是真正的 XMLHttpRequest 對象。而獲得 Ajax 請求返回內容的 e.responseText 也需要修改為 e.detail.responseText。

同時，addEventListener 方法必須掛載在 window 對象上，而不能是 XHR 實例上。

因為以上代碼使用了 CustomEvent 構造函數(shù)，在現(xiàn)代瀏覽器上可以正常使用，但是在 IE 下，甚至連 IE 11 都不支持，所以需要加上 Polyfill，變成這樣：

;(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;
})();

此時，就可以在 IE 9+、Chrome 15+、FireFox 11+、Edge、Safari 6.1+、Opera 12.1+ 上愉快地使用了，以上就是本文的全部內容，希望大家能夠喜歡。

您可能感興趣的文章: