概述

在前端开发过程中,我们经常会遇到需要发送异步请求的情况。而使用一个功能齐全,接口完善的HTTP请求库,能够在很大程度上减少我们的开发成本,提高我们的开发效率。

axios是一个在近些年来非常火的一个HTTP请求库,目前在GitHub中已经拥有了超过40K的star,受到了各位大佬的推荐。

今天,我们就来看下,axios到底是如何设计的,其中又有哪些值得我们学习的地方。我在写这边文章时,axios的版本为0.18.0。我们就以这个版本的代码为例,来进行具体的源码阅读和分析。当前axios所有源码文件都在 lib文件夹中,因此我们下文中提到的路径均是指 lib文件夹中的路径。

本文的主要内容有:

  • 如何使用axios

  • axios的核心模块是如何设计与实现的(请求、拦截器、撤回)

  • axios的设计有什么值得借鉴的地方

如何使用axios

想要了解axios的设计,我们首先需要来看下axios是如何使用的。我们通过一个简单示例来介绍以下axios的API。

发送请求

 axios({

   method:'get',

   url:'http://bit.ly/2mTM3nY',

   responseType:'stream'

 })

   .then(function(response) {

   response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))

 });

这是一个官方的API示例。从上面的代码中我们可以看到,axios的用法与jQuery的ajax很相似,都是通过返回一个Promise(也可以通过success的callback,不过建议使用Promise或者await)来继续后面的操作。

这个代码示例很简单,我就不过多赘述了,下面让我们来看下如何添加一个过滤器函数。

增加拦截器(Interceptors)函数

 // 增加一个请求拦截器,注意是2个函数,一个处理成功,一个处理失败,后面会说明这种情况的原因

 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);

   });

通过上面的示例我们可以知道:在请求发送前,我们可以针对请求的config参数进行数据处理;而在请求响应后,我们也能针对返回的数据进行特定的操作。同时,在请求失败和响应失败时,我们都可以进行特定的错误处理。

取消HTTP请求

在完成搜索相关的功能时,我们经常会需要频繁的发送请求来进行数据查询的情况。通常来说,我们在下一次请求发送时,就需要取消上一次请求。因此,取消请求相关的功能也是一个优点。axios取消请求的示例代码如下:

 const CancelToken = axios.CancelToken;

 const source = CancelToken.source();

 axios.get('/user/12345', {

   cancelToken: source.token

 }).catch(function(thrown) {

   if (axios.isCancel(thrown)) {

     console.log('Request canceled', thrown.message);

   } else {

     // handle error

   }

 });

 axios.post('/user/12345', {

   name: 'new name'

 }, {

   cancelToken: source.token

 })

 // cancel the request (the message parameter is optional)

 source.cancel('Operation canceled by the user.');

通过上面的示例我们可以看到,axios使用的是基于CancelToken的一个撤回提案。不过,目前该提案已经被撤回,具体详情可以见此处。具体的撤回实现方法我们会在后面的章节源码分析的时候进行说明。

axios的核心模块是如何设计与实现的

通过上面的例子,我相信大家对axios的使用方法都有了一个大致的了解。下面,我们将按照模块来对axios的设计与实现进行分析。下图是我们在这篇博客中将会涉及到的相关的axios的文件,如果读者有兴趣的话,可以通过clone相关代码结合博客进行阅读,这样能够加深对相关模块的理解。

HTTP请求模块

