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. 前言
HTTP協議中,在請求headers
中有個 Authorization
屬性,該屬性里包含了服務器用於驗證用戶代理身份的憑證,通常會在服務器返回401 Unauthorized
狀態碼以及WWW-Authenticate
消息頭之后在后續請求中發送此消息頭,詳細信息可以查看這里。
在官方axios
中,允許用戶在請求配置對象config
中配置auth
屬性,該屬性是一個對象結構,包含了 username
和 password
兩個屬性。當用戶在請求的時候配置了這兩個屬性,axios
就會自動往 HTTP 的請求 headers
中添加 Authorization
屬性,它的值為 username:password
經過base64
加密后的結果。
本篇文章我們就來為我們的axios
的請求配置對象上添加auth
屬性,並且在發送請求前判斷用戶是否配置了該屬性,如果配置了就把它經過base64
加密后添加到請求 headers
中的 Authorization
屬性上。
2. 向請求配置對象添加屬性
在請求配置對象config
中添加 auth
屬性之前,我們需要先在src/types/index.ts
中的配置對象的接口類型定義AxiosRequestConfig
上添加該屬性的定義,如下:
export interface AxiosRequestConfig {
// 新增
auth?: AxiosBasicCredentials;
}
export interface AxiosBasicCredentials {
username: string;
password: string;
}
3. 把屬性添加到headers上
添加好以后,我們只需在發送請求之前判斷用戶是否配置了該屬性,如果配置了就把該屬性經過base64
加密后添加到請求 headers
中的 Authorization
屬性上。
// src/core/xhr.ts
const {
// 新增
auth
} = config;
if (auth) {
const username = auth.username || "";
const password = auth.password || "";
headers["Authorization"] = "Basic " + btoa(username + ":" + password);
}
OK,auth
屬性就添加好了,是不是很簡單?接下來,我們就來編寫demo
來測試下效果如何。
4. demo編寫
在 examples
目錄下創建 HTTPAuthorization
目錄,在 HTTPAuthorization
目錄下創建 index.html
:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>HTTPAuthorization demo</title>
</head>
<body>
<script src="/__build__/HTTPAuthorization.js"></script>
</body>
</html>
接着再創建 app.ts
作為入口文件:
import axios from "../../src/axios";
axios.get("/api/HTTPAuthorization", {
auth:{
username: 'NLRX',
password: '123456'
}
})
.then(res => {
console.log(res);
});
接着在 server/server.js
添加新的接口路由:
const atob = require("atob");
// 添加HTTP授權
router.get("/api/HTTPAuthorization", function(req, res) {
const auth = req.headers.authorization;
const [type, credentials] = auth.split(" ");
const [username, password] = atob(credentials).split(":");
res.json({
type: type,
username: username,
password: password
});
});
在服務端路由接口中,我們將收到的auth
使用第三方庫atob
進行Base64
解碼,然后將驗證類型、username
、password
分別取出來,返回給前端。
最后在根目錄下的index.html
中加上啟動該demo
的入口:
<li><a href="examples/HTTPAuthorization">HTTPAuthorization</a></li>
OK,我們在命令行中執行:
# 同時開啟客戶端和服務端
npm run server | npm start
接着我們打開 chrome
瀏覽器,訪問 http://localhost:8000/ 即可訪問我們的 demo
了,我們點擊 HTTPAuthorization
,就可以看到請求已經正常發出,並且在請求的headers
中添加上了Authorization
字段,並且字段值是經過Base64
加密后的值,我們在服務端進行base64
解碼,然后將驗證類型、username
、password
分別取出來返回給前端,我們在請求響應中看到解密后的信息就是我們發請求是加密的信息。
OK,以上就是為我們的axios
添加HTTP授權auth
屬性。
(完)