Axios 拦截器源码解读

axios 拦截器源码解读
下文拉取分析 axios 库的时间点为2021-11-29

准备

  • 克隆 axios 库

    git clone git@github.com:axios/axios.git

    下文提到的文件地址全部为依据 axios 库根地址的相对路径

过程

目标寻找

在寻找拦截器时可以简单看一下 axios 的大概执行流程，和日常使用情况印证一下

进入 package.json，通过main的指向，得知入口文件为/index.js

  • package.json
    image-20211129205837793

进入/index.js，仅一行导入且同时导出的代码

  • /index.js
    image-20211129210052363

进入被导入的文件/lib/axios.js，反向查找

  1. 行54：获得当前文件的导出目标，变量axios
    image-20211129212753569

  2. 行34：找到变量axios的声明位置，为一个被传入实参defaults的函数createInstance的执行返回接收

    行33：// 导出创建默认实例以备导出

    • 函数：createInstance
      image-20211129213348040

    • 实参：defaults

      这里简单看一下defaults

      • 找到defaults的定义位置，行7，知晓实际为一个导入
        image-20211129214345038
      • 打开此导入/lib/defaults.js，依旧反向查找源头，行134（得知导出变量defaults)
        image-20211202152244707
      • 行44：来到变量的定义位置，得知实际存储了一个对象，也就是说向createInstance传入了一个对象
        属性大概有adapter，timeout，validateStatus，headers等等
        image-20211129215326512

  3. 行15：转到函数createInstance的定义位置

    行9-行14：

    // 创建一个 Axios 实例（告诉了我们 Axios 是一个自定义构造函数）

    // 接收一个对象参数，对象中包含的是实例对象的默认配置（参见上面的default.js）

    // 返回 Axios 实例对象

    • 函数createInstance
      image-20211129230941367

    • 向方法里面看 ，依旧反向摸索，行30：返回值，变量instance

    • 行17：变量的定义位置，接收的是一个名字为bind的函数返回值

    • 行4：来到bind函数定义的地方，原来是一个模块的导入，看一下
      image-20211129231515802

      • 打开模块文件/lib/helpers/bind.js，了解一下工具函数bind
        结合前面的调用来看，大概意思就是，函数接收两个参数（函数a 和 对象b），返回一个新函数
        新函数的返回值为函数a的调用，不过this 指向被改变为了对象b，
        且函数a接收了新函数（这里在上文就是接收bind返回值的instance）的所有参数（apply 方法）
        image-20211129231608328

  4. 返回继续查看

    • 行17：返回来看bind其中的这两个实参
      • 参数1：Axios.prototype.request，Axios 原型方法，根据工具函数bind定义可以知道调用instance（也就是实际使用中的 axios 调用）实际上就是调用这里的参数1
      • 参数2：context →→ 行16（new Axios(defaultConfig)），一个 Axios实例
      • 综上，下面要追踪看 Axios 构造函数以及其原型方法 request
    • 行5：来到Axios定义的地方
      • 也是一个模块的导入
        image-20211130000540192

进入模块文件/lib/core/Axios.js

  1. 打开模块文件，/lib/core/Axios.js，简单收起来看一下最外层的逻辑，然后依旧是反向摸索，
    image-20211130000855752
  2. 行148（模块的导出语句，导出变量Axios） →→ 行16（变量Axios的定义位置，可以看到其本身是一个函数，准确的讲是一个自定义构造函数）
  3. 行18：看向该构造函数内部，可以看到定义了一个实例成员，属性名为interceptors，属性值为一个对象（包含了属性request和response，即分别对应的请求和响应拦截，属性值为一个自定义构造函数InterceptorManager的实例）
  4. 行5：继续追踪InterceptorManager，又看到了模块
    image-20211130005113818

进入模块文件/lib/core/inInterceptorManager.js

  1. 打开该模块文件/lib/core/InterceptorManager.js，拦截器的定义一览无余
    image-20211130005440289
  2. 粗略的能看到该模块导出了一个自定义构造函数，给构造函数定义了几个实例属性，以及几个原型方法，熟悉的use方法就在其中

额外：简单了解一下 axios 的执行流程

焦点回到 文件/lib/core/Axios.js
  1. 焦点回到 文件/lib/core/Axios.js，追踪 Axios 原型方法 request，行29
    image-20211203000000985
  2. 行117：该方法返回一个变量
    （其实一般使用中，promise 被 return 的位置是在行80 中的条件判断中，此处只是条件判断的另一个分支，由于牵扯到拦截器所以在后面解读拦截器时对此进行分析）
    image-20211203000117282
  3. 行78（该变量声明的位置） →→→ 行108（向该变量赋值，值为函数dispatchRequest的执行返回值）
    image-20211203000524766
  4. 行6：来到当前页面dispatchRequest定义的位置，一个模块导入