作为核心模块,axios发送请求相关的代码位于 core/dispatchReqeust.js文件中。由于篇幅有限,下面我选取部分重点的源码进行简单的介绍:

 module.exports = function dispatchRequest(config) {

     throwIfCancellationRequested(config);

     // 其他源码

     // default adapter是一个可以判断当前环境来选择使用Node还是XHR进行请求发送的模块

     var adapter = config.adapter || defaults.adapter; 

     return adapter(config).then(function onAdapterResolution(response) {

         throwIfCancellationRequested(config);

         // 其他源码

         return response;

     }, function onAdapterRejection(reason) {

         if (!isCancel(reason)) {

             throwIfCancellationRequested(config);

             // 其他源码

             return Promise.reject(reason);

         });

 };

通过上面的代码和示例我们可以知道, dispatchRequest方法是通过获取 config.adapter来得到发送请求的模块的,我们自己也可以通过传入符合规范的adapter函数来替换掉原生的模块(虽然一般不会这么做,不过也算是一个松耦合扩展点)。

在 default.js文件中,我们能够看到相关的adapter选择逻辑,即根据当前容器中特有的一些属性和构造函数来进行判断。

 function getDefaultAdapter() {

     var adapter;

     // 只有Node.js才有变量类型为process的类

     if (typeof process !== 'undefined' && Object.prototype.toString.call(process) === '[object process]') {

         // Node.js请求模块

         adapter = require('./adapters/http');

     } else if (typeof XMLHttpRequest !== 'undefined') {

         // 浏览器请求模块

         adapter = require('./adapters/xhr');

     }

     return adapter;

 }

axios中XHR模块较为简单,为XMLHTTPRequest对象的封装,我们在这里就不过多进行介绍了,有兴趣的同学可以自行阅读,代码位于 adapters/xhr.js文件中。

拦截器模块

了解了 dispatchRequest实现的HTTP请求发送模块,我们来看下axios是如何处理请求和响应拦截函数的。让我们看下axios中请求的统一入口 request函数。

 Axios.prototype.request = function request(config) {

     // 其他代码

     var chain = [dispatchRequest, undefined];

     var promise = Promise.resolve(config);

     this.interceptors.request.forEach(function unshiftRequestInterceptors(interceptor) {

         chain.unshift(interceptor.fulfilled, interceptor.rejected);

     });

     this.interceptors.response.forEach(function pushResponseInterceptors(interceptor) {

         chain.push(interceptor.fulfilled, interceptor.rejected);

     });

     while (chain.length) {

         promise = promise.then(chain.shift(), chain.shift());

     }

     return promise;

 };

这个函数是axios发送请求的入口,因为函数实现比较长,我就简单说一下相关的设计思路:

  1. chain是一个执行队列。这个队列的初始值,是一个带有config参数的Promise。

  2. 在chain执行队列中,插入了初始的发送请求的函数 dispatchReqeust和与之对应的undefined。后面需要增加一个 undefined是因为在Promise中,需要一个success和一个fail的回调函数,这个从代码 promise = promise.then(chain.shift(),chain.shift());就能够看出来。因此, dispatchReqeust和 undefined我们可以成为一对函数。

  3. 在chain执行队列中,发送请求的函数 dispatchReqeust是处于中间的位置。它的前面是请求拦截器,通过 unshift方法放入;它的后面是响应拦截器,通过 push放入。要注意的是,这些函数都是成对的放入,也就是一次放入两个。

通过上面的 request代码,我们大致知道了拦截器的使用方法。接下来,我们来看下如何取消一个HTTP请求。

取消请求模块

取消请求相关的模块在 Cancel/文件夹中。让我们来看下相关的重点代码。

首先,让我们来看下元数据 Cancel类。它是用来记录取消状态一个类,具体代码如下:

  function Cancel(message) {

       this.message = message;

     }

     Cancel.prototype.toString = function toString() {

       return 'Cancel' + (this.message ? ': ' + this.message : '');

     };

     Cancel.prototype.__CANCEL__ = true;

而在CancelToken类中,它通过传递一个Promise的方法来实现了HTTP请求取消,然我们看下具体的代码:

 function CancelToken(executor) {

     if (typeof executor !== 'function') {

         throw new TypeError('executor must be a function.');

     }

     var resolvePromise;

     this.promise = new Promise(function promiseExecutor(resolve) {

         resolvePromise = resolve;

     });

     var token = this;

     executor(function cancel(message) {

         if (token.reason) {

             // Cancellation has already been requested

             return;

         }

         token.reason = new Cancel(message);

         resolvePromise(token.reason);

     });

 }

 CancelToken.source = function source() {

     var cancel;

     var token = new CancelToken(function executor(c) {

         cancel = c;

     });

     return {

         token: token,

         cancel: cancel

     };

 };

而在 adapter/xhr.js文件中,有与之相对应的取消请求的代码:

 if (config.cancelToken) {

     // 等待取消

     config.cancelToken.promise.then(function onCanceled(cancel) {

         if (!request) {

             return;

         }

         request.abort();

         reject(cancel);

         // 重置请求

         request = null;

     });

 }

结合上面的取消HTTP请求的示例和这些代码,我们来简单说下相关的实现逻辑:

  1. 在可能需要取消的请求中,我们初始化时调用了source方法,这个方法返回了一个CancelToken类的实例A和一个函数cancel。

  2. 在source方法返回实例A中,初始化了一个在pending状态的promise。我们将整个实例A传递给axios后,这个promise被用于做取消请求的触发器。

  3. 当source方法返回的cancel方法被调用时,实例A中的promise状态由pending变成了fulfilled,立刻触发了then的回调函数,从而触发了axios的取消逻辑——request.abort()

axios的设计有什么值得借鉴的地方

发送请求函数的处理逻辑

在之前的章节中有提到过,axios在处理发送请求的 dispatchRequest函数时,没有当做一个特殊的函数来对待,而是采用一视同仁的方法,将其放在队列的中间位置,从而保证了队列处理的一致性,提高了代码的可阅读性。

Adapter的处理逻辑

在adapter的处理逻辑中,axios没有把http和xhr两个模块(一个用于Node.js发送请求,另一个则用于浏览器端发送请求)当成自身的模块直接在 dispatchRequest中直接饮用,而是通过配置的方法在 default.js文件中进行默认引入。这样既保证了两个模块间的低耦合性,同时又能够为今后用户需要自定义请求发送模块保留了余地。

取消HTTP请求的处理逻辑

在取消HTTP请求的逻辑中,axios巧妙的使用了一个Promise来作为触发器,将resolve函数通过callback中参数的形式传递到了外部。这样既能够保证内部逻辑的连贯性,也能够保证在需要进行取消请求时,不需要直接进行相关类的示例数据改动,最大程度上避免了侵入其他的模块。

总结

本文对axios相关的使用方式、设计思路和实现方法进行了详细的介绍。读者能够通过上述文章,了解axios的设计思想,同时能够在axios的代码中,学习到关于模块封装和交互等相关的经验。

由于篇幅原因,本文仅针对axios的核心模块进行了分解和介绍,如果对其他代码有兴趣的同学,可以去GitHub进行查看。

如果有任何疑问或者观点,欢迎随时留言讨论。

作者:hjava

原文:https://segmentfault.com/a/1190000015747143

HTTP请求库——axios源码阅读与分析的更多相关文章

  1. 如何实现一个HTTP请求库——axios源码阅读与分析 JavaScript

    概述 在前端开发过程中,我们经常会遇到需要发送异步请求的情况.而使用一个功能齐全,接口完善的HTTP请求库,能够在很大程度上减少我们的开发成本,提高我们的开发效率. axios是一个在近些年来非常火的 ...

  2. (原)NSQ源码阅读和分析(1)

    原文出处:https://www.cnblogs.com/lihaiping/p/12324371.html 本文记录自己在阅读和学习nsq源码的时候的一些学习笔记,主要目的是个人总结和方便后期查阅. ...

  3. Axios源码阅读笔记#1 默认配置项

    Promise based HTTP client for the browser and node.js 这是 Axios 的定义,Axios 是基于 Promise,用于HTTP客户端--浏览器和 ...

  4. Iris框架源码阅读和分析

    iris包结构简介 iris包含了很多包,下面这些是分析过程中接触到的东西. 能力有限,多多包涵,欢迎联系QQ:2922530320 一起交流 context包包含: Context (接口) con ...

  5. Axios源码分析

    Axios是一个基于promise的HTTP库,可以用在浏览器和node.js中. 文档地址:https://github.com/axios/axios axios理解和使用 1.请求配置 { // ...

  6. fw: 专访许鹏:谈C程序员修养及大型项目源码阅读与学习

      C家最近也有一篇关于如何阅读大型c项目源代码的文章,学习..融合.. -------------------- ref:http://www.csdn.net/article/2014-06-05 ...

  7. 一比一还原axios源码(一)—— 发起第一个请求

    上一篇文章,我们简单介绍了XMLHttpRequest及其他可以发起AJAX请求的API,那部分大家有兴趣可以自己去扩展学习.另外,简单介绍了怎么去读以及我会怎么写这个系列的文章,那么下面就开始真正的 ...

  8. Yii2.0源码阅读-一次请求的完整过程

    Yii2.0框架源码阅读,从请求发起,到结束的运行步骤 其实最初阅读是从yii\web\UrlManager这个类开始看起,不断的寻找这个类中方法的调用者,最终回到了yii\web\Applicati ...

  9. Redis源码阅读(四)集群-请求分配

    Redis源码阅读(四)集群-请求分配 集群搭建好之后,用户发送的命令请求可以被分配到不同的节点去处理.那Redis对命令请求分配的依据是什么?如果节点数量有变动,命令又是如何重新分配的,重分配的过程 ...

随机推荐

  1. Vue的模板语法

    基本语法 <body> <script src="vue.js"></script> <div id="app"> ...

  2. ANALYZE - 收集与数据库有关的统计

    SYNOPSIS ANALYZE [ VERBOSE ] [ table [ (column [, ...] ) ] ] DESCRIPTION 描述 ANALYZE 收集有关 PostgreSQL ...

  3. ALTER GROUP - 修改一个用户组

    SYNOPSIS ALTER GROUP groupname ADD USER username [, ... ] ALTER GROUP groupname DROP USER username [ ...

  4. 01CSS使用方法

    CSS使用方法 内联定义 内联定义即是在对象的标记内使用对象的style属性定义适用其的样式表属性. 内部样式表 <style type="text/css"></style> ...

  5. jQuery-鼠标经过显示大图并跟随鼠标效果方法封装

    //copyright c by zhangxinxu 2019-1-15 /*由于大图绑定在href属性中,故一般而言,需使用a标签的href指向大图.仅支持png,gif,jpg,bmp四种格式的 ...

  6. <Redis> 入门五 持久化RBD/AOF

    RDB RDB持久化是指在指定的时间间隔内将内存中的数据集快照写入磁盘(默认是 dump.rdb). 默认持久化机制,就是将内存中的数据以快照的方式写入二进制文件dump.rbd中. 触发快照的条件 ...

  7. 使用 PHP + shell 生成 一键设置权限的脚本。

    linux 系统 支持PHP脚本一键设置环境.shell脚本一键设置环境.那么 我今天 使用 PHP  + shell 生成 一键设置权限的脚本. 举例子:linux服务器 一键配置discuz网站环 ...

  8. 【04】< meta > 元素

    < meta > 元素 概要 标签提供关于HTML文档的元数据.元数据不会显示在页面上,但是对于机器是可读的.它可用于浏览器(如何显示内容或重新加载页面),搜索引擎(关键词),或其他 we ...

  9. BNUOJ 35759 The Great Pan

    The Great Pan Time Limit: 1000ms Memory Limit: 65536KB This problem will be judged on HDU. Original ...

  10. Linux备份-删除指定日期内文件

    #!/usr/bin/env bash source /etc/profile echo " *************** start filter ***************  &q ...