js攔截全域性ajax請求

wendux發表於2017-03-15
JS

你是否有過下面的需求：需要給所有ajax請求新增統一簽名、需要統計某個介面被請求的次數、需要限制http請求的方法必須為get或post、需要分析別人網路協議等等，那麼如何做？想想，如果能夠攔截所有ajax請求，那麼問題就會變的很簡單！?，少年，想法有點大膽，不過，我欣賞！直接上輪子，Ajax-hook不僅可以滿足你想要的，同時可以給你更多。

本部落格原始地址：www.jianshu.com/p/9b634f1c9…
Ajax-hook原始碼地址 : github.com/wendux/Ajax… 歡迎star

注：本文為作者之前在簡書部落格釋出的文章，掘金原創許可權剛開，複製過來，如果您之前看過，跳過吧！

如何使用

###一. 直接引入指令碼

  1. 引入ajaxhook.js

    <script src="wendu.ajaxhook.js"></script>複製程式碼

  2. 攔截需要的ajax 回撥或函式。

    hookAjax({
    //攔截回撥
    onreadystatechange:function(xhr){
        console.log("onreadystatechange called: %O",xhr)
    },
    onload:function(xhr){
        console.log("onload called: %O",xhr)
    },
    //攔截函式
    open:function(arg){
     console.log("open called: method:%s,url:%s,async:%s",arg[0],arg[1],arg[2])
    }
})複製程式碼

ok, 我們使用jQuery(v3.1) 的get方法來測一下：

// get current page source code 
$.get().done(function(d){
    console.log(d.substr(0,30)+"...")
})複製程式碼

結果 :

> open called: method:GET,url:http://localhost:63342/Ajax-hook/demo.html,async:true
> onload called: XMLHttpRequest
> <!DOCTYPE html>
  <html>
  <head l...複製程式碼

攔截成功了！ 我們也可以看到jQuery3.1內部已經放棄onreadystatechange而改用onload了。

###二. CommonJs下的模組構建工具環境中

假設在webpack下，第一步, 安裝ajax-hook npm外掛

npm install ajax-hook --save-dev複製程式碼

第二步，引入模組並呼叫api：

const ah=require("ajax-hook")
ah.hookAjax({ 
  onreadystatechange:function(xhr){ ... },
  onload:function(xhr){ ... }, 
  ...
})
...
ah.unHookAjax()複製程式碼

API

hookAjax(ob)

  • ob,型別是物件，key為想要攔截的回撥或函式，value為我們的攔截函式。
  • 返回值: 原始的 XMLHttpRequest。如果有寫請求不想被攔截，可以new 這個。

unHookAjax()

  • 解除安裝攔截；解除安裝後，攔截將失效。

改變ajax行為

攔截所有ajax請求，檢測請求method,如果是“GET”,則中斷請求並給出提示

hookAjax({
  open:function(arg){
    if(arg[0]=="GET"){
      console.log("Request was aborted! method must be post! ")
      return true;
    }
  } 
 })複製程式碼

攔截所有ajax請求，請求統一新增時間戳

hookAjax({
  open:function(arg){
    arg[1]+="?timestamp="+Date.now();
  } 
 })複製程式碼

修改請求返回的資料“responseText”

hookAjax({
   onload:function(xhr){
    //請求到的資料首部新增"hook!" 
    xhr.responseText="hook!"+xhr.responseText;
   }
 })複製程式碼

結果:

hook!<!DOCTYPE html>
<html>
<h...複製程式碼

有了這些示例，相信開篇提到的需求都很容易實現。最後測一下unHook

   hookAjax({
        onreadystatechange:function(xhr){
            console.log("onreadystatechange called: %O",xhr)
            //return true

        },
        onload:function(xhr){
            console.log("onload called")
            xhr.responseText="hook"+xhr.responseText;
            //return true;
        },
        open:function(arg){
          console.log("open called: method:%s,url:%s,async:%s",arg[0],arg[1],arg[2])
          arg[1]+="?hook_tag=1";

        },
        send:function(arg){
         console.log("send called: %O",arg[0])
        }
    })

    $.get().done(function(d){
        console.log(d.substr(0,30)+"...")
        //use original XMLHttpRequest
        console.log("unhook")
        unHookAjax()
        $.get().done(function(d){
            console.log(d.substr(0,10))
        })

    })複製程式碼

輸出：

open called: method:GET,url:http://localhost:63342/Ajax-hook/demo.html,async:true
send called: null
onload called
hook<!DOCTYPE html>
<html>
<he...
unhook
<!DOCTYPE複製程式碼

注意

  1. 攔截函式返回值是一個boolean，如果為true則會阻斷ajax請求，預設為false,不會阻斷請求。
  2. 所有的回撥攔截函式的引數為當前的XMLHttpRequest 例項，如onreadystatechange、onload；所有ajax原始方法的攔截函式會將原始引數以陣列的形式傳遞給攔截函式，你可以在攔截函式中修改它。

相關連結：
Ajax-hook原理解析:www.jianshu.com/p/7337ac624…

本文章允許免費轉載，但請註明原作者及原文連結。

相關文章