前端扯犊子之一Axios
中文文档:http://www.axios-js.com/zh-cn/docs/
看到一个分析源码的,写在前面,附上网址:
https://www.jianshu.com/p/5ecd21af5ed7
Web跨域请求及其解决方案以及XSRF:
https://blog.csdn.net/ppxin/article/details/94717173#1.%20%E4%BB%80%E4%B9%88%E6%98%AF%E8%B7%A8%E5%9F%9F%E8%AF%B7%E6%B1%82%EF%BC%88Cross-domain%20Request%EF%BC%89
一、概述
Axios 是一个基于 promise (即基于状态确定)的 HTTP 库,它以基于Promise的方式封装了浏览器的XMLHttpRequest和服务器端node http请求,使得我们可以用es6推荐的异步方式处理网络请求。可以用在浏览器和 node.js 中。在Vue中常用axios来做前后端的交互。
安装:可npm也可cdn
请求方法的别名
为方便起见,为所有支持的请求方法提供了别名
axios.request(配置)
axios.get(网址[,配置])
axios.delete(URL [,config])
axios.head(URL [,config])
axios.post(网址[,数据[,配置]])
axios.put(网址[,数据[,配置]])
axios.patch(URL [,data [,config]])
创建实例
一个使用自定义配置新建一个axios实例
axios.create([config])
var instance = axios.create({
baseURL: 'https://some-domain.com/api/',
timeout: 1000,
headers: {'X-Custom-Header': 'foobar'}
});
二、特性
1、从浏览器中创建 XMLHttpRequests
2、从 node.js 创建 http 请求
3、支持 Promise API
4、拦截请求和响应
5、转换请求数据和响应数据
6、取消请求
7、自动转换 JSON 数据
8、客户端支持防御 XSRF
三、使用
1、拦截请求与响应
axios拦截器(interceptors)分为请求拦截器(request)和响应拦截器(response)。
// 添加请求拦截器
axios.interceptors.request.use(function (config) {
// Do something before request is sent
return config;
}, function (error) {
// Do something with request error
return Promise.reject(error);
});
// 添加响应拦截器
axios.interceptors.response.use(function (response) {
// Do something with response data
return response;
}, function (error) {
// Do something with response error
return Promise.reject(error);
});
移除已经设置的拦截器
var myInterceptor = axios.interceptors.request.use(function () {/*...*/});
axios.interceptors.request.eject(myInterceptor);
给自定义的axios实例添加拦截器
var instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});
interceptors中的request和response两者都是通过一个InterceptorManager的对象进行管理,InterceptorManager的对象中是通过handlers数组变量存储拦截器,数组每项同时包含了分别作为Promise中resolve和reject的回调。InterceptorManager类中还包含了对该数组变量的添加、移除、遍历方法。
值得一提的是,移除方法是通过直接将该项设为null实现的,而不是用splice剪切该数组,遍历方法中也增加了相应的null值处理。这样做一方面使得每一项ID保持为项的数组索引不变,另一方面也避免了重新剪切拼接数组的性能损失。
2、转换请求与响应数据
通过transformRequest和transformResponse,可链式的传递函数数组对数据进行转换
{
// 转换请求数据,注意只有'PUT', 'POST', 和'PATCH'有请求体
// 最后一个转换函数必须返回合法的请求数据类型
transformRequest: [function (data) {
// Do whatever you want to transform the data
return data;
}],
// 转换返回数据,将在then回调之前执行
transformResponse: [function (data) {
// Do whatever you want to transform the data
return data;
}],
}
3、自动转换JSON数据
在默认情况下,axios将会自动的将传入的data对象序列化为JSON字符串,将响应数据中的JSON字符串转换为JavaScript对象。
4、支持客户端XSRF攻击防护
XSRF攻击,即“跨站请求伪造”(Cross Site Request Forgery)攻击。通过窃取用户cookie,让用户在本机(即拥有身份 cookie 的浏览器端)发起用户所不知道的请求。防护XSRF攻击的一种方法是设置特殊的xsrf token,axios实现了对这种方法的支持。
补充:请求配置
{
// `url` 是用于请求的服务器 URL
url: '/user',
// `method` 是创建请求时使用的方法
method: 'get', // 默认是 get
// `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
// 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
baseURL: 'https://some-domain.com/api/',
// `transformRequest` 允许在向服务器发送前,修改请求数据
// 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
// 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream
transformRequest: [function (data) {
// 对 data 进行任意转换处理
return data;
}],
// `transformResponse` 在传递给 then/catch 前,允许修改响应数据
transformResponse: [function (data) {
// 对 data 进行任意转换处理
return data;
}],
// `headers` 是即将被发送的自定义请求头
headers: {'X-Requested-With': 'XMLHttpRequest'},
// `params` 是即将与请求一起发送的 URL 参数
// 必须是一个无格式对象(plain object)或 URLSearchParams 对象
params: {
ID: 12345
},
// `paramsSerializer` 是一个负责 `params` 序列化的函数
// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function(params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
},
// `data` 是作为请求主体被发送的数据
// 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
// 在没有设置 `transformRequest` 时,必须是以下类型之一:
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
// - 浏览器专属:FormData, File, Blob
// - Node 专属: Stream
data: {
firstName: 'Fred'
},
// `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
// 如果请求话费了超过 `timeout` 的时间,请求将被中断
timeout: 1000,
// `withCredentials` 表示跨域请求时是否需要使用凭证
withCredentials: false, // 默认的
// `adapter` 允许自定义处理请求,以使测试更轻松
// 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// `auth` 表示应该使用 HTTP 基础验证,并提供凭据
// 这将设置一个 `Authorization` 头,覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
// `responseType` 表示服务器响应的数据类型,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
responseType: 'json', // 默认的
// `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
xsrfCookieName: 'XSRF-TOKEN', // default
// `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的
// `onUploadProgress` 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// `onDownloadProgress` 允许为下载处理进度事件
onDownloadProgress: function (progressEvent) {
// 对原生进度事件的处理
},
// `maxContentLength` 定义允许的响应内容的最大尺寸
maxContentLength: 2000,
// `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),promise 将被 resolve; 否则,promise 将被 rejecte
validateStatus: function (status) {
return status >= 200 && status < 300; // 默认的
},
// `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
// 如果设置为0,将不会 follow 任何重定向
maxRedirects: 5, // 默认的
// `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项:
// `keepAlive` 默认没有启用
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
// 'proxy' 定义代理服务器的主机名称和端口
// `auth` 表示 HTTP 基础验证应当用于连接代理,并提供凭据
// 这将会设置一个 `Proxy-Authorization` 头,覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
proxy: {
host: '127.0.0.1',
port: 9000,
auth: : {
username: 'mikeymike',
password: 'rapunz3l'
}
},
// `cancelToken` 指定用于取消请求的 cancel token
// (查看后面的 Cancellation 这节了解更多)
cancelToken: new CancelToken(function (cancel) {
})
}
————————————————————————————
上面是之前整理的,下面想尽量用落地的语言聊一聊。
问:谈一谈你对axios的理解
1、axios是什么?
源码中是这么说的
// 示例代码
function createInstance(config) {
return function request(config) {
console.log(config);
};
}
var axios = createInstance(defaults);
所以,axios是一个函数。
2、createInstance 函数
对createInstance 函数产生了好奇。
//lib/axios.js
function createInstance(defaultConfig) {
// 创建Axios实例
var context = new Axios(defaultConfig);
// 使用bind生成可执行函数,将request方法在context作用域上执行;
// instance=function(){};
var instance = bind(Axios.prototype.request, context);
// 将Axios.prototype原型上所有的(属性、方法)挂载到instance(函数)上作为静态(方法、属性)供开发者使用;
// 只有这样开发者才可以直接使用别名方法如axios.get、axios.post;
// instance.get=Axios.prototype.get;
// instance.post=Axios.prototype.post
utils.extend(instance, Axios.prototype, context);
// 将context上所有的(属性、方法)挂载到instance(函数)上作为静态(方法、属性)供开发者使用;
// instance.defaults=context.defaults;
// instance.interceptors=context.interceptors;
utils.extend(instance, context);
// 开发者调用的axios其实就是instance这个函数,该函数返回值类型为Promise
return instance;
}
创建 Axios 实例.
定义 instance 函数(该函数实际上就是 request 方法).
instance 函数上挂载 Axios.prototype 原型方法作为静态方法.
instance 函数上挂载 context 的属性、方法.
3、mergeConfig 函数
上面有请求配置,但在使用时我们是可以自定义的,那在axios源码中是如何处理默认和自定义配置带来的差异呢?
mergeConfig 函数接收两个参数config1 config2,第一个参数为默认配置项第二个参数为自定义配置项,返回值为合并之后的 config.
处理方式原则:
优先使用开发者自定义配置项-url,method,params,data(有配置则优先级最高)
按照优先级顺序(自定义>默认)取值-headersauthproxy(自定义配置覆盖默认值)
其它默认配置项赋值(自定义>默认)(先看有无自定义配置,没有则用默认)
var valueFromConfig2Keys = ['url', 'method', 'params', 'data'];
utils.forEach(valueFromConfig2Keys, function valueFromConfig2(prop) {
if (typeof config2[prop] !== 'undefined') {
config[prop] = config2[prop];
}
});
var mergeDeepPropertiesKeys = ['headers', 'auth', 'proxy'];
utils.forEach(mergeDeepPropertiesKeys, function mergeDeepProperties(prop) {
if (utils.isObject(config2[prop])) {
config[prop] = utils.deepMerge(config1[prop], config2[prop]);
} else if (typeof config2[prop] !== 'undefined') {
config[prop] = config2[prop];
} else if (utils.isObject(config1[prop])) {
config[prop] = utils.deepMerge(config1[prop]);
} else if (typeof config1[prop] !== 'undefined') {
config[prop] = config1[prop];
}
});
var defaultToConfig2Keys = [
'baseURL',
'url',
'transformRequest',
'transformResponse',
'paramsSerializer',
'timeout',
'withCredentials',
'adapter',
'responseType',
'xsrfCookieName',
'xsrfHeaderName',
'onUploadProgress',
'onDownloadProgress',
'maxContentLength',
'validateStatus',
'maxRedirects',
'httpAgent',
'httpsAgent',
'cancelToken',
'socketPath'
];
utils.forEach(defaultToConfig2Keys, function defaultToConfig2(prop) {
if (typeof config2[prop] !== 'undefined') {
config[prop] = config2[prop];
} else if (typeof config1[prop] !== 'undefined') {
config[prop] = config1[prop];
}
});
配置的优先顺序是:在 lib/defaults.js 找到的库的默认值,然后是实例的 defaults 属性,最后是请求的 config 参数。后者将优先于前者。
// 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
var instance = axios.create();
// 覆写库的超时默认值
// 现在,在超时前,所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500;
// 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest', {
timeout: 5000
});
4、拦截器管理
//lib/core/InterceptorManager.js
function InterceptorManager() {
this.handlers = [];
}
InterceptorManager.prototype.use = function use(fulfilled, rejected) {
...
};
InterceptorManager.prototype.eject = function eject(id) {
...
};
InterceptorManager.prototype.forEach = function forEach(fn) {
...
};
构造函数
构造函数内比较简单,初始化 handlers 数组用来存储拦截器.
use 添加拦截器
use 方法实现添加拦截器,接收两个参数fulfilled rejected这两个参数实际上作为 Promise 中 resolve 和 reject 的回调,返回值为当前添加的元素在 handlers 内的索引位置,此处返回索引位置作为 ID 便于移除拦截器使用.
eject 移除拦截器
eject 方法实现移动拦截器,接收一个参数id,从 handlers 数组检索并置为 nullthis.handlers[id] = null,之所有这样操作避免索引位置发生变化.
forEach 循环遍历拦截器
循环遍历拦截器数组,接收一个参数fn(Function 类型)在每个拦截器上执行该函数.
this.defaults 接收参数,初始化默认配置项
this.interceptors 初始化拦截对象,并且创建 request、response 拦截器的实例对象
5、取消
使用 CancelToken.source 工厂方法创建 cancel token
参考链接:
https://blog.csdn.net/bangbanggangan/article/details/85796589
https://zhuanlan.zhihu.com/p/28396592
https://www.kancloud.cn/yunye/axios/234845
http://www.axios-js.com/zh-cn/docs/
https://zhuanlan.zhihu.com/p/137272921