一、概述
Axios 是一个基于 Promise 的 HTTP 客户端,可以用在浏览器和 node.js 中,本质是XMLHttpRequests请求即ajax请求。
拥有以下特性:
从浏览器中创建 XMLHttpRequests
从 node.js 创建 http 请求
支持Promise API;
能够拦截请求和响应;
能够转换请求和响应数据;
能够取消请求;
能够自定转化JSON数据;
客户端支持防御CSRF(XSRF)
Axios 支持大多数主流的浏览器,比如 Chrome、Firefox、Safari 和 IE 8以上。
详细可访问axios中文网::http://www.axios-js.com/zh-cn/docs/
二、HTTP 拦截器的设计与实现
2.1 需求分析
比如通常会使用 token 进行用户的身份认证。这就要求在认证通过后,我们需要在每个请求上都携带认证信息。针对这个需求,为了避免为每个请求单独处理,所以一般通过封装统一的 request
函数来为每个请求统一添加 token 信息。
但是如果响应进行统一处理的话,会越来越难维护,所以希望在接收到响应之后做一些额外的逻辑
因此,Axios 为我们提供了解决方案 —— 拦截器,作用如下:
请求拦截器:该类拦截器的作用是在请求发送前统一执行某些操作,比如在请求头中添加 token 字段。
响应拦截器:该类拦截器的作用是在接收到服务器响应后统一执行某些操作,比如发现响应状态码为 401 时,自动跳转到登录页。
拦截器的使用方式如下:
在 axios
对象上有一个 interceptors
对象属性,该属性又有 request
和 response
2 个属性, axios.interceptors.request
和 axios.interceptors.response
对象提供了 use
方法,就可以分别设置请求拦截器和响应拦截器:(use
方法支持 2 个参数,第一个参数类似 Promise 的 resolve
函数,第二个参数类似 Promise 的 reject
函数。我们可以在 resolve
函数和 reject
函数中执行同步代码或者是异步代码逻辑。)
// 添加一个请求拦截器
axios.interceptors.request.use(function (config){
// 在发送请求之前可以做一些事情
config.headers.token = 'added by interceptor'; //在headers中携带token
return config;
},function (error){
// 处理请求错误
return Promise.reject(error)
});
// 添加一个响应拦截器
axios.interceptors.response.use(function (res){
// 在发送请求之前可以做一些事情
return res;
},function (error){
// 处理请求错误
return Promise.reject(error)
});
我们先来分析一下拦截器的设计思路。Axios 的作用是用于发送 HTTP 请求,而请求拦截器和响应拦截器的本质都是一个实现特定功能的函数。
我们可以按照功能把发送 HTTP 请求拆解成不同类型的子任务,比如有用于处理请求配置对象的子任务,用于发送 HTTP 请求的子任务和用于处理响应对象的子任务。当我们按照指定的顺序来执行这些子任务时,就可以完成一次完整的 HTTP 请求。
了解完这些,接下来我们将从 任务注册、任务编排和任务调度 三个方面来分析 Axios 拦截器的实现。
2.2 任务注册
通过前面拦截器的使用示例,我们已经知道如何注册请求拦截器和响应拦截器,其中请求拦截器用于处理请求配置对象的子任务,而响应拦截器用于处理响应对象的子任务。要搞清楚任务是如何注册的,就需要了解 axios
和 axios.interceptors
对象。
// lib/axios.js
function createInstance(defaultConfig) {
var context = new Axios(defaultConfig);
var instance = bind(Axios.prototype.request, context);
// Copy axios.prototype to instance
utils.extend(instance, Axios.prototype, context);
// Copy context to instance
utils.extend(instance, context);
return instance;
}
// Create the default instance to be exported
var axios = createInstance(defaults);
在 Axios 的源码中,我们找到了 axios
对象的定义,很明显默认的 axios
实例是通过 createInstance
方法创建的,该方法最终返回的是 Axios.prototype.request
函数对象。同时,我们发现了 Axios
的构造函数:
// lib/core/Axios.js
function Axios(instanceConfig) {
this.defaults = instanceConfig;
this.interceptors = {
request: new InterceptorManager(),
response: new InterceptorManager()
};
}
在构造函数中,我们找到了 axios.interceptors
对象的定义,也知道了 interceptors.request
和 interceptors.response
对象都是 InterceptorManager
类的实例。因此接下来,进一步分析 InterceptorManager
构造函数及相关的 use
方法就可以知道任务是如何注册的:
// lib/core/InterceptorManager.js
function InterceptorManager() {
this.handlers = [];
}
InterceptorManager.prototype.use = function use(fulfilled, rejected) {
this.handlers.push({
fulfilled: fulfilled,
rejected: rejected
});
// 返回当前的索引,用于移除已注册的拦截器
return this.handlers.length - 1;
};
通过观察 use
方法,我们可知注册的拦截器都会被保存到 InterceptorManager
对象的 handlers
属性中。下面我们用一张图来总结一下 Axios
对象与 InterceptorManager
对象的内部结构与关系:
2.3 任务编排
现在我们已经知道如何注册拦截器任务,但仅仅注册任务是不够,我们还需要对已注册的任务进行编排,这样才能确保任务的执行顺序。这里我们把完成一次完整的 HTTP 请求分为处理请求配置对象、发起 HTTP 请求和处理响应对象 3 个阶段。
接下来我们来看一下 Axios 如何发请求的:
axios({
url: '/hello',
method: 'get',
}).then(res =>{
console.log('axios res: ', res)
console.log('axios res.data: ', res.data)
})
通过前面的分析,我们已经知道 axios
对象对应的是 Axios.prototype.request
函数对象,该函数的具体实现如下:
// lib/core/Axios.js
Axios.prototype.request = function request(config) {
config = mergeConfig(this.defaults, 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;
};
任务编排的代码比较简单,我们来看一下任务编排前和任务编排后的对比图:
2.4 任务调度
任务编排完成后,要发起 HTTP 请求,我们还需要按编排后的顺序执行任务调度。在 Axios 中具体的调度方式很简单,具体如下所示:
// lib/core/Axios.js
Axios.prototype.request = function request(config) {
// 省略部分代码
var promise = Promise.resolve(config);
while (chain.length) {
promise = promise.then(chain.shift(), chain.shift());
}
}
因为 chain 是数组,所以通过 while 语句我们就可以不断地取出设置的任务,然后组装成 Promise 调用链从而实现任务调度,对应的处理流程如下图所示:
下面我们来回顾一下 Axios 拦截器完整的使用流程:
// 添加请求拦截器 —— 处理请求配置对象
axios.interceptors.request.use(function (config) {
config.headers.token = 'added by interceptor';
return config;
});
// 添加响应拦截器 —— 处理响应对象
axios.interceptors.response.use(function (data) {
data.data = data.data + ' - modified by interceptor';
return data;
});
axios({
url: '/hello',
method: 'get',
}).then(res =>{
console.log('axios res.data: ', res.data)
})
介绍完 Axios 的拦截器,我们来总结一下它的优点。Axios 通过提供拦截器机制,让开发者可以很容易在请求的生命周期中自定义不同的处理逻辑。此外,也可以通过拦截器机制来灵活地扩展 Axios 的功能,比如 Axios 生态中列举的 axios-response-logger 和 axios-debug-log 这两个库。
参考 Axios 拦截器的设计模型,我们就可以抽出以下通用的任务处理模型: