专栏首页全栈者一步一步解析Axios源码,从入门到原理

一步一步解析Axios源码,从入门到原理

一. Axios是什么?


一个基于 Promise 来管理 http 请求的简洁、易用且高效的代码封装库。通俗一点来讲,它是一个前端替代Ajax的一个东西,可以使用它发起http请求接口功能,它是基于Promise的,相比于Ajax的回调函数能够更好的管理异步操作。

二. Axios的特点


三. 安装Axios


1、 通过使用npm命令安装它。

npm i axios --save

2、 安装成功后,进入的axios文件目录下,查看目录结构。

四. Axios源码分析


1、教大家怎么看NPM包的源码,第一步先看package.json,主要关注package.json中的main字段,它的值(一个相对路径)代表这个包的入口文件。这里可以看出axios的包的入口文件是index.js文件,再看一下包的scripts执行脚本,然后可以在本地执行脚本进行调试。

2、[Axios/axios.js]进入入口文件,可以看出axios的内部逻辑均在lib文件夹下。

3、[Axios/lib/axios.js]进入axios文件里,先查看export了什么内容,然后再根据导出的内容往前看。

module.exports = axios; 

4、[Axios/lib/axios.js]最终导出了axios,来看看axios是什么?

function createInstance(defaultConfig) {
  var context = new Axios(defaultConfig);
  ...
  return instance;
}

var axios = createInstance(defaults);

axios是createInstance函数传入了defaultConfig参数返回的值。

5、[Axios/lib/defaults.js]先看看这个参数defaults是什么。

// 通过nodejs中的process和浏览器的XMLHttpRequest来区别当前在前端还是nodejs中
function getDefaultAdapter() {
  var adapter;
  if (typeof process !== 'undefined' && Object.prototype.toString.call(process) === '[object process]') {
    adapter = require('./adapters/http');
  } else if (typeof XMLHttpRequest !== 'undefined') {
    adapter = require('./adapters/xhr');
  }
  return adapter;
}

var defaults = {
  adapter: getDefaultAdapter(),
  ... 
  timeout: 0,

  xsrfCookieName: 'XSRF-TOKEN',
  xsrfHeaderName: 'X-XSRF-TOKEN',

  maxContentLength: -1,
 
  validateStatus: function validateStatus(status) {
    return status >= 200 && status < 300;
  }
};

defaults.headers = {
  common: {
    'Accept': 'application/json, text/plain, */*'
  }
};

从上面便可以看出来,axios能够即在客户端使用又能在浏览器使用的奥秘,它是通过Nodejs和浏览器中各自的全局变量来区别当前在哪个环境下,然后底层各自实现,再暴露出一套统一的API出来给我们使用。同时它还默认了想 超时时间,Headers信息,alidateStatus等一些默认值进去,当我们在使用的时候不传递覆盖这些值时,即走默认的配置。

6、[Axios/adapters/http.js]先来看看Nodejs中的Axios的实现

// 进入./adapters/http,
...
var http = require('http');
var https = require('https');
...
module.exports = function httpAdapter(config) {
  return new Promise(function dispatchHttpRequest(resolvePromise, rejectPromise) {
    ...
    var req = transport.request(options, function handleResponse(res) {
    ...
    // 处理response后返回
    })
    // req的error处理
    req.on('error', function handleRequestError(err) {
      ...
    });
    req.end(data);
  })
}

从上可以看出在Nodejs中,Axios的实现其实是基于nodejs的http或者http模块来发起请求的。

7、[Axios/adapters/xhr.js]再来看看在浏览器中的Axios的实现

//进入./adapters/xhr文件下
...
module.exports = function xhrAdapter(config) {
  return new Promise(function dispatchXhrRequest(resolve, reject) {
    ...
    var request = new XMLHttpRequest();
    ...
    request.open(config.method.toUpperCase(), buildURL(config.url, config.params, config.paramsSerializer), true);
    ...
    request.onreadystatechange = function handleLoad() {
      ...
    };
    ...
    request.onabort = function handleAbort() {...}
    ...
    request.onerror = function handleError() {...}
    ...
    request.ontimeout = function handleTimeout() {...}
    ...
    request.send(requestData);
    ...
  })
}