进入模块文件/lib/core/dispatchRequest.js
  1. 行28（模块导出的声明位置，一个函数） →→→ 行58（该函数执行的返回值） →→→ 行56（返回值定义的位置，按预设配置defaults.adapter继续反向追踪查找）
    image-20211203001134668
  2. 行6：defaults模块导入
    image-20211203001451143
进入模块文件axios/lib/defalts.js
  1. 行134（模块导出的声明位置，变量defaults） →→→ 行44（变量defaults的声明位置）
    image-20211203001825042
  2. 行52：目标，属性adapter，函数getDefaultAdapter的执行返回值
  3. 行17：函数getDefaultAdapter的定义位置，大概意思能看出来是一个为不同运行环境分配不同adapter的判断
    image-20211203002030654
  4. 行21：这里按浏览器环境来选择关注require('./adapters/xhr')
进入模块文件axios/lib/adapters/xhr.js
  1. 里面单纯就一个函数的导出，行14（导出函数xhrAdapter的定义位置）
    image-20211203002614894
  2. 行15：函数xhrAdapter的返回值，一个 Promise 实例
  3. 追踪参数resolve 和 reject的位置，即 Promise 的两个状态 →→→ 行66：函数settle的执行
    image-20211204075103229
  4. 行4：来的函数settle 的定义位置，一个模块的导入
    image-20211205153422581
进入模块文件lib/core/settle.js
  1. 代码不多，单纯的一个函数定义及其导出
    image-20211205153630725
  2. 行6，函数用处注释：基于响应成功与否决定 Promise 的状态结果
  3. 行8-行10，函数参数注释：
    参数1，一个兑现 Promise 的函数（即 Promise 的成功返回）
    参数2，一个拒绝 Promise 的函数（失败返回）
    参数3，响应
  4. 函数解读：
    根据请求的响应状态相关的判断，决定 Promise 是 resolve 返回还是 reject返回，同时在返回时将携带参数3
  5. 返回模块文件lib/adapters/xhr.js，考察使用该函数时，传入的参数3
返回模块文件lib/adapters/xhr.js
  1. 行66：函数settle 的执行位置，定位实参 response
  2. 行57：response定义位置
    根据上下文，明显可以得知，该变量存储了axios 对 xhr 响应数据的包装结果，也即 axios 的成功返回
    在这里能直观的看到 使用 axios 返回的结果对象的几个属性
    image-20211205160352065
  3. 焦点回到函数settle定义的地方（模块文件lib/core/settle.js），通过参数2，还能够了解到针对reject，其实是对response又再次进行了包装，然后继续反向查找，能够在模块文件lib/core/createError.js中了解到这次的包装情况
进入模块文件lib/core/createError.js
  1. 函数createError.js
    image-20211205161443448
  2. 函数作用，创建一个错误实例对象，然后将包括这个错误实例，随同其它几个接收到的参数，传给函数enhanceError 进行再处理
  3. 行3，来到enhanceError的定义位置，依路径地址进入模块文件
进入模块文件lib/core/enhanceError.js
  1. 函数enhanceError
    image-20211205162657908
  2. 能够看到，最后此函数会将传入的其它参数添加给参数1，也就是上面使用时传入的错误实例对象，最后返回添加完属性的参数1，这里就是 axios 的失败返回
axios 内部执行流程示例图
  1. 执行流程
    axios执行流程图

目标解读

拦截器的定义

  1. 回到拦截器的解读，进入之前找到的目标文件/lib/core/inInterceptorManager.js
    可以看到首先自定义了一个构造函数，实例属性handlers（数组），以及在此构造函数原型上添加了3个方法
    image-20211130005440289
  2. 行17：use方法，添加一个拦截器，平时的像axios.interceptors.request.use()这样的使用，其中的use方法就是来自这里。可以接收3个参数（第3个可选，为一个对象，可配置属性 synchronous和runWhen，缺省时各为false和null，即假值，有个印象，拦截器执行时会用到），读取参数，分配对应的属性名后，包装为一个对象尾部添加到实例属性handlers数组中，返回此包含了拦截器信息的对象在数组中的索引（用于移除拦截器）
  3. 行32：eject方法，移除一个拦截器，接收拦截器在handlers数组中的索引作为参数，将此拦截器赋值null，之所以没有直接删除，目前推断是避免移除后会导致定义拦截器时返回的索引和实际索引不一致的问题
  4. 行46：forEach方法，先看函数的内部代码，接收一个函数作为参数，函数体中调用了一个工具函数forEach（传入了两个参数，1存放拦截器信息的数组，2函数（暂时给个别名为 fn，下面提到的时候可以直接联想到这里）。
    image-20211208232250028
  5. 轻车熟路的来到此工具函数forEach的定义位置，结合上面使用时传入的参数1为数组，解读目标可以直接放到行243-行246。
    意思即为遍历参数1（数组），然后将依次将元素、索引、数组本身作为参数传递给参数2（函数）
    image-20211208232357379
  6. 焦点回到拦截器定义文件中，继续解读forEach方法，即传入拦截器信息数组，进行遍历，如果元素不为null（对应移除拦截器的赋值为null的处理，即拦截器未被移除），将此元素作为参数传给fn（上面4中的参数2）并立即执行。
  7. 拦截器的定义知道了，下面看一下拦截器在 axios 的执行中是怎样参演的吧

