【源码共读】学习 axios 源码整体架构 (II)

news2024/12/24 2:38:45

源码分析


跳转至Axios.js文件中

// 构造函数
constructor(instanceConfig) {
    this.defaults = instanceConfig
    // 创建对应的拦截器
    this.interceptors = {
        request: new InterceptorManager(),
        response: new InterceptorManager()
  }
} 

那么,拦截器是怎么创建的呢

  • 首先,我们来看下拦截器的用法
  • www.axios-http.cn/docs/interc…
// 添加请求拦截器
axios.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    return config;
}, function (error) {
    // 对请求错误做些什么
    return Promise.reject(error);
});
​
// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 2xx 范围内的状态码都会触发该函数。
    // 对响应数据做点什么
    return response;
}, function (error) {
    // 超出 2xx 范围的状态码都会触发该函数。
    // 对响应错误做点什么
    return Promise.reject(error);
}); 

移除拦截器,可以这样:

const myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor); 

给自定义的 axios 实例添加拦截器。

const instance = axios.create();
instance.interceptors.request.use(function () {/*...*/}); 

可以看到,请求拦截器响应拦截器都是使用axios.interceptors.xxx.use进行挂载

我们来看下源码实现

 'use strict'
​
import utils from './../utils.js'
​
class InterceptorManager {
    // 用一个数组来存储拦截器函数
    constructor() {
        this.handlers = []
  }
​
    /**
   * 添加一个新的拦截器到栈中
   *
   * @参数 {Function} Promise.then(fulfilled)回调函数
   * @参数 {Function} Promise.reject(rejected) 回调函数
   *
   * @return {Number} 返回ID 用来移除拦截器时使用
   *
   */
    use(fulfilled, rejected, options) {
        this.handlers.push({
            fulfilled,
            rejected,
            // 是否同步
            synchronous: options ? options.synchronous : false,
            // 运行时机
            runWhen: options ? options.runWhen : null
      })
        return this.handlers.length - 1
  }
​
    eject(id) {
        // 如果在handlers中找到对应的id,对应的位置置为空
        if (this.handlers[id]) {
            this.handlers[id] = null
      }
  }
​
    // 重置拦截器数组
    clear() {
        if (this.handlers) {
            this.handlers = []
      }
  }
​
    // 遍历拦截器数组,如果当前的位置为Null,则跳过,否则执行回调函数
    forEach(fn) {
        utils.forEach(this.handlers, function forEachHandler(h) {
            if (h !== null) {
                fn(h)
          }
      })
  }
}
​
export default InterceptorManager
​ 

尝试调试


在全局搜索new XMLHttpRequest并打上断点,点击页面中的Send Request,进入断点

0.点击触发onClick

2.创建axios

3.调用request,检查是否有拦截器* 如果存在拦截器,则先触发

4.执行完dispatchRequest后,调用适配器

5.用Promise包裹xhrRequest

所以这个流程是

点击触发`onClick`
创建axios
调用`request`,检查是否有拦截器
执行完`dispatchRequest`后,调用适配器
用`Promise`包裹`xhrRequest` 

我们来看下request是怎么实现的

request

