axios * 管理类链式调用手写实现及原理剖析
作者:小p 发布时间:2023-07-02 16:38:23
axios库的 * 使用
我们知道axios
库的 * 的使用方式如下:
// 添加一个请求 *
axios.interceptors.request.use(function (config) {
// 在发送请求之前可以做一些事情
return config;
}, function (error) {
// 处理请求错误
return Promise.reject(error);
});
// 添加一个响应 *
axios.interceptors.response.use(function (response) {
// 处理响应数据
return response;
}, function (error) {
// 处理响应错误
return Promise.reject(error);
});
在 axios
对象上有一个 interceptors
对象属性,该属性又有 request
和 response
2 个属性,它们都有一个 use
方法,use
方法支持 2 个参数,第一个参数类似 Promise.then
的 resolve
函数,第二个参数类似 Promise.then
的 reject
函数。我们可以在 resolve
函数和 reject
函数中执行同步代码或者是异步代码逻辑。
并且我们是可以添加多个 * 的, * 的执行顺序是链式依次执行的方式。对于 request
* ,后添加的 * 会在请求前的过程中先执行;对于 response
* ,先添加的 * 会在响应后先执行。
axios.interceptors.request.use(config => {
config.headers.test += '1'
return config
})
axios.interceptors.request.use(config => {
config.headers.test += '2'
return config
})
此外,我们也可以支持删除某个 * ,如下:
const myInterceptor = axios.interceptors.request.use(function () {/*...*/})
axios.interceptors.request.eject(myInterceptor)
整体设计
我们先用一张图来展示一下 * 工作流程:
整个过程是一个链式调用的方式,并且每个 * 都可以支持同步和异步处理,我们自然而然地就联想到使用 Promise 链的方式来实现整个调用过程。
在这个 Promise 链的执行过程中,请求 * resolve
函数处理的是 config
对象,而相应 * resolve
函数处理的是 response
对象。
在了解了 * 工作流程后,我们先要创建一个 * 管理类,允许我们去添加 删除和遍历 * 。
* 管理类实现
根据需求,axios
拥有一个 interceptors
对象属性,该属性又有 request
和 response
2 个属性,它们对外提供一个 use
方法来添加 * ,我们可以把这俩属性看做是一个 * 管理对象。
use
方法支持 2 个参数,第一个是 resolve
函数,第二个是 reject
函数,对于 resolve
函数的参数,请求 * 是 AxiosRequestConfig
类型的,而响应 * 是 AxiosResponse
类型的;而对于 reject
函数的参数类型则是 any
类型的。
根据上述分析,我们先来定义一下 * 管理对象对外的接口。
接口定义
这里我们定义了 AxiosInterceptorManager
泛型接口,因为对于 resolve
函数的参数,请求 * 和响应 * 是不同的。
export interface AxiosInterceptorManager<T> {
use(resolved: ResolvedFn<T>, rejected?: RejectedFn): number
eject(id: number): void
}
export interface ResolvedFn<T=any> {
(val: T): T | Promise<T>
}
export interface RejectedFn {
(error: any): any
}
代码实现
import { ResolvedFn, RejectedFn } from '../types'
interface Interceptor<T> {
resolved: ResolvedFn<T>
rejected?: RejectedFn
}
export default class InterceptorManager<T> {
private interceptors: Array<Interceptor<T> | null>
constructor() {
// * 数组
this.interceptors = []
}
// 收集 *
use(resolved: ResolvedFn<T>, rejected?: RejectedFn): number {
this.interceptors.push({
resolved,
rejected
})
return this.interceptors.length - 1
}
// 遍历用户写的 * ,并执行fn函数把 * 作为参数传入
forEach(fn: (interceptor: Interceptor<T>) => void): void {
this.interceptors.forEach(interceptor => {
if (interceptor !== null) {
fn(interceptor)
}
})
}
eject(id: number): void {
if (this.interceptors[id]) {
// 置为null,不能直接删除
this.interceptors[id] = null
}
}
}
我们定义了一个 InterceptorManager
泛型类,内部维护了一个私有属性 interceptors
,它是一个数组,用来存储 * 。该类还对外提供了 3 个方法,其中 use
接口就是添加 * 到 interceptors
中,并返回一个 id
用于删除;
forEach
接口就是遍历 interceptors
用的,它支持传入一个函数,遍历过程中会调用该函数,并把每一个 interceptor
作为该函数的参数传入;eject
就是删除一个 * ,通过传入 * 的 id
删除。
链式调用实现
当我们实现好 * 管理类,接下来就是在 Axios
中定义一个 interceptors
属性,它的类型如下:
interface Interceptors {
request: InterceptorManager<AxiosRequestConfig>
response: InterceptorManager<AxiosResponse>
}
export default class Axios {
interceptors: Interceptors
constructor() {
this.interceptors = {
request: new InterceptorManager<AxiosRequestConfig>(),
response: new InterceptorManager<AxiosResponse>()
}
}
}
Interceptors
类型拥有 2 个属性,一个请求 * 管理类实例,一个是响应 * 管理类实例。我们在实例化 Axios
类的时候,在它的构造器去初始化这个 interceptors
实例属性。
接下来,我们修改 request
方法的逻辑,添加 * 链式调用的逻辑:
interface PromiseChain {
resolved: ResolvedFn | ((config: AxiosRequestConfig) => AxiosPromise)
rejected?: RejectedFn
}
request(url: any, config?: any): AxiosPromise {
if (typeof url === 'string') {
if (!config) {
config = {}
}
config.url = url
} else {
config = url
}
// 定义一个数组,这个数组就是要执行的任务链,默认有一个真正发送请求的任务
const chain: PromiseChain[] = [{
resolved: dispatchRequest,
rejected: undefined
}]
// 把用户定义的请求 * 存放到任务链中,请求 * 最后注册的最先执行,所以使用unshift方法
this.interceptors.request.forEach(interceptor => {
chain.unshift(interceptor)
})
// 把响应 * 存放到任务链中
this.interceptors.response.forEach(interceptor => {
chain.push(interceptor)
})
// 利用config初始化一个promise
let promise = Promise.resolve(config)
// 遍历任务链
while (chain.length) {
// 取出任务链的首个任务
const { resolved, rejected } = chain.shift()!
// resolved的执行时机是就是上一个promise执行resolve()的时候,这样就形成了链式调用
promise = promise.then(resolved, rejected)
}
return promise
}
首先,构造一个 PromiseChain
类型的数组 chain
,并把 dispatchRequest
函数赋值给 resolved
属性;接着先遍历请求 * 插入到 chain
的前面;然后再遍历响应 * 插入到 chain
后面。
接下来定义一个已经 resolve 的 promise
,循环这个 chain
,拿到每个 * 对象,把它们的 resolved
函数和 rejected
函数添加到 promise.then
的参数中,这样就相当于通过 Promise 的链式调用方式,实现了 * 一层层的链式调用的效果。
注意我们 * 的执行顺序,对于请求 * ,先执行后添加的,再执行先添加的;而对于响应 * ,先执行先添加的,后执行后添加的。
来源:https://juejin.cn/post/7136065256941420552


