取消正在運行的Promise技巧詳解

Posted on by

前言

最近項目當中小夥伴遇到一個很奇怪的bug，進入一個頁面後，快速切換到其它頁面，會跳轉到403頁面。經過一段時間和小夥伴的排查，發現那個頁面有個接口請求響應時間比較長，請求後還有一些業務處理。

等我們切換到其它頁面，這個請求完成後還會處理剩下的業務，導致出錯。

代碼案例

項目當中有很多業務，我們用一些簡單代碼復現下這個問題。

import React, { useEffect } from 'react';
import { history } from 'umi';
const Test = props => {
  useEffect(() => {
    new Promise((resolve, reject) => {
        // 模擬接口請求時間
        setTimeout(() => {
            resolve()
        }, 4000);
    }).then(res => {
        return new Promise((resolve1) => {
             // 模擬接口請求時間
            setTimeout(() => {
                resolve1()
            }, 1000);
        })
    }).then(() => {
        // Promise 執行完後頁面跳轉
        history.push('/test1')
    })
  }, []);
  const go = () => {
    history.push('/user/login')
  }
  return (
    <div>
      <button onClick={go}>go to</button>
      Test
    </div>
  );
}
export default Test;

我們進入Test組件後，馬上點擊go to按鈕，幾秒之後頁面還會跳轉到test1頁面。

經分析，我們應該在離開的時候要取消請求和取消Promise讓後續的業務代碼不在執行，取消請求比較簡單，一般的庫都支持，我們來說下怎麼取消Promise.

CancelablePromise (取消Promise)

我們知道Promise是沒有提供取消或者終止的操作。但我們在開發過程中會遇到。我們可以參考和借助AbortController來實現。

class CancelablePromise<T> {
  /**
   * 構造器
   * @param executor Promise中的 executor
   * @param abortSignal AbortController中的signal對象
   * @returns 
   */
  constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, abortSignal: AbortSignal) {
    // 記錄reject和resolve方法
    let _reject: any = null;
    let _resolve: any = null;
    let _isExecResolve = false;
    // 創建和執行Promise
    const cancelablePromise = new Promise<T>((resolve, reject) => {
      _reject = reject;
      _resolve = (value: T) => {
        _isExecResolve = true;
        resolve(value);
      };
      return executor(_resolve, reject);
    });
    // 監聽Signal的abourt事件
    abortSignal.addEventListener('abort', () => {
      if (_isExecResolve) {
        return;
      }
      // 拋出錯誤
      const error = new DOMException('user cancel promise', CancelablePromise.CancelExceptionName );
      _reject( error );
    } );
    return cancelablePromise;
  }
  // 取消後拋出的異常名稱
  static CancelExceptionName = 'CancelablePromise AbortError';
}
export default CancelablePromise;

使用

下面我們該造下之前的代碼，用我們封裝的CancelablePromise,可以讓Promise可取消。

多個Promise鏈式調用

import React, { useEffect } from 'react';
import { history } from 'umi';
import CancelablePromise from '../utils/CancelablePromise';
const Test = props => {
  useEffect(() => {
   let abortController = new AbortController();
    new CancelablePromise((resolve, reject) => {
        // 模擬接口請求時間
        setTimeout(() => {
            resolve()
        }, 4000);
    }, abortController.signal).then(res => {
        return new CancelablePromise((resolve1) => {
             // 模擬接口請求時間
            setTimeout(() => {
                resolve1()
            }, 1000);
        }, abortController.signal)
    }).then(() => {
        // Promise 執行完後頁面跳轉
        history.push('/test1')
    })
    return () => {
        // 取消請求
        abortController.abort();
    }
  }, []);
  const go = () => {
    history.push('/user/login')
  }
  return (
    <div>
      <button onClick={go}>go to</button>
      Test
    </div>
  );
}
export default Test;

在async和await中使用

import React, { useEffect } from 'react';
import { history } from 'umi';
import CancelablePromise from '../utils/CancelablePromise';
const Test = props => {
  useEffect(() => {
      let abortController = new AbortController();
     const exec = async function () {
      try {
        await new CancelablePromise((resolve) => {
          setTimeout(() => {resolve();}, 5000);
        }, abortController.signal, 'one')
        await new CancelablePromise((resolve1) => {
          setTimeout(() => {resolve1();}, 5000);
        }, abortController.signal, 'del')
        history.push('/test')
      } catch (error) {
        // 取消之後會拋出異常
        if (CancelablePromise.CancelExceptionName === error.name) {
          console.log('promise 終止瞭。。。')
        }
      }
    }
    exec();
    return () => {
        // 取消請求
        abortController.abort();
    }
  }, []);
}

Promise取消之後會拋出異常，如果需要在拋出異常之後做處理，可以通關對應的異常名稱做判斷。

if (CancelablePromise.CancelExceptionName === error.name) {
  console.log('promise 終止瞭。。。')
}

結束語

Promise的取消在業務當中用到的地方比較多，更多關於Promise運行取消的資料請關註WalkonNet其它相關文章！

推薦閱讀：