request(configOrUrl, config) {
    // 检查传入的url是否是string 类型
    if (typeof configOrUrl === 'string') {
        config = config || {}
        config.url = configOrUrl
  } else {
        config = configOrUrl || {}
  }
​
    // 合并默认参数和用户定义的参数
    config = mergeConfig(this.defaults, config)
​
    const { transitional, paramsSerializer, headers } = config
​
    // config 对象格式化
    /*
  code...
  */
​
    // 设置发送请求的方式,默认是get
    // Set config.method
    config.method = (
        config.method ||
        this.defaults.method ||
        'get'
  ).toLowerCase()
​
    let contextHeaders
​
    // Flatten headers
    contextHeaders =
        headers && utils.merge(headers.common, headers[config.method])
​
    // 根据传入的请求方式,构建config中的method
    contextHeaders &&
        utils.forEach(
      ['delete', 'get', 'head', 'post', 'put', 'patch', 'common'],
      (method) => {
            delete headers[method]
      }
  )
​
    config.headers = AxiosHeaders.concat(contextHeaders, headers)
​
    // filter out skipped interceptors
    // 收集所有的请求拦截器和响应拦截器
    const requestInterceptorChain = []
    let synchronousRequestInterceptors = true
    // 遍历请求拦截器,放到数组中
    this.interceptors.request.forEach()
    /*
  code...
  */
    // 遍历响应拦截器,放到数组中
    const responseInterceptorChain = []
    this.interceptors.response.forEach()
    /*
  code...
  */
​
    let promise
    let i = 0
    let len
​
    if (!synchronousRequestInterceptors) {
        const chain = [dispatchRequest.bind(this), undefined]
        // 将请求拦截器放到chain前面
        chain.unshift.apply(chain, requestInterceptorChain)
        // 将响应拦截器放到chain后面
        chain.push.apply(chain, responseInterceptorChain)
        len = chain.length
        // 生成promise实例
        promise = Promise.resolve(config)
​
        while (i < len) {
            // 将 fulfilled, rejected 取出
            // 链式调用
            promise = promise.then(chain[i++], chain[i++])
      }
​
        return promise
  }
​
    len = requestInterceptorChain.length
​
    let newConfig = config
​
    i = 0
​
    while (i < len) {
        const onFulfilled = requestInterceptorChain[i++]
        const onRejected = requestInterceptorChain[i++]
        try {
            newConfig = onFulfilled(newConfig)
      } catch (error) {
            onRejected.call(this, error)
            break
      }
  }
​
    try {
        promise = dispatchRequest.call(this, newConfig)
  } catch (error) {
        return Promise.reject(error)
  }
​
    i = 0
    len = responseInterceptorChain.length
​
    while (i < len) {
        promise = promise.then(
            responseInterceptorChain[i++],
            responseInterceptorChain[i++]
      )
  }
​
    return promise
} 
小结

根据上图所示,请求拦截器不断在前面unshift进去队列,响应拦截器不断在后面push进去队列,通过promise.then(chain[i++], chain[i++])的方式,从而实现Promise链式调用


dispatchRequest

这个函数处于chain队列的中间,我们来看下他做了什么事情

export default function dispatchRequest(config) {
    // 如果取消请求,抛出异常
    throwIfCancellationRequested(config)
​
    config.headers = AxiosHeaders.from(config.headers)
​
    // Transform request data
    // 请求的data 转换
    config.data = transformData.call(config, config.transformRequest)
​
    // 添加头部
    if (['post', 'put', 'patch'].indexOf(config.method) !== -1) {
        config.headers.setContentType('application/x-www-form-urlencoded', false)
  }
    // 配置适配器
    const adapter = adapters.getAdapter(config.adapter || defaults.adapter)
​
    return adapter(config).then(
        function onAdapterResolution(response) {
            // 取消相关
            throwIfCancellationRequested(config)
​
            // Transform response data
            // 响应数据转换
            response.data = transformData.call(
                config,
                config.transformResponse,
                response
          )
            // 处理响应的header
            response.headers = AxiosHeaders.from(response.headers)
​
            return response
      },
        function onAdapterRejection(reason) {
            if (!isCancel(reason)) {
                throwIfCancellationRequested(config)
​
                // Transform response data
                if (reason && reason.response) {
                    reason.response.data = transformData.call(
                        config,
                        config.transformResponse,
                        reason.response
                  )
                    reason.response.headers = AxiosHeaders.from(reason.response.headers)
              }
          }
​
            return Promise.reject(reason)
      }
  )
} 
小结

这个函数主要做了几件事情

  • 处理取消请求,抛出异常
  • 处理config.header
  • 根据请求的方法处理请求头
  • 对请求和响应的头部和响应数据进行格式化
  • 返回适配器adapter.then处理后的Promise实例

throwIfCancellationRequested

