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. 前言
在官方 axios
中,還提供了 axios.all
和axios.spread
這兩個方法,這兩個方法主要是為了執行多個並發請求,官方文檔中,它們的用法示例如下:
function getUserAccount() {
return axios.get('/user/12345');
}
function getUserPermissions() {
return axios.get('/user/12345/permissions');
}
axios.all([getUserAccount(), getUserPermissions()])
.then(axios.spread((acct, perms) => {
// 兩個請求都完成后
}));
從用法示例中可以看出:
axios.all
方法接受一個數組作為參數,數組中的每個元素都是一個請求,返回一個promise
對象,當數組中所有請求均已完成時,執行then
方法。- 在
then
方法中執行了axios.spread
方法。該方法是接收一個函數作為參數,返回一個新的函數。接收的參數函數的參數是axios.all
方法中每個請求返回的響應。
2. 窺探本質
2.1 axios.all本質
從axios.all
方法的使用方式以及使用形式上看,是不是跟Promise.all
方法很相似?對,沒錯,axios.all
就是給Promise.all
方法換了個名字而已,我們看看Promise.all
方法是如何使用的,如下:
function getUserAccount() {
return axios.get('/user/12345');
}
function getUserPermissions() {
return axios.get('/user/12345/permissions');
}
Promise.all([getUserAccount(), getUserPermissions()])
.then(([acct,perms]) => {
// 兩個請求都完成后
}));
我們可以看到,axios.all
方法與Promise.all
方法是一模一樣的,不管是使用方式還是傳入的參數都是一模一樣的。axios.all
的本質搞明白以后我們再看看axios.spread
的本質。
2.2 axios.spread本質
上文說了,axios.all
方法與Promise.all
方法是一模一樣的,唯一看起來不同的地方就是then
方法,我們先來比較這兩個then
方法中的內容:
// axios.all的then
axios.spread((acct, perms) => {})
// Promise.all的then
([acct,perms]) => {}
我們可以看到,Promise.all
的then
方法里面是個函數,函數的參數是所有請求的響應組成的數組;而axios.all
的then
方法里面調用了axios.spread
方法,axios.spread
方法接收一個函數作為參數,該參數函數的參數也是所有請求的響應,既然上文說了axios.all
方法與Promise.all
方法是一模一樣的,那么我們只需想辦法再讓兩個then
方法相同即可。也就是說我們創建一個axios.spread
方法並且讓axios.spread((acct, perms) => {})
的返回值與([acct,perms]) => {}
等價即可。
OK,搞清楚這兩個方法的本質以后,我們就來着手實現它們。
3. 方法接口類型定義
實現這兩個方法之前,我們先在src/types/index.ts
中的AxiosStatic
中為這兩個方法添加接口類型,如下:
export interface AxiosStatic extends AxiosInstance {
// 新增
all<T>(promises: Array<T | Promise<T>>): Promise<T[]>;
spread<T, R>(callback: (...args: T[]) => R): (arr: T[]) => R;
}
添加好之后接下來就來實現這兩個方法。
4. 方法實現
這兩個方法是掛載到axios
混合對象上的,那么我們就在src/axios.ts
中實現這兩個方法,並將其掛載到axios
上,如下:
axios.all = function(promises) {
return Promise.all(promises);
};
axios.spread = function(callback) {
return function wrap(arr) {
return callback.apply(null, arr);
};
};
根據第2章的分析:
axios.all
方法就是對Promise.all
方法進行了一層包裝,本質上是一模一樣的,沒有任何額外的邏輯,所以調用axios.all
方法就是調用了Promise.all
方法。- 對於
axios.spread
方法,根據我們的分析結果只需讓axios.spread((acct, perms) => {})
的返回值與([acct,perms]) => {}
等價即可。
OK,這樣就把這兩個方法實現完畢了,接下來我們來編寫demo
來測試下效果如何。
5. demo編寫
在 examples
目錄下創建 allAndSpread
目錄,在 allAndSpread
目錄下創建 index.html
:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>allAndSpread demo</title>
</head>
<body>
<script src="/__build__/allAndSpread.js"></script>
</body>
</html>
接着再創建 app.ts
作為入口文件:
import axios from "../../src/axios";
function getA() {
return axios.get("/api/allAndSpreadA");
}
function getB() {
return axios.get("/api/allAndSpreadB");
}
axios.all([getA(), getB()]).then(
axios.spread(function(resA, resB) {
console.log(resA.data);
console.log(resB.data);
})
);
axios.all([getA(), getB()]).then(([resA, resB]) => {
console.log(resA.data);
console.log(resB.data);
});
接着在 server/server.js
添加新的接口路由:
// 添加axios.all和axios.spread方法
router.get("/api/allAndSpreadA", function(req, res) {
res.json({
data: "allAndSpreadA"
});
});
router.get("/api/allAndSpreadB", function(req, res) {
res.json({
data: "allAndSpreadB"
});
});
最后在根目錄下的index.html
中加上啟動該demo
的入口:
<li><a href="examples/allAndSpread">allAndSpread</a></li>
OK,我們在命令行中執行:
# 同時開啟客戶端和服務端
npm run server | npm start
接着我們打開 chrome
瀏覽器,訪問 http://localhost:8000/ 即可訪問我們的 demo
了,我們點擊 allAndSpread
,就可以看到兩個請求都已經正常發出,並且打開F12
中的控制台可以看到兩個請求的響應都已經返回了。
OK,以上就是axios.all
和axios.spread
方法實現。
(完)