Axios的攔截器原理以及請求等待重發(fā)的實(shí)現(xiàn)

Vue項(xiàng)目越做越多鸭叙,Axios一直作為請求發(fā)送的基礎(chǔ)工程常熙,這里就深究一下Axios的攔截器相關(guān)的一些邏輯和對應(yīng)一個(gè)比較惡心的場景瞧捌。
Axios GitHub

回顧下Promise

  1. Promise的基礎(chǔ)知識不做多介紹可以參考兩個(gè)文章

    1. 《ECMAScript 6 入門》:Promise 對象
    2. ES6 Promise的resolved深入理解 這個(gè)是我看到的對于Promise狀態(tài)解釋比較清晰的一個(gè)文章
  2. Promise的狀態(tài)

    1. Promise狀態(tài)一旦改變就不能再變弥咪,一直保持此狀態(tài)
    2. Promise可以被其他Promise鎖定----這個(gè)很重要络它,跟后面的要說到的Axios的請求阻塞等待有關(guān)系
    3. 一個(gè)重要的Demo
    Promise.resolve(
        new Promise((resolve,reject) => {
            console.log('inner Promise');
            resolve('123');
        }).then(data=>{
            console.log(1,typeof(data), data);
            return data+'4';
        })
    ).then(data=>{
        return Promise.resolve('Randy'+data);
    }).then(data=>{
        console.log(2,typeof(data), data)
    });
    
  • 輸出如下結(jié)果

    inner Promise
    "string" "123"
    "string" "Randy1234"
    
  1. 簡單解釋下上面的結(jié)果
    1. Promise.resolve創(chuàng)建一個(gè)Promise對象咖城,依賴于inner的Promise的resolve結(jié)果
    2. 內(nèi)部的new Promise().then()創(chuàng)建了一個(gè)Promise茬腿,new Promise()resolve的結(jié)果是123then()將結(jié)果改為1234宜雀,打印"string" "123"切平,然后返回'1234'這個(gè)作為外層的resolve結(jié)果
    3. 外層中第一個(gè)then()返回了一個(gè)Promise返回"Randy1234"作為resolve結(jié)果
    4. 外層中第二個(gè)then()接收到前一個(gè)的返回值,然后打印"string" "Randy1234"
  2. 人話描述下這里用到的幾個(gè)知識點(diǎn)
    1. Promise.resolve(data)等于new Promise(resolve=>{resolve(data)})
    2. Promise A可以使用另一個(gè)Promise B的resolve值作為自己的resolve值進(jìn)入A的調(diào)用鏈
    3. then()可以對處理結(jié)果進(jìn)行修改

Axios

接下來開始整體辐董,說說Axios悴品。Axios是基于Promise機(jī)制實(shí)現(xiàn)的異步的鏈?zhǔn)秸埱罂蚣堋sw積小简烘,源碼易懂苔严。非常適合做基礎(chǔ)的請求庫。

