Axios的攔截器原理以及請求等待重發的實現

Vue項目越做越多,Axios一直作為請求發送的基礎工程,這里就深究一下Axios的攔截器相關的一些邏輯和對應一個比較惡心的場景。
Axios GitHub

回顧下Promise

  1. Promise的基礎知識不做多介紹可以參考兩個文章

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

    1. Promise狀態一旦改變就不能再變,一直保持此狀態
    2. Promise可以被其他Promise鎖定----這個很重要,跟后面的要說到的Axios的請求阻塞等待有關系
    3. 一個重要的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)
    });
    
  • 輸出如下結果

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

Axios

接下來開始整體,說說Axios。Axios是基于Promise機制實現的異步的鏈式請求框架。體積小,源碼易懂。非常適合做基礎的請求庫。

Axios結構

  1. 代碼結構

    1. axios.js:入口文件,將Axios實例的request函數綁定為入口函數,axios.create其實返回的是一個function,就是Axios實例的Axios.prototype.request
    2. lib/Axios.js:真正的Axios的實例,用于拼接攔截器的調用鏈,關鍵代碼如下:
          // 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:攔截器管理,是一個對[]的封裝
    4. lib/dispatchRequest.js:發送請求的Promise,完成發送請求的邏輯。注意看Axios.js中的var chain = [dispatchRequest, undefined];
    5. adapter/*:適配器,這里的代碼保證了Axios在ssr模式下和瀏覽器環境中區分環境實現請求返送的邏輯。里面存放了兩個定義好的適配器,可以參照README.md中的描述自定義適配器
  2. 攔截器模型


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

使用場景:應對OAuth中refresh_tokenaccess_token時其他請求需等待的問題

  • 根據場景來看,我們需要有一下幾個能力

    1. Request攔截器中任意的請求(比如請求A)進入之后,如果主動檢測到了access_token的超時,那么停止當前請求A,開啟refresh_token的請求,當成功之后再執行A請求
    2. 當請求已發送,服務端識別到了token失效,Response攔截器中的處理跟Request攔截器要做的事一樣
    3. 當有進行中的refresh_token請求時,此請求需要等待這個進行中的refresh_token的請求成功之后再進行發送
  • 那我們一個一個來處理

    1. 當請求進入攔截器,主動發現需要refresh_token時(比如access_token有效期臨近)需要將請求放置在refresh_token成功之后

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


        請求攔截器中加入Promise
    2. 當請求已發送,服務端識別到了Token失效時(這個情況比較多,服務器時間與本地有間隙;Token不支持多點登陸等等),需要先refresh_token,然后重發請求

      • 可以采用與Request攔截器相似的處理,在攔截器中同樣開啟refresh_token,成功之后重新創建已經失敗的請求,執行完請求之后將重新創建的請求獲取到的返回值resolve給response的返回值
        let res = response.data;
        switch (res.code) {
            case RespStatus.UNAUTHORIZED.code: {
                let respConfig = response.config;
                if (isRefreshTokenReq(respConfig.url)) {
                    //刷新Token的請求如果出現401直接退出登錄
                    showLoginOut();
                } else {
                    logDebug('請求的返回值出現401,由請求' + config.url + '的返回值觸發,開始進行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;
  • 處理之后調用鏈會變成這樣


    響應攔截器中加入Promise和二次請求
  1. 對于在refresh_token時其他請求的進入需要安排這個請求動作,讓請求發生在refresh_token之后進行
    - 解決思路如下,在全局的狀態中記錄是否正在刷新請求,并且保存refresh_tokenPromise。當遇到請求之后新創建一個Promise交給攔截器,在新創建的Promise中用then()等待refresh_token。
       new Promise(resolve => {
           pendingPromise.then(() => {
               logDebug('刷新Token成功,開始處理之前等待的請求', config.url);
               resolve(attachAuthInfoToConfig(storage.state.user.auth, config));
           });
       });
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,791評論 6 545
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,795評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,943評論 0 384
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 64,057評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,773評論 6 414
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,106評論 1 330
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,082評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,282評論 0 291
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,793評論 1 338
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,507評論 3 361
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,741評論 1 375
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,220評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,929評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,325評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,661評論 1 296
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,482評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,702評論 2 380

推薦閱讀更多精彩內容