0. 系列文章
1.使用Typescript重構axios(一)——寫在最前面
2.使用Typescript重構axios(二)——項目起手,跑通流程
3.使用Typescript重構axios(三)——實現基礎功能:處理get請求url參數
4.使用Typescript重構axios(四)——實現基礎功能:處理post請求參數
5.使用Typescript重構axios(五)——實現基礎功能:處理請求的header
6.使用Typescript重構axios(六)——實現基礎功能:獲取響應數據
7.使用Typescript重構axios(七)——實現基礎功能:處理響應header
8.使用Typescript重構axios(八)——實現基礎功能:處理響應data
9.使用Typescript重構axios(九)——異常處理:基礎版
10.使用Typescript重構axios(十)——異常處理:增強版
11.使用Typescript重構axios(十一)——接口擴展
12.使用Typescript重構axios(十二)——增加參數
13.使用Typescript重構axios(十三)——讓響應數據支持泛型
14.使用Typescript重構axios(十四)——實現攔截器
15.使用Typescript重構axios(十五)——默認配置
16.使用Typescript重構axios(十六)——請求和響應數據配置化
17.使用Typescript重構axios(十七)——增加axios.create
18.使用Typescript重構axios(十八)——請求取消功能:總體思路
19.使用Typescript重構axios(十九)——請求取消功能:實現第二種使用方式
20.使用Typescript重構axios(二十)——請求取消功能:實現第一種使用方式
21.使用Typescript重構axios(二十一)——請求取消功能:添加axios.isCancel接口
22.使用Typescript重構axios(二十二)——請求取消功能:收尾
23.使用Typescript重構axios(二十三)——添加withCredentials屬性
24.使用Typescript重構axios(二十四)——防御XSRF攻擊
25.使用Typescript重構axios(二十五)——文件上傳下載進度監控
26.使用Typescript重構axios(二十六)——添加HTTP授權auth屬性
27.使用Typescript重構axios(二十七)——添加請求狀態碼合法性校驗
28.使用Typescript重構axios(二十八)——自定義序列化請求參數
29.使用Typescript重構axios(二十九)——添加baseURL
30.使用Typescript重構axios(三十)——添加axios.getUri方法
31.使用Typescript重構axios(三十一)——添加axios.all和axios.spread方法
32.使用Typescript重構axios(三十二)——寫在最后面(總結)
1. 前言
在上篇文章中,我們處理異常時僅僅獲取了異常的文本信息,但是對出現異常的請求的詳細信息並未獲取,我們期望在請求發生異常時我們能獲取到該請求的對象配置 config
,錯誤代碼 code
,XMLHttpRequest
對象實例 request
以及響應對象 response
,方便用戶進行異常定位排查,如下:
axios({
method: "get",
url: "/api/handleError1"
})
.then(res => {
console.log(res);
})
.catch(e => {
console.log(e.message);
console.log(e.config);
console.log(e.request);
console.log(e.code);
});
那么,接下來,我們就來增強異常信息。
2. 異常信息接口類型定義
根據我們所要獲取的幾個異常信息,我們先在src/types.index.ts
中定義一下異常信息的接口類型,如下:
export interface AxiosError extends Error {
config: AxiosRequestConfig;
code?: string | null | number;
request?: any;
response?: AxiosResponse;
}
3. 創建AxiosError類
定義好接口類型以后,我們就來創建一個AxiosError
類,該類繼承自內置的Error
類,我們在src/helpers
路徑下創建error.ts
文件,如下:
// src/helpers/error.ts
import { AxiosRequestConfig, AxiosResponse } from "../types";
export class AxiosError extends Error {
private config: AxiosRequestConfig;
private request?: any;
private code?: string | null | number;
private response?: AxiosResponse;
constructor(
message: string,
config: AxiosRequestConfig,
request?: any,
code?: string | null | number,
response?: AxiosResponse
) {
super(message);
this.config = config;
this.request = request;
this.code = code;
this.response = response;
Object.setPrototypeOf(this, AxiosError.prototype);
}
}
export function createError(
message: string,
config: AxiosRequestConfig,
code: string | null | number,
request?: any,
response?: AxiosResponse
) {
const error = new AxiosError(message, config, code, request, response);
return error;
}
AxiosError
類繼承於 Error
類,添加了一些自己的屬性:config
、code
、request
、response
、isAxiosError
等屬性。除此之外,我們還創建了一個用於快速創建AxiosError
類實例的工廠方法createError
,后續我們可以直接調用該方法,並傳入相關的參數來快速創建AxiosError
類實例。
OK,定義好之后我們就可以使用一下。
4. 使用AxiosError類
AxiosError
類使用起來非常簡單,我們只需把上篇文章中在src/xhr.ts
中拋出異常的地方的new Error()
改成createError
就好啦。
// src/xhr.ts
import { AxiosError } from "./helpers/error";
request.onerror = function() {
reject(createError(
"Net Error",
config,
null,
request
));
};
request.ontimeout = function() {
reject(
createError(
`Timeout of ${timeout} ms exceeded`,
config,
"TIMEOUT",
request
)
);
};
function handleResponse(response: AxiosResponse): void {
if (response.status >= 200 && response.status < 300) {
resolve(response);
} else {
reject(
createError(
`Request failed with status code ${response.status}`,
config,
null,
request.status,
response
)
);
}
}
改寫完成后,我們就可以編寫demo
來測試一下,看看效果如何。
5. 編寫demo
上篇文章中的demo
我們完全可以復用,只需在異常捕獲那里稍加改動,加上我們開頭想要獲取的幾個異常信息打印即可,看看是否能夠獲取到。
// examples/handleError/app.ts
axios({
method: "get",
url: "/api/handleError1"
})
.then(res => {
console.log(res);
})
.catch(e => {
console.log(e.message);
console.log(e.config);
console.log(e.request);
console.log(e.code);
});
OK,接下來,我們就可以將項目運行起來,打開 chrome
瀏覽器,訪問 http://localhost:8000/ 即可訪問我們的 demo
了,我們點擊 handleError
,通過F12
的控制台我們可以看到:我們想要的異常信息已經可以獲取到了。
OK,異常處理這塊我們就已經搞定了!
(完)