一个完整的Ajax库封装流程,只不过axios暴露了一个Promise出去,所以axios在浏览器端和Ajax底层的原理是一样的,都是通过浏览器的XMLhttpRequest这个底层接口进行的一次封装。

8、[Axios/lib/core/Axios.js]上面已经看了在入口进去的axios文件中,createInstance函数传递的参数,接下来再看看createInstance内部的Axios构造函数做了什么。

// axios中
...
var context = new Axios(defaultConfig);
...

function Axios(instanceConfig) {
  this.defaults = instanceConfig;
  this.interceptors = {
    request: new InterceptorManager(),
    response: new InterceptorManager()
  };
}

Axios这个构造函数将刚才传入的defaultConfig参数挂到自己的this上,然后新增了一个interceptors拦截器对象,这个对象有request和response两个属性,接下来看一下这两个属性中的InterceptorManager 这个构造函数又是什么。

9、[Axios/lib/core/InterceptorManager.js]拦截器里的构造函数

// 进入core/InterceptorManager.js
InterceptorManager.prototype.use = function() {...}
InterceptorManager.prototype.eject =  function() {...}
InterceptorManager.prototype.forEach = function forEach(fn) {...}

拦截器暴露了三个方法use,eject,forEach三个方法,相信大家很多人在写自己的拦截器的时候都是用过use这个属性。后面两个比较少用,但是可以通过它的代码看出来,eject是删除use过的内容,forEach则是循环执行传入fn,整个拦截器部分就看完了。

10、[Axios/lib/core/Axios.js]再回到Axios.js文件里查看Axios 构造函数。

...
Axios.prototype.request = function request(config) {...})
Axios.prototype.getUri = function getUri(config) {...})
...
utils.forEach(['delete', 'get', 'head', 'options'], function forEachMethodNoData(method) {
  /*eslint func-names:0*/
  Axios.prototype[method] = function(url, config) {
    return this.request(utils.merge(config || {}, {
      method: method,
      url: url
    }));
  };
});
...
utils.forEach(['post', 'put', 'patch'], function forEachMethodWithData(method) {
  /*eslint func-names:0*/
  Axios.prototype[method] = function(url, data, config) {
    return this.request(utils.merge(config || {}, {
      method: method,
      url: url,
      data: data
    }));
  };
});

接下来又在Axios构造函数下,挂载到原型上了9个方法,包括我们常用的下述方法。