function throwIfCancellationRequested(config) {
    // 文档中已不推荐使用
    if (config.cancelToken) {
        config.cancelToken.throwIfRequested()
  }// signal.aborted 来取消操作
    if (config.signal && config.signal.aborted) {
        // 抛出错误,外面的catch进行捕捉
        // return Promise.reject(reason)
        throw new CanceledError(null, config)
  }
} 

getAdapter

接下来,就是到适配器的实现。

适配器是什么呢,适配器相当于一个转换头,出境旅游的时候,插座可能是英标,欧标等,与我们国标的插头是不一致的,国内的电器设备无法使用,这个时候需要一个**转换插头**,这个就是适配器。 
// adapters.js
const knownAdapters = {
    http: httpAdapter,
    xhr: xhrAdapter
}
export default {
    getAdapter: (adapters) => {
        adapters = utils.isArray(adapters) ? adapters : [adapters];
​
        const {length} = adapters;
        let nameOrAdapter;
        let adapter;
        // 判断adapter是否定义或者是否是http/xhr请求
        for (let i = 0; i < length; i++) {
            nameOrAdapter = adapters[i];
            if((adapter = utils.isString(nameOrAdapter) ? knownAdapters[nameOrAdapter.toLowerCase()] : nameOrAdapter)) {
                break;
          }
      }
        //如果adapter校验不通过,抛出错误信息
        if (!adapter) {
            // 省略代码...
      }
​
        if (!utils.isFunction(adapter)) {
            // 省略代码...
      }
​
        return adapter;
  },
    adapters: knownAdapters
}
​ 

总结

我们分析了axios的核心流程,可以知道以下几点:

  • 拦截器是怎么实现链式调用并分别加载到合适的位置中
  • 自定义的适配器怎么通过配置加入到axios
  • axios怎么实现取消功能
  • request中是怎么去收集和处理拦截器的

通过我们的深入了解,我们可以回答这些面试问题

  • juejin.cn/post/684490…

0.为什么 axios 既可以当函数调用,也可以当对象使用?* axios本质上是函数,拓展了一些别名的方法,比如get(),post()等方法,本质上是调用了Axios.prototype.request函数,通过apply的形式将Axios.prototype.request赋值给axios

2.简述 axios 调用流程。* 实际上是调用Axios.prototype.request函数,内部通过Promise.then()实现链式调用,实际的请求在dispatchRequest中派发

3.有用过拦截器吗?原理是怎样的?* 拦截器通过axios.interceptors.request.use来添加请求拦截器和响应拦截器函数,先用两个数组分别收集请求拦截器和响应拦截器,然后在内部循环分别添加到两端。* 如果需要移除拦截器,可以使用eject方法移除

4.有使用axios的取消功能吗?是怎么实现的?* axios的取消功能通过config配置cancelToken(弃用)或者signal来控制,如果传入了cancelToken(弃用)或者signal,则抛出异常,使流程走到Promise.rejected

5.为什么支持浏览器中发送请求也支持node发送请求?* axios内部默认支持httpxhr请求的适配器,可以根据当前的环境去适配不同的请求,也可以自定义适配器来满足更多的场景需求。

最后

整理了一套《前端大厂面试宝典》,包含了HTML、CSS、JavaScript、HTTP、TCP协议、浏览器、VUE、React、数据结构和算法,一共201道面试题,并对每个问题作出了回答和解析。

有需要的小伙伴,可以点击文末卡片领取这份文档,无偿分享

部分文档展示:



文章篇幅有限,后面的内容就不一一展示了

有需要的小伙伴,可以点下方卡片免费领取

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/111640.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【云服务器 ECS 实战】一文掌握弹性伸缩服务原理及配置方法

1. 弹性伸缩概述2. 实现模式3. 基于 GRE 实现 VPC 的互联4. 弹性伸缩服务的配置使用4.1 创建伸缩组4.2 伸缩配置4.3 创建伸缩规则1. 弹性伸缩概述 弹性伸缩&#xff08;Auto Scaling&#xff09;就是自动为我们调整弹性计算资源大小&#xff0c;以满足业务需求的变化&#xff…