拦截器的执行

拦截器执行代码定位

来到模块文件/lib/core/Axios.js，即创建拦截器实例的地方，前面得知了平时类似axios(参数)这样的使用其实就是Axios.prototype.request(参数)，下面直接看向这个方法内部，粗略查看后 可以定位到行60-行117，拦截器的执行就在其中
image-20211209122332085

拦截器执行代码解构

然后再稍微细看一下行60-行117，从行78声明变量promise开始，紧跟了一个if 判断，其中包含了return promise（行91），再就是if 判断下面一直到最后行117，这里是另外一个条件下的return promise。

由此可以大体分为分为三部分：行60-行76（拦截器执行的前期准备部分），行80-行92（一种情况下的返回），行95-行117（另一种情况下的返回，与第二部分互斥）。

拦截器执行代码第一部分

第一部分：行60-行76

  1. 得益于变量名的语义化，可以轻松且提前得知变量或函数在代码 中的作用
    image-20211209090514665

  2. 行61：声明一个数组requestInterceptorChain，用于链式存放请求拦截器

  3. 行62：声明一个状态位变量synchronousRequestInterceptors，标记请求拦截器是否为同步执行

  4. 行63-行71：执行拦截器原型上面的方法forEach，传入一个函数作为参数。根据前面对原型方法forEach以及内部所用工具函数forEach的分析，这个作为参数的函数unshiftRequestInterceptors的参数为各个存放拦截器信息的对象

    1. 行64-66：读取拦截器信息对象的runWhen属性，如果此属性为一个函数且该函数在接收请求配置作为参数后的返回值为false，则直接return，即跳过当前遍历的请求拦截器
      以上条件不满足则继续向下执行

      // 一个简单的 runWhen
// 下面的声明表示如果请求方式为 POST 则跳过此条请求过滤器的处理
function jumpPost(config) {
  if (config.method.toUpperCase() === 'POST') {
    return false
  }
  return
}

// 使用
// ...
axios.interceptors.request.use((config) => {
  //...
  return config
}, (error) => {
  // ...
  return Promise.reject(error)
}, {
  runWhen: jumpPost // 上面定义的函数 jumpPost
})

    2. 行68：进行逻辑与判断，条件全部为真则synchronousRequestInterceptors再次（声明变量时有同时赋值true）赋值为true，
      如果拦截器信息对象中配置了属性synchronous且值为假值，则此时synchronousRequestInterceptors被赋值为false

      // 使用
// ...
axios.interceptors.request.use((config) => {
  //...
  return config
}, (error) => {
  // ...
  return Promise.reject(error)
}, {
  synchronous: false // 或者 true，缺省时也为 false
})

    3. 行70：向请求过滤器链组requestInterceptorChain头部放入定义过滤器时的两个回调函数

  5. 行73：声明一个数组responseInterceptorChain，用于链式存放响应拦截器

  6. 行74-行76：依旧调用了拦截器原型上面的方法forEach，处理和上面的请求拦截器相比，没有那么多前置语句，直接向响应过滤器链组responseInterceptorChain尾部放入定义过滤器时的两个回调函数

  7. 归纳：该部分将请求拦截器依照反序（相对于定义顺序来讲，下同）、响应拦截器依照正序，各自存放在一个数组中，另外请求拦截器方面如果配置了synchronous为true最后使得状态位变量synchronousRequestInterceptors为真则请求拦截器整体同步执行（至于怎样同步或异步看下面的二三部分）

拦截器执行代码第二部分