axios.request(config)
axios.getUri(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.head(url[, config])
axios.options(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

构造函数Axios看完了,再回到我们的入口文件axios下。

11、[Axios/lib/axios.js]回到入口文件

function createInstance(defaultConfig) {
  var context = new Axios(defaultConfig);
  var instance = bind(Axios.prototype.request, context);
  utils.extend(instance, Axios.prototype, context);
  utils.extend(instance, context);
  return instance;
}

首先看到一个bind方法将Axios.prototype.request和context作为参数传了进入,Axios.prototype.request是一个函数,context是一个构造出的对象,上面这一步操作就是我们可以使用Axios.get这一类静态方法的原因。

12、[Axios/lib/helper/bind.js]看看bind函数又做了什么。

module.exports = function bind(fn, thisArg) {
  return function wrap() {
    var args = new Array(arguments.length);
    for (var i = 0; i < args.length; i++) {
      args[i] = arguments[i];
    }
    return fn.apply(thisArg, args);
  };
};

bind函数在执行后返回了一个新函数,然后做了一次参数的深拷贝,接下来利用函数的apply,将传入的第二个对象参数作为一个函数参数的指定this,进行执行,即入口文件中在执行后为

Axios.prototype.request.bind(new Axios(defaultConfig);)

13、[Axios/lib/axios.js]接下来再看入口文件中剩下的两行。

  ...
  utils.extend(instance, Axios.prototype, context);
  utils.extend(instance, context);
  ...

从前面已经得出instance是一个函数,Axios.prototype和context均为两个对象。

14、[Axios/lib/utils.js]看一下utils.extend的实现。

function extend(a, b, thisArg) {
  forEach(b, function assignValue(val, key) {
    if (thisArg && typeof val === 'function') {
      a[key] = bind(val, thisArg);
    } else {
      a[key] = val;
    }
  });
  return a;
}

extend的简单大方,最后返回了第一个参数,即intance函数,并且给这个函数挂上一些静态属性。挂载的过程是先遍历了传入的Axios.prototype对象,如果该对象的值是函数就将函数绑定this后挂载在instance函数上,如果不是函数则直接挂载在构造函数上,我们使用的get,post等所有的方法均是通过这种方式进行挂载。

六. 总结与思考


整个Axios的源码流程梳理完了,可以看出它在http和浏览器底层分别实现的原理,所使用的它的方法如get,post是如何被挂载的,最常用的拦截器不单单可以被use加载,还可以通过eject删除。如果你后续需要配置一些参数却不知道如何下手,或者文档不能满足你,就请从源码层面去看看吧。

参考:http://www.axios-js.com/

如上内容均为自己总结,难免会有错误或者认识偏差,如有问题,希望大家留言指正,以免误人,若有什么问题请留言,会尽力回答之。如果对你有帮助不要忘了分享给你的朋友或者点击右下方的“在看”哦!也可以关注作者,查看历史文章并且关注最新动态,助你早日成为一名全栈工程师!

本文分享自微信公众号 - 全栈者(fullStackEngineer),作者:TingRongGao

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-07-26

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 50道常见的js面试题

    string, boolean, number, undefined, function, object

    用户1462769
  • 一个前端失业者的面试之旅

    2018年,变动的一年,随着P2P的雷声不断轰鸣,各企业纷纷开始裁员过冬,“开猿节流”一词正式被创造,很不幸,笔者所在的金融公司也不得不进入“冬眠”,而我也在农...

    用户1462769
  • Node.js 技术栈学习指南(含思维导图)

    说明:大致方向不会变,中间细节部分之后可能会修改,欢迎关注公众号「Nodejs技术栈」回复 “思维导图” 查看最新版学习指南

    用户1462769
  • 一步一步解析Axios源码,从入门到原理

    一个基于 Promise 来管理 http 请求的简洁、易用且高效的代码封装库。通俗一点来讲,它是一个前端替代Ajax的一个东西,可以使用它发起http请求接口...

    童欧巴
  • Cisco软件路由器通信的搭建方法

    该实验室是由两个模拟路由器和两个模拟的终端设备进行的。试验可分为四个步骤,分别是电路的搭建、设备终端的IP地址设置、路由器的配置以及最后的实验结果验证。

    用户5935416
  • 77.9K 的 Axios 项目有哪些值得借鉴的地方

    Axios 是一个基于 Promise 的 HTTP 客户端,同时支持浏览器和 Node.js 环境。它是一个优秀的 HTTP 客户端,被广泛地应用在大量的 W...

    ConardLi
  • PHP FFI 允许在 PHP 脚本中嵌入原始 C 代码

    Zend 的 Dmitry Stogov 通过允许 PHP 执行嵌入式 C 代码扩展了 PHP 的领域。 这将允许完全访问本地 C 函数,变量以及数据结构。

    猿哥
  • 想在老牌病理期刊上发生信,你得学这篇!

    大家好,今天和大家分享的是去年10月份发表在Modern Pathology (IF:5.988)杂志上的一篇文章,“Genetic analysis of p...

    科研菌
  • 生信分析需要多维度的验证:多数据集和湿实验

    Development and validation of a nomogram with an autophagy-related gene signatur...

    科研菌
  • 说说心里话:3句藏在心里很久的话

    从今年3月末开始运营公众号到现在,4个多月的时间关注我的读者已经增长到1万多了,真的很高兴能够在这里和大家相遇。在这个过程中我自己成长了很多,也认识了很多新的朋...

    谭庆波

扫码关注云+社区

领取腾讯云代金券