你是否有过下面的需求：需要给所有ajax请求添加统一签名、需要统计某个接口被请求的次数、需要限制http请求的方法必须为get或post、需要分析别人网络协议等等，那么如何做？想想，如果能够拦截所有ajax请求，那么问题就会变的很简单！😄，少年，想法有点大胆，不过，我欣赏！直接上轮子，Ajax-hook不仅可以满足你想要的，同时可以给你更多。
本博客原始地址：http://www.jianshu.com/p/9b634f1c9615
Ajax-hook源码地址 : https://github.com/wendux/Ajax-hook 欢迎star
如何使用
一. 直接引入脚本
-
引入ajaxhook.js
<script src="wendu.ajaxhook.js"></script> -
拦截需要的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
注意
- 拦截函数返回值是一个boolean，如果为true则会阻断ajax请求，默认为false,不会阻断请求。
- 所有的回调拦截函数的参数为当前的XMLHttpRequest 实例，如onreadystatechange、onload；所有ajax原始方法的拦截函数会将原始参数以数组的形式传递给拦截函数，你可以在拦截函数中修改它。
相关链接：
Ajax-hook原理解析:http://www.jianshu.com/p/7337ac624b8e
BY THE WAY : 欢迎关注、star我的另一个开源项目 Neat.js ! 😄。
最后还是老话：刚开博客，求赞、求关注、求评论、各种求。