第二部分：行80-行92

  1. 代码如下
    image-20211209194335895

  2. 行80：判断条件，状态位变量synchronousRequestInterceptors是否为真，以决定是否执行此部分

  3. 行81：声明并赋值一个数组chain，按顺序存放了两个元素，前面梳理axios的执行流程可知dispatchRequest为axios发起请求的环节

  4. 行83：向数组chain头部添加请求拦截器链组，注意此时可不是将请求拦截器链组整个数组作为元素添加，这里通过了apply绑定，requestInterceptorChain这个数组会被分解传入 unshift 方法

  5. 行84：将数组chain与响应拦截器链组进行合并

  6. 行86：创建一个携带请求配置成功返回的Promise 对象

  7. 行87-行89：开启 while 循环，条件为数组chain中有元素时

    1. 行88：循环内部仅有的一行代码，从数组chain头部两两取出元素（看到这里的两两取出，且联想一下内部拦截器是两两为一组存放的，那行81中的初始数组赋值就不难理解了，undefined其实就是为了配合作为占位用的），并执行
      且由于请求拦截器存入时是按照定义顺序头部依次放入，此时为头部按序取出，所以可得知请求拦截器是反向与定义顺序执行处理的
      注意，由于 JS 的执行机制，Promise 会被当做微任务进行处理，即此行的.then()会被放入异步事件列表随后进入事件队列，并非立即执行，执行的时机为主线程执行完毕，也就是说请求拦截器的处理会被主线程堵塞，当然了，数组chain中的剩余元素在取出执行时依然如此
      可如下简单测试

      let promise = Promise.resolve('这是待处理的配置')
let i = 3
console.log('start')
while(i) {
  console.log(i)
  i--
  promise = promise.then((a) => {
    console.log(a)
    return a
  }, e => Promise.reject(e))
}
console.log('finish')

// 最后的执行结果如下，你想到了吗
// start
// 3
// 2
// 1
// finish
// 这是待处理的配置
// 这是待处理的配置
// 这是待处理的配置

  8. 行91：返回结果（一个 Promise 对象)

  9. 归纳：该部分的重点就是在行88，由于为 Promise 对象回调的缘故，因此处理会被放入异步中，等待主线程空闲时再继续执行

拦截器执行代码第三部分

第三部分：行95-行117

  1. 代码如下：
    （运行此部分代码的条件为每一个请求拦截器定义时传入了第三个参数，一个含有属性synchronous值为true的对象）
    image-20211209215412336

  2. 行95：声明新的变量接收请求配置

  3. 行96：while循环，开启条件为请求拦截器链组不为空时，

  4. 行97-行98：头部依次取出定义请求拦截器时定义的两个回调函数
    这里简单写一下日常使用请求拦截器的代码

    axios.interceptors.request.use( (config) => {
  // 在发送请求之前做些什么
  return config
}, (error) => {
  // 对请求错误做些什么
  return Promise.reject(error)
})

  5. 行99-行104：正常执行请求拦截器的第一个回调函数，如一旦遇到错误则执行第二个回调函数，并跳出while的循环，取消后续请求拦截器的处理
    此时遇到的错误并不会影响请求的正常发送，请求会拿着之前请求拦截器处理无误的配置（如果首个请求拦截器的处理就出错了那就是没处理过的配置）继续发送请求，
    注意，此处对于请求拦截器的遍历执行，并非为第二部分中的 Promise 对象then回调，而只是一个普通的函数，因此对于请求拦截器的处理会在主线程中直接执行，这也是第二三部分最最主要的区别，也是参数对象synchronous属性的真实用意

  6. 行107-行111：携带经请求拦截器处理过的配置发送请求拿到响应数据（上面对Axios 流程梳理时可得知执行函数dispatchRequest的结果为一个Promise 对象，因此此处的变量promise中存放了一个 Promise 对象，且该Promise对象是具有then回调（上面分析axios执行流程中有贴代码截图|备用跳转1|备用跳转2），因此此处开始会和第二部分最后的情况一样被推入异步微任务，等待主线程任务执行完毕后才会执行），成功则跳过 catch 语句继续向下执行，有错误则进入 catch 直接返回一个失败的Promise 对象

  7. 行113-行15：在经上面发送请求成功然后得到响应数据后，如果响应拦截器链组不为空（即定义了响应拦截器），开启while 循环，从链组中头部取出响应拦截器执行，处理响应数据

  8. 行117：返回结果（一个 Promise 对象)

  9. 归纳：这个部分与第二部分最明显的差别就是，请求拦截器的处理并不会当作异步任务，会在主线程中直接进行处理

拦截器源码解读总结

通过分析拦截器相关的源码，可得知请求拦截器的执行是反向与定义顺序的，以及除去平时使用时传入的两个回调函数外，还有第三个参数可选。此参数可以达到控制请求拦截器是否跟随主线程一同执行以及控制是否可以跳过某个请求拦截器的目的，前者的话如果日常使用场景会选择使用 async/await 这样的修饰符来使请求变为同步执行，那么可以不用深究了；至于后者，算是一个功能加强，平时如果碰到需求可以知道有这样的一个参数位就可以。

posted @ 2021-12-10 01:03  今日多云转晴  阅读(128)  评论(0)  编辑  收藏  举报