基于 ES6 的 Proxy ,100行代码实现一个 XMLHttpRequest 的拦截核心 ajax-proxy

前言

前一段时间,项目在对 WKWebview 进行适配时,接触到了公共能力组使用的 Ajax-hook 方案,于是便对它的怎么实现的很感兴趣,到网上查资料学习时,找到了作者 @wendux 的 Ajax-hook原理解析 这篇文章,当时边看脑子里就边想:“卧槽,这种骚操作怎么感觉 Proxy 也能来一波!”。等看到这篇文章的评论区有个老哥 @银冰雪千载 也发出了一样的疑问时,会心一笑,说干就干,打开 VSCode 就是一顿操作。

1473308168_167070.png

关于 ES6 的 Proxy

这个东西其实也不新鲜了,不过由于不支持 IE ,且 Safari 10 才开始支持,用的时候一直小心翼翼的。一直在寻找一些最佳实践,这次应该也算是一次练手。对它不太熟的同学可以看看 MDN上的ProxyECMAScript 6入门里的Proxy 。此次实现,用到了它的getset以及 construct 方法。

关于 XMLHttpRequest

XMLHttpRequest 我们并不陌生,虽然在诸如 axios 这类优秀的请求库帮助下,我们渐渐不需要直接操作它了,但是对它的熟悉程度不应该停留在表层,在一些浏览器适配和前端监控以及埋点的时候,还是要和它打交道的。在这里我们需要明确一些点:

  • responseresponseTexttimeout这类的属性,姑且称之为 普通属性
  • 对应的,像 onreadystatechangeonprogressonload这类的属性,则称之为 事件属性
  • 当然,还有一些 opensendabort这类,称之为 方法
  • 这里重点关注一个地方,有很大一部分属性并不是 writable 的,如下图
8E62C51B-6350-4E14-B715-0E9ECF36CD3C.jpg

所以我们在拦截这些属性时,要做些特殊处理

原理解析

这部分建议先看一下 API ,或者打开 API 放在旁边对照着看,效果更佳。

Ajax-hook 一样,总体是采用代理模式,下面上个总体的原理图:

ajax-proxy.jpg

首先,无论项目(浏览器端)采用什么请求方案,只要是最终用的是 Host Object(宿主对象)里的 XMLHttpRequest ,都需要用

var xhr = new XMLHttpRequest()

将其实例化,那么我们就可以先拦截 XMLHttpRequest 对象的 new 操作,落实到代码就是用 Proxyconstruct 方法。在拦截操作里,我们就做简单的两件事:

  • 实例化 XMLHttpRequest
  • Proxy 继续拦截 XMLHttpRequest 的实例
carbon.png

然后我们在上面的第二步接着深入,用 getset 对实例进行拦截,下面我们重点看下这两个方法里做的事情。

  • get(target, p, receiver)

    • 普通属性 进行 get 拦截操作,代码如下
      carbon的副本.png

      上文有提到,有一部分属性不是 writable,所以遇到这些属性,我们在之后的 set 操作里,会将其缓存进带有前缀 _的同名属性中,所以在 get 时,需要先判断这些 _ 前缀的属性是否存在进而进行读取,而 writable 属性则通过 getter 函数进行读取。
    • 方法 进行拦截操作,代码如下
      carbon的副本2.png

      拦截方法时,先判断用户是否提供了拦截函数,有的话执行并将结果记为 result,然后判断 result 类型,如果是 true ,则终止方法。(这里我加了一个功能,如果返回的是其他 truthy 值如 object 或者 function,可以将 result 当做新的参数传入。)
  • set(target, p, value, receiver)

    • 事件属性 进行拦截操作,代码如下
      carbon的副本3.png

      很简单,也是用户是否提供了拦截函数,有的话先执行。
  • 普通属性 进行 set 拦截操作,代码如下

    carbon的副本4.png

    和上面类似的拦截操作,这里需要注意一下 catch 里的代码,此处就是上文说的对不是 writable 的属性进行的特殊操作。
    最后,只需将上述代码生成的 Proxy 对象实例 赋值给宿主对象 XMLHttpRequest 就大功告成了。
    至此,基本上就是所有的代码了,在这里总结一下:

ajax-proxy 使用 Proxy 先对宿主对象 XMLHttpRequestnew 操作进行拦截,然后再创建一个 Proxy 实例,对 XMLHttpRequest 实例的 getset进行拦截操作,最后将生成的 Proxy 对象实例 赋值给宿主对象 XMLHttpRequest,Done!

最后

篇幅有限,有些细节没有讲清楚或者讲的不对的地方请指出,更多的用法以及代码请戳 →

GitHub: https://github.com/LazyDuke/ajax-proxy

repo 里还有对 XMLHttpRequestJQueryAjax 模块以及 axios 进行拦截的测试用例,觉得有意思的点一下 Star 吧~

本文章允许免费转载,但请注明原作者及原文链接。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容

  • Proxy 概述 Proxy 用于修改某些操作的默认行为,等同于在语言层面做出修改,所以属于一种“元编程”(met...
    pauljun阅读 3,249评论 0 1
  • 摘要 ✨长文 阅读约需十分钟 ✨跟着走一遍需要一小时以上 ✨约100行代码 前段时间打算写一个给手机端用的假冒控制...
    NISAL阅读 1,270评论 0 1
  • 笔记,完全摘录自阮一峰 proxy的概念 proxy英文原意是代理的意思,在ES6中,可以翻译为"代理器"。它主要...
    布蕾布蕾阅读 22,359评论 0 8
  • Proxy Proxy 可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此...
    Upcccz阅读 308评论 0 0
  • 一、概述 Proxy 用于修改某些操作的默认行为,等同于在语言层面做出修改,所以属于一种“元编程”(meta pr...
    了凡和纤风阅读 246评论 0 1