0. 系列文章

項目源碼請猛戳這里!!!

1. 前言

雖然我們現在已經實現了官方axios請求取消功能的兩種使用方式，但是官方axios上還有個isCancel接口還未實現。該接口接收一個異常對象e作為參數，用來判斷該異常是否是由取消請求導致的，如果是的話該異常對象就應該是請求取消的原因；該接口實現起來也不難，我們可以創建一個取消原因Cancel類，而把請求取消的原因作為該類的實例，這樣我們在捕獲異常的時候只需判斷異常對象是不是Cancel類的實例，如果是的話，那么它就是請求取消原因，否則就是其他異常。OK，思路就是這樣，接下來，我們就來實現它。

2. 定義Cancel接口類型

創建cancel類之前，我們先在src/types/index.ts中定義接口類型，如下：

export interface Cancel {
  message?: string
}

export interface CancelStatic {
  new(message?: string): Cancel
}

我們先定義了Cancel類的實例對象類型Cancel，它里面只有一個屬性，那就是取消原因message，接着還定義了Cancel類的類類型，它里面包含了構造函數屬性，構造函數接收取消原因作為參數，返回Cancel類的實例對象。

3. 創建Cancel類

接口類型定義好之后，我們就來創建Cancel類，我們在src/cancel目錄下創建Cancel.ts文件，在該文件內創建Cancel類，如下：

export default class Cancel {
  message: string;
  constructor(message:string){
    this.message = message
  }
}

該類的實現非常簡單，就是實例化一個取消原因對象，該對象的message屬性就是請求的取消原因。

4. 創建isCancel方法

創建好Cancel類之后，我們還應該創建一個isCancel函數，該函數用來判斷異常對象是不是取消原因對象，返回true或false。我們在src/cancel目錄下創建isCancel.ts文件，在該文件內創建isCancel函數，如下：

import Cancel from "./Cancel";

export default function isCancel(val:any):boolean {
  return val instanceof Cancel
}

判斷異常對象是不是取消原因對象，我們只需判斷它是不是Cancel類的實例即可。

5. 添加Cancel和isCancel接口

創建好isCancel函數后，最后，我們將其添加到axios混合對象上，添加之前，還是要先在axios混合對象接口定義中添加isCancel屬性，如下：

export interface AxiosStatic extends AxiosInstance {
  create(config?: AxiosRequestConfig): AxiosInstance;
  CancelToken: CancelTokenStatic;
  Cancel: CancelStatic;
  isCancel: (value: any) => boolean;
}

添加好接口類型以后，我們就可以在src/axios.ts中給axios混合對象添加Cancel和isCancel接口了，如下：

import Cancel from "./cancel/Cancel";
import isCancel from "./cancel/isCancel";
axios.Cancel = Cancel;
axios.isCancel = isCancel;

6. 修改之前的取消原因類型

我們現在創建取消原因Cancel類，所以我們需要將之前寫的取消原因message從string類型改成Cancel類型。需要改動如下幾個地方：

src/types/index.ts：

export interface CancelToken {
  promise: Promise<Cancel>
  reason?: Cancel
}

src/cancel/CancelToken.ts

import { Canceler, CancelExecutor, CancelTokenSource} from "../types";
import Cancel from "./Cancel";

interface ResolvePromise {
  (reason?: Cancel): void;
}

export default class CancelToken {
  promise: Promise<Cancel>;
  reason?: Cancel;
  constructor(executor: CancelExecutor) {
    let resolvePromise: ResolvePromise;

    this.promise = new Promise<Cancel>(resolve => {
      resolvePromise = resolve;
    });

    executor(message => {
      if (this.reason) {
        return;
      }
      this.reason = new Cancel(message);
      resolvePromise(this.reason);
    });
  }

  static source(): CancelTokenSource {
    let cancel!: Canceler;
    let token = new CancelToken(c => {
      cancel = c;
    });
    return {
      cancel,
      token
    };
  }
}

修改完之后，isCancel接口就算實現完畢了，接下來，我們就編寫demo測試效果如何。

7. demo編寫

我們繼續沿用上篇文章的demo，只需在src/examples/cancel/app.ts文件中捕獲異常的地方添加上本篇文章實現的異常對象判斷即可，如下：

axios
  .get("/api/cancel", {
    cancelToken: new CancelToken(c => {
      cancel = c;
    })
  })
  .catch(function(e) {
    // 新增
    if (axios.isCancel(e)){
      console.log(`請求取消原因：${e.message}`);
    } 
  });

然后運行項目，我們打開 chrome 瀏覽器，訪問 http://localhost:8000/ 即可訪問我們的 demo 了，我們點擊 cancel，通過F12的控制台中，我們看到取消原因已經被打印出來了。

（完）

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 使用Typescript重構axios(四)——實現基礎功能：處理post請求參數使用Typescript重構axios(十五)——默認配置使用Typescript重構axios(九)——異常處理：基礎版使用Typescript重構axios(一)——寫在最前面使用Typescript重構axios(二)——項目起手，跑通流程基於TypeScript從零重構axios Linux系列教程（二十一）——Linux的bash基本功能 python接口自動化（二十一）--unittest簡介（詳解） pytorch（二十一）：交叉驗證 Java 從入門到進階之路（二十一）