Flyio拦截器中锁定API的源码分析

官方文档

先来看一下官方文档对拦截器锁定API的介绍

拦截器锁定API

请求拦截器和响应拦截器都提供了锁定自身的API, 拦截器锁定后,未进入到该拦截器的请求将在拦截器外面排队,暂停网络请求,直到拦截器解锁时,排队的请求才再次进入拦截器继续请求。请求拦截器和响应拦截器都提供了如下两个API:

lock()

锁定当前拦截器。

unlock

解锁当前拦截器。

Flyio的使用

import Fly from './fly';
export const service = new Fly();

// 业务请求service的请求拦截器 
// 参数:handler(下文中"拦截器操作"指handler)
service.interceptors.request.use((request) => {
    // doSomething...
    service.lock();
    // doSomething...
    return request  //只有最终返回request对象时,原来的请求才会继续
    service.unlock()
})

源码分析

Flyio的通过Promise实现锁定API,用Promise.then的同步执行模拟队列,以resolve为开关控制后续操作的执行。

下面通过笔者的注释一起读读相关代码吧~~

//在fly.js中,声明Fly对象,为对象添加请求方法及"lock", "unlock","clear"方法。

["get", "post", "put", "patch", "head", "delete"].forEach(e => {
  Fly.prototype[e] = function (url, data, option) {
    // 发起网络请求,调用Fly的request方法
    return this.request(url, data, utils.merge({method: e}, option))
  }
});

["lock", "unlock", "clear"].forEach(e => {
   // 使用请求锁,调用Fly的interceptors.request
  Fly.prototype[e] = function () {
    this.interceptors.request[e]();
  }
});
// Fly对象下的拦截器对象
let interceptors = this.interceptors = {
  //响应拦截器
  response: {
    use(handler, onerror) {
      this.handler = handler; //hander是拦截网络请求要执行的操作,简称"拦截器操作"
      this.onerror = onerror;
    }
    //后续会将lock等方法merge进response对象
  },
  //请求拦截器
  request: {
    use(handler) {
      this.handler = handler; 
    }
    //后续会将lock等方法merge进request对象
  }
}
// 把lock,unlock,clear合并到interceptor的requset,response对象中
let irq = interceptors.request;
let irp = interceptors.response;
// wrap函数merge这几个方法
wrap(irp);
wrap(irq);

function wrap(interceptor) {
    // 存储promise的resolve,reject
    let resolve;
    let reject;

    // 内部清除方法
    function _clear() {
        interceptor.p = resolve = reject = null;
    }

    // merge方法
    utils.merge(interceptor, {
        lock() {
            // resolve不存在,说明是首次使用lock锁,声明一个p存储锁队列
            // 用promise实现锁队列,把拦截器操作放到promise.then里
            // 将promise的_resolve, _reject赋值给上级变量,从外层控制resolve,只有resolve()后,Promise.then才能继续执行
            if (!resolve) {
                interceptor.p = new Promise((_resolve, _reject) => {
                    resolve = _resolve
                    reject = _reject;
                })
            }
        },
        unlock() {
            // resolve存在表示lock锁存在,resolve()释放整个promise,让后续网络请求执行
            if (resolve) {
                resolve()
                _clear();
            }
        },
        clear() {
            if (reject) {
                let ENV = process.env.NODE_ENV === 'development';
                if (ENV) reject("cancel");
                _clear();
            }
        }
    })
}

​以用户发起网络请求为例,当用户发起网络请求,进入Fly.request方法,方法内先调用enqueueIfLocked判断锁队列p (Promise) 是否存在,如果锁队列不存在,就执行拦截器操作(handler);如果锁队列p存在,说明之前的网络请求拦截器已经lock了,当前的handler会被放入锁队列中,直到resolve()解锁再按照入队顺序执行。

request(url, data, options){
    let requestInterceptor = interceptors.request; //请求拦截
    let responseInterceptor = interceptors.response; //响应拦截
    let requestInterceptorHandler = requestInterceptor.handler; // 拦截器操作

    let promise = new Promise((resolve, reject) => {
        
        //调用enqueueIfLocked方法(如果锁队列p存在就将当前网络请求操作入队,否则直接执行)
        enqueueIfLocked(requestInterceptor.p, () => {
            // 省略:存储用户参数,请求头,url等信息到ret
            
            //执行拦截器操作
            if (requestInterceptorHandler) {
                ret = requestInterceptorHandler.call(requestInterceptor, options, Promise) || options;
            }

            //省略:网络拦截操作执行完毕后,调用makeRequest发送网络请求

        })

        /**
         *如果请求/响应拦截器已被锁定(service.locked)
         *新的请求/响应将进入一个队列,否则,它将被直接执行。
         *@param [promise]如果promise存在,意味着拦截器被锁定
         *@param [callback]
         */
        function enqueueIfLocked(promise, callback) {
            //判断当前是否存在锁队列,即p是否存在
            //如果锁队列存在,将拦截器操作放到promise的then里;如果不存在就执行拦截器操作
            if (promise) {
                promise.then(() => {
                    callback()
                })
            } else {
                callback()
            }
        }

    })

    promise.engine = engine; //Fly通过在不同环境切换不同engine的方式实现支持不同的javascript运行环境的。
    return promise;
}

词不达意,不当之处欢迎留言。

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