javaee之spring1

什么是Spring 一、Spring的优势 二、Spring的体系结构 先说一下从什么位置去下载Spring的源码 进入Spring官网&#xff0c;找到Spring Framework框架 点进去之后&#xff0c;找到如下位置&#xff0c;继续点击 进去之后&#xff0c;继续下拉&#xff0c;找到下面这个位置点进…

慕了,我要是早点看到这篇写 Kafka 的分区管理的文章就好了

Kafka可以将主题划分为多个分区&#xff08;Partition&#xff09;&#xff0c;会根据分区规则选择把消息存储到哪个分区中&#xff0c;只要如果分区规则设置的合理&#xff0c;那么所有的消息将会被均匀的分布到不同的分区中&#xff0c;这样就实现了负载均衡和水平扩展。另外…

可以做抽奖活动的微信小程序在哪里做_分享抽奖活动小程序制作步骤

越来越多的企业开始了解微信抽奖游戏的实用性和价值&#xff0c;因为用户更喜欢简单有趣的游戏抽奖方式&#xff0c;如大转盘、摇一摇、抢福袋、砸金蛋、摇一摇、刮刮卡等互动抽奖游戏。 如果企业想制作这种抽奖游戏&#xff0c;都倾向使用市场上的各种抽奖制作软件&#xff0c…

(Java)车厢重组

车厢重组一、题目描述二、输入格式三、输出格式四、样例&#xff08;1&#xff09;样例输入&#xff08;2&#xff09;样例输出五、正确代码六、思路一、题目描述 在一个旧式的火车站旁边有一座桥&#xff0c;其桥面可以绕河中心的桥墩水平旋转。一个车站的职工发现桥的长度最…

网络技术——网络运维工程师必会的网络知识(2)(详细讲解)

作者简介&#xff1a;一名在校云计算网络运维学生、每天分享网络运维的学习经验、和学习笔记。 座右铭&#xff1a;低头赶路&#xff0c;敬事如仪 个人主页&#xff1a;网络豆的主页​​​​​​ 目录 前言 网络传输介质 信号分类和失真 双绞线分类&#xff1a; 双绞线…

非计算机专业,可以学好编程吗?

现在IT行业越来越火热&#xff0c;想要学习编程的人也越来越多。IT行业的薪资连续好几年赶超金融行业&#xff0c;位居行业之首&#xff0c;有太多人转行跨界&#xff0c;想要进入这个领域&#xff0c;那么作为初学者的你&#xff0c;是不是也很困惑&#xff0c;非科班&#xf…

Web入门开发【四】- 基础语言

欢迎来到霍大侠的小院&#xff0c;我们来学习Web入门开发的系列课程。 首先我们来了解下这个课程能学到什么&#xff1f; 1、你将可以掌握Web网站的开发全过程。 2、了解基础的HTML&#xff0c;CSS&#xff0c;JavaScript语言。 3、开发自己的第一个网站。 4、认识很多对编…

Java笔记之多线程(一)

文章目录前言一、什么是进程与线程&#xff1f;1.进程2.线程3.其他相关概念二、如何创建线程1.继承Thread类&#xff0c;重新run方法2.实现Runnable接口3.通过Callable和Future创建线程4. 继承Thread vs实现Runnable的区别三、用户线程和守护线程守护线程的使用设置成守护线程四…

【Python百日进阶-数据分析】Day137 - plotly旭日图:go.sunburst()实例

文章目录4.2 带有 go.Sunburst 的基本旭日图4.2.1 基本go.sunburst()旭日图4.2.2 带有重复标签的旭日图4.2.3 分支值4.2.4 大量切片4.2.5 控制旭日形扇区内的文本方向4.2.6 使用 uniformtext 控制文本字体大小4.2.7 具有连续色标的旭日图4.2.8 Dash中的go.sunburst()4.2 带有 g…

Android hilt 依赖注入使用详解