Axios結(jié)構(gòu)

  1. 代碼結(jié)構(gòu)

    1. axios.js:入口文件孤澎,將Axios實(shí)例的request函數(shù)綁定為入口函數(shù)届氢,axios.create其實(shí)返回的是一個(gè)function,就是Axios實(shí)例的Axios.prototype.request
    2. lib/Axios.js:真正的Axios的實(shí)例覆旭,用于拼接攔截器的調(diào)用鏈退子,關(guān)鍵代碼如下:
          // Hook up interceptors middleware
          var chain = [dispatchRequest, undefined];
          var promise = Promise.resolve(config);
          
          this.interceptors.request.forEach(function unshiftRequestInterceptors(interceptor) {
          chain.unshift(interceptor.fulfilled, interceptor.rejected);
          });
          
          this.interceptors.response.forEach(function pushResponseInterceptors(interceptor) {
          chain.push(interceptor.fulfilled, interceptor.rejected);
          });
          
          while (chain.length) {
          promise = promise.then(chain.shift(), chain.shift());
          }
          
          return promise;
      
    3. lib/InterceptorManager.js:攔截器管理,是一個(gè)對[]的封裝
    4. lib/dispatchRequest.js:發(fā)送請求的Promise型将,完成發(fā)送請求的邏輯寂祥。注意看Axios.js中的var chain = [dispatchRequest, undefined];
    5. adapter/*:適配器,這里的代碼保證了Axios在ssr模式下和瀏覽器環(huán)境中區(qū)分環(huán)境實(shí)現(xiàn)請求返送的邏輯七兜。里面存放了兩個(gè)定義好的適配器丸凭,可以參照README.md中的描述自定義適配器
  2. 攔截器模型


    Axios攔截器示意圖.png
    • request和response的攔截器都可以有多對,其中每一個(gè)點(diǎn)都會掛在一個(gè)then()的調(diào)用上,promise.then(chain.shift(), chain.shift());

使用場景:應(yīng)對OAuth中refresh_tokenaccess_token時(shí)其他請求需等待的問題

  • 根據(jù)場景來看贮乳,我們需要有一下幾個(gè)能力

    1. Request攔截器中任意的請求(比如請求A)進(jìn)入之后忧换,如果主動(dòng)檢測到了access_token的超時(shí),那么停止當(dāng)前請求A向拆,開啟refresh_token的請求亚茬,當(dāng)成功之后再執(zhí)行A請求
    2. 當(dāng)請求已發(fā)送,服務(wù)端識別到了token失效浓恳,Response攔截器中的處理跟Request攔截器要做的事一樣
    3. 當(dāng)有進(jìn)行中的refresh_token請求時(shí)刹缝,此請求需要等待這個(gè)進(jìn)行中的refresh_token的請求成功之后再進(jìn)行發(fā)送
  • 那我們一個(gè)一個(gè)來處理

    1. 當(dāng)請求進(jìn)入攔截器,主動(dòng)發(fā)現(xiàn)需要refresh_token時(shí)(比如access_token有效期臨近)需要將請求放置在refresh_token成功之后

      • 處理方式可以采用在then()調(diào)用攔截器的方法時(shí)返回一個(gè)Promise颈将,然后在Promise中等待refresh_token的請求成功之后再進(jìn)行當(dāng)前進(jìn)入的請求的發(fā)送
      // axios 的 request攔截器
      axios.interceptors.request.use(config => {
          return new Promise(resolve => {
              // 模擬等待refresh_token
              setTimeout(function (config_param) {
                  resolve(config_param);
              }, 2000, config)
          });
      });
      
      • 上面的代碼只是一個(gè)簡單的示意梢夯,實(shí)際處理中要注意以下幾點(diǎn),
        • 刷新token之后config_param要處理新Token的拼裝晴圾;
        • 請求攔截器中要能識別出是否是refresh_token的請求颂砸;
        • 能識別出是否正在進(jìn)行refresh_token,并能正確處理其他進(jìn)入的請求死姚,這個(gè)后面會講到
      • 處理之后調(diào)用鏈會變成這樣


        請求攔截器中加入Promise
    2. 當(dāng)請求已發(fā)送人乓,服務(wù)端識別到了Token失效時(shí)(這個(gè)情況比較多,服務(wù)器時(shí)間與本地有間隙都毒;Token不支持多點(diǎn)登陸等等)色罚,需要先refresh_token,然后重發(fā)請求

      • 可以采用與Request攔截器相似的處理账劲,在攔截器中同樣開啟refresh_token戳护,成功之后重新創(chuàng)建已經(jīng)失敗的請求,執(zhí)行完請求之后將重新創(chuàng)建的請求獲取到的返回值resolve給response的返回值
        let res = response.data;
        switch (res.code) {
            case RespStatus.UNAUTHORIZED.code: {
                let respConfig = response.config;
                if (isRefreshTokenReq(respConfig.url)) {
                    //刷新Token的請求如果出現(xiàn)401直接退出登錄
                    showLoginOut();
                } else {
                    logDebug('請求的返回值出現(xiàn)401瀑焦,由請求' + config.url + '的返回值觸發(fā)腌且,開始進(jìn)行refresh_token!');
                    let auth = storage.state.user.auth;
                    try {
                        res = doRefreshToken(auth.refresh_token, auth.wmq_d_current_username, respConfig)
                            .then(config => {
                                return wmqhttp(attachAuthInfoToConfig(storage.state.user.auth, config));
                            }).then(value => {
                                return Promise.resolve(value);
                            });
                    } catch (e) {
                        console.log('無法等待刷新Token蝠猬!', e);
                        showLoginOut();
                    }
                }
                break;
            }
            default:
                logDebug('Axios response default data:', res);
                break;
        }
        return res;
  • 處理之后調(diào)用鏈會變成這樣


    響應(yīng)攔截器中加入Promise和二次請求
  1. 對于在refresh_token時(shí)其他請求的進(jìn)入需要安排這個(gè)請求動(dòng)作切蟋,讓請求發(fā)生在refresh_token之后進(jìn)行
    - 解決思路如下,在全局的狀態(tài)中記錄是否正在刷新請求榆芦,并且保存refresh_tokenPromise。當(dāng)遇到請求之后新創(chuàng)建一個(gè)Promise交給攔截器喘鸟,在新創(chuàng)建的Promise中用then()等待refresh_token匆绣。
       new Promise(resolve => {
           pendingPromise.then(() => {
               logDebug('刷新Token成功,開始處理之前等待的請求', config.url);
               resolve(attachAuthInfoToConfig(storage.state.user.auth, config));
           });
       });
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末什黑,一起剝皮案震驚了整個(gè)濱河市崎淳,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌愕把,老刑警劉巖拣凹,帶你破解...
    沈念sama閱讀 206,126評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件森爽,死亡現(xiàn)場離奇詭異,居然都是意外死亡嚣镜,警方通過查閱死者的電腦和手機(jī)爬迟,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,254評論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來菊匿,“玉大人付呕,你說我怎么就攤上這事〉Γ” “怎么了徽职?”我有些...
    開封第一講書人閱讀 152,445評論 0 341
  • 文/不壞的土叔 我叫張陵,是天一觀的道長佩厚。 經(jīng)常有香客問我姆钉,道長,這世上最難降的妖魔是什么抄瓦? 我笑而不...
    開封第一講書人閱讀 55,185評論 1 278
  • 正文 為了忘掉前任潮瓶,我火速辦了婚禮,結(jié)果婚禮上闺鲸,老公的妹妹穿的比我還像新娘筋讨。我一直安慰自己,他們只是感情好摸恍,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,178評論 5 371
  • 文/花漫 我一把揭開白布悉罕。 她就那樣靜靜地躺著,像睡著了一般立镶。 火紅的嫁衣襯著肌膚如雪壁袄。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 48,970評論 1 284
  • 那天媚媒,我揣著相機(jī)與錄音嗜逻,去河邊找鬼。 笑死缭召,一個(gè)胖子當(dāng)著我的面吹牛栈顷,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播嵌巷,決...
    沈念sama閱讀 38,276評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼萄凤,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了搪哪?” 一聲冷哼從身側(cè)響起靡努,我...
    開封第一講書人閱讀 36,927評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后惑朦,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體兽泄,經(jīng)...
    沈念sama閱讀 43,400評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,883評論 2 323
  • 正文 我和宋清朗相戀三年漾月,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了病梢。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 37,997評論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡栅屏,死狀恐怖飘千,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情栈雳,我是刑警寧澤护奈,帶...
    沈念sama閱讀 33,646評論 4 322
  • 正文 年R本政府宣布,位于F島的核電站哥纫,受9級特大地震影響霉旗,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜蛀骇,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,213評論 3 307
  • 文/蒙蒙 一厌秒、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧擅憔,春花似錦鸵闪、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,204評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至个榕,卻和暖如春篡石,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背西采。 一陣腳步聲響...
    開封第一講書人閱讀 31,423評論 1 260
  • 我被黑心中介騙來泰國打工凰萨, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人械馆。 一個(gè)月前我還...
    沈念sama閱讀 45,423評論 2 352
  • 正文 我出身青樓胖眷,卻偏偏與公主長得像,于是被迫代替她去往敵國和親霹崎。 傳聞我的和親對象是個(gè)殘疾皇子瘦材,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,722評論 2 345

推薦閱讀更多精彩內(nèi)容