猜你喜欢
- 数据库优化包含以下三部分,数据库自身的优化,数据库表优化,程序操作优化.此文为第二部分 优化①:设计规范化表,消除数据冗余 数据库
- 今天用实验室的pycharm运行程序的时候发现出现了已安装的模块无法导入的情况,但实际上这个模块我已经在notebook中使用多次了,所以不
- 在Mac OS上安装redis首先是安装,它会默认安装到/usr/local/bin下cd /tmpwget http://redis.go
- phpinfo() 功能描述:输出 PHP 环境信息以及相关的模块、WEB 环境等信息。 危险等级:中 passthru() 功能描述:允许
- Python中的frame是什么栈帧(frame)栈帧表示程序运行时函数调用栈中的某一帧。想要获得某个函数相关的栈帧,则必须在调用这个函数且
- 介绍最近在项目中遇到插入数据瓶颈,几万、几十万、几百万的数据保存到MYSQL数据库,使用EF插入数据速度非常慢,数据量非常大时EF插入需要几
- 前言之前我们分享过用Python进行可视化的9种常见方式。其实我们还能让可视化图形逼格更高一些,今天就分享一下如何让可视化秀起来:用Pyth
- 安装使用pip install XlsxWriter来安装,Xlsxwriter用来创建excel表格,功能很强大,下面具体介绍:1.简单使
- 接着前面Django入门使用示例今天我们来看看Django是如何加载静态html的?我们首先来看一看什么是静态HTML,什么是动态的HTML
- 有时候我不需要网络立即执行更改的数据。请问如何做到? 用下列办法即可延时执行:<%@import&
- 本篇博客参考Keqi Zhang的文章“A Progressive Morphological Filter for Removing No
- 引言python编程时,一部分人习惯将实现同一个功能的代码放在同一个文件;使用这些代码只需要import就可以了;下面看一个例子。testM
- 本文实例讲述了python检测某个变量是否有定义的方法。分享给大家供大家参考。具体如下:第一种方法使用内置函数locals():'t
- 1、从外部文档中粘贴时,如果不想要其格式,只要文字,可以使用“Edit->paste as text”命令,而不要直接Ctrl+V。2
- 近日,sql数据库入门学习群有朋友问到,利用sql如何删除表格的前1000行数据,是否可以实现?如果是oracle数据库管理软件,实现起来相
- 有时候我们的数据是按某个频率收集的,比如每日、每月、每15分钟,那么我们怎么产生对应频率的索引呢?pandas中的date_range可用于
- Beautiful Soup 库一般被称为bs4库,支持Python3,是我们写爬虫非常好的第三方库。因用起来十分的简便流畅。所以也被人叫做
- 最近在做python的web开发(原谅我的多变,好东西总想都学着。。。node.js也是),不过过程中总遇到些问题,不管是web.py还是d
- 字符替换是一个非常重要的功能,javascript 中有一个 String.replace( ),但是此方法有
- 在JavaScript中存在这样两种原始类型:Null与Undefined。这两种类型常常会使JavaScript的开发人员产生疑惑,在什么