文章目录官方文档添加依赖初始化hiltMainActivity 使用共享类在 MainActivity 添加依赖注入ActivityScoped 作用域Singleton 作用域构造参数&#xff0c;添加 Context参数ApplicationContext、ActivityContext官方文档 https://developer.android.com/training/dependency-inj…

【Linux】缓冲区/磁盘inode/动静态库制作

目录 一、缓冲区 1、缓冲区的概念 2、缓冲区的意义 3、缓冲区刷新策略 4、同一份代码&#xff0c;打印结果不同 5、仿写FILE 5.1myFILE.h 5.2myFILE.c 5.3main.c 6、内核缓冲区 二、了解磁盘 1、磁盘的物理结构 2、磁盘的存储结构 2.1磁盘的定位 3、磁盘的抽象…

基于价值迭代求解迷宫寻路问题

摘 要 迷宫寻路是人工智能和计算机科学中一个经典的问题。它涉及在迷宫中找到一条从起点到终点的最短路径。这个问题可以用来模拟真实世界中的许多情况&#xff0c;例如机器人在工厂中自动导航&#xff0c;搜索引擎在网络中寻找信息&#xff0c;或者人类在城市中导航。 迷宫寻路…

【Javascript基础】--零基础--超详细且简洁的Javascript笔记--简介(01)

参考资料&#xff1a; 【现代Javascript教程】https://zh.javascript.info/ 【MDN】https://developer.mozilla.org/zh-CN/ 笔记仅作为学习交流载体&#xff0c;无任何商业或盈利目的 JavaScript 简介 了解 JavaScript 有什么特别之处&#xff0c;我们可以用它实现什么&#…

适合编程初学者的开源博客系统(Vue3+Element Plus版)

目标 为编程初学者打造入门学习项目&#xff0c;使用各种主流编程语言来实现。让想学编程的&#xff0c;一个都不落下。 上述基本涵盖了当前编程开发所有主流语言。 左侧为前端版本&#xff1a;安卓、iOS、鸿蒙、Flutter、Vue、uni-app、微信小程序。 右侧为服务器端版本&am…

YOLOV7学习记录之模型推理

前面我们学习了YOLOV7的训练过程&#xff0c;今天我们学习其推理过程&#xff0c;即模型预测&#xff1a;其包含损失函数计算&#xff0c;输出值解码&#xff0c;非极大值抑制&#xff0c;mAP计算等过程。 同时还介绍原始图像上绘制目标框等功能。 我们从predict.py文件开始&am…

【源码共读】Vite 项目自动添加 eslint 和 prettier

vite-pretty-lint库是一个为Vite创建的Vue或React项目初始化eslint和prettier的库。 该库的目的是为了让开发者在创建项目时&#xff0c;不需要手动配置eslint和prettier&#xff0c;而是通过vite-pretty-lint库来自动配置。 源码地址&#xff1a; vite-pretty-lintgithub1s…

设计模式 - 单例模式(一)

单例模式一 官方定义二 单例模式八种方式2.1 饿汉式&#xff08;静态常量&#xff09;代码案例案例分析2.2 饿汉式&#xff08;静态代码块&#xff09;代码案例案例分析2.3 懒汉式(线程不安全)代码案例案例分析2.4 懒汉式(线程安全&#xff0c;同步方法)代码案例案例分析2.5 懒…

数据要求说明书(GB856T——88)基于协同的在线表格forture-sheet

数据要求说明书 1引言 1.1编写目的 本份数据要求说明书详细的提供了系统中各个数据的流向&#xff0c;是设计数据库的关键所在。为以后的编码以及测试提供一份可靠的依据。 预期的读者&#xff1a;系统开发人员、系统测试人员、系统维护人员 1.2背景 待开发的数据库名称&a…

揭秘百度智能测试在测试定位领域的实践

以前&#xff0c;我们介绍了测试活动测试输入、测试执行、测试分析、测试定位和测试评估五个步骤中测试输入、执行、分析、评估的智能化研究和实践&#xff0c;本文重点介绍测试定位环节的智能化实践。 测试定位的主要作用是在构建失败或问题发生后&#xff0c;快速给出产生该现…