0
点赞
收藏
分享

微信扫一扫

《Axios》axios的初识与摘要

三分梦_0bc3 2022-05-03 阅读 192

同时处理多个请求的函数

axios.all(iterable)

axios.spread(callback)

[](()实例


[](()创建示例

通过axios.create([config])新创建axios的实例

//创建了一个axios的实例,instance,并且这个实例上有默认的三项设置

//1.设置请求的url的前缀,

//2.设置请求的超时时间是1000毫秒

//3.设置请求头

const instance = axios.create({

baseURL: ‘https://some-domain.com/api/’,

timeout: 1000,

headers: {‘X-Custom-Header’: ‘foobar’}

});

[](()配置默认值

[](()全局添加

axios.defaults.baseURL = ‘https://api.example.com’;

axios.defaults.headers.common[‘Authorization’] = AUTH_TOKEN;

axios.defaults.headers.post[‘Content-Type’] = ‘application/x-www-form-urlencoded’;

[](()为创建的实例添加

创建好实例后需要为实例设置默认值,一种是上面的通过创建时配置,另外一个则是和全局添加一样通过default添加进实例

// Set config defaults when creating the instance

const instance = axios.create({

baseURL: ‘https://api.example.com’

});

// Alter defaults after instance has been created

instance.defaults.headers.common[‘Authorization’] = AUTH_TOKEN;

[](()配置的优先级

当请求发起的时候,如果发现有多个相同的配置,则会对配置进行合并,合并优先级如下:

请求时设置的confing > 实例上设置的默认值 > axios设置的系统默认值

// 使用由库提供的配置的默认值来创建实例

// 此时超时配置的默认值是 0

var instance = axios.create();

// 覆写库的超时默认值

// 现在,在超时前,所有请求都会等待 2.5 秒

instance.defaults.timeout = 2500;

// 为已知需要花费很长时间的请求覆写超时设置

instance.get(‘/longRequest’, {

timeout: 5000

});

[](()具体配置

这些是创建请求时可以用的配置选项。只有 url 是必需的。如果没有指定 method,请求将默认使用 get 方法

{

url: ‘/user’, //请求的服务器 URL

method: ‘get’, // 请求时使用的方法,默认是get

// 前缀地址,值将作为前缀添加到url的前面合并成一个完整的请求地址

baseURL: ‘https://some-domain.com/api/’,

// transformRequest 允许在向服务器发送前,修改请求数据

// 只能用在 ‘PUT’, ‘POST’ 和 ‘PATCH’ 这几个请求方法

// 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream

transformRequest: [function (data, headers) {

// 对 data 进行任意转换处理

return data;

}],

// transformResponse 在传递给 then/catch 前,允许修改响应数据

transformResponse: [function (data) {

// 对 data 进行任意转换处理

return data;

}],

// 请求头

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, // default

// adapter 允许自定义处理请求,以使测试更轻松

// 返回一个 promise 并应用一个有效的响应 (查阅 response docs).

adapter: function (config) {

/* … */

},

// auth 表示应该使用 HTTP 基础验证,并提供凭据

// 这将设置一个 Authorization 头,覆写掉现有的任意使用 headers 设置的自定义 Authorization

auth: {

username: ‘janedoe’,

password: ‘s00pers3cret’

},

// responseType 表示服务器响应的数据类型,可以 《大厂前端面试题解析+Web核心总结学习笔记+企业项目实战源码+最新高清讲解视频》无偿开源 徽信搜索公众号【编程进阶路】 是 ‘arraybuffer’, ‘blob’, ‘document’, ‘json’, ‘text’, ‘stream’

responseType: ‘json’, // default

// responseEncoding indicates encoding to use for decoding responses

// Note: Ignored for responseType of ‘stream’ or client-side requests

responseEncoding: ‘utf8’, // default

// xsrfCookieName 是用作 xsrf token 的值的cookie的名称

xsrfCookieName: ‘XSRF-TOKEN’, // default

// xsrfHeaderName is the name of the http header that carries the xsrf token value

xsrfHeaderName: ‘X-XSRF-TOKEN’, // default

// onUploadProgress 允许为上传处理进度事件

onUploadProgress: function (progressEvent) {

// Do whatever you want with the native progress event

},

// onDownloadProgress 允许为下载处理进度事件

onDownloadProgress: function (progressEvent) {

// 对原生进度事件的处理

},

// maxContentLength 定义允许的响应内容的最大尺寸

maxContentLength: 2000,

// validateStatus 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。如果 validateStatus 返回 true (或者设置为 nullundefined),promise 将被 resolve; 否则,promise 将被 rejecte

validateStatus: function (status) {

return status >= 200 && status < 300; // default

},

// maxRedirects 定义在 node.js 中 follow 的最大重定向数目

// 如果设置为0,将不会 follow 任何重定向

maxRedirects: 5, // default

// socketPath defines a UNIX Socket to be used in node.js.

// e.g. ‘/var/run/docker.sock’ to send requests to the docker daemon.

// Only either socketPath or proxy can be specified.

// If both are specified, socketPath is used.

socketPath: null, // default

// httpAgenthttpsAgent 分别在 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) {

})

}

[](()响应结构

每个请求的响应都会包含一下信息

{

data: {}, //由服务器提供的响应

status: 200, //来自服务器响应的 HTTP 状态码

statusText: ‘OK’, //来自服务器响应的 HTTP 状态信息

headers: {}, //服务器响应的头

config: {}, //为请求提供的配置信息

// ‘request’

// request is the request that generated this response

// It is the last ClientRequest instance in node.js (in redirects)

// and an XMLHttpRequest instance the browser

request: {}

}

具体接收则通过then方法,比如

axios.get(‘/user/12345’)

.then(function(response) {

console.log(response.data);

console.log(response.status);

console.log(response.statusText);

console.log(response.headers);

console.log(response.config);

});

[](()拦截器

顾名思义,拦截器就是会在每一次请求或者响应前都会对其进行拦截,并按设定好的要求做处理,比如,每一次请求前都需要判断当前token是否存在

[](()请求拦截

// 添加请求拦截器

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

});

[](()消除拦截

const myInterceptor = axios.interceptors.request.use(function () {//});

axios.interceptors.request.eject(myInterceptor);

[](()为创建的实例添加拦截

const instance = axios.create();

instance.interceptors.request.use(function () {//});

[](()错误处理

axios.get(‘/user/12345’)

.catch(function (error) {

if (error.response) {

// The request was made and the server responded with a status code

// that falls out of the range of 2xx

console.log(error.response.data);

console.log(error.response.status);

console.log(error.response.headers);

} else if (error.request) {

// The request was made but no response was received

// error.request is an instance of XMLHttpRequest in the browser and an instance of

// http.ClientRequest in node.js

console.log(error.request);

} else {

// Something happened in setting up the request that triggered an Error

console.log(‘Error’, error.message);

}

console.log(error.config);

});

[](()案例示例

==============================================================

上面说的,一般axios在项目中是需要进过一次封装的,下面这个就是一个简单的示例,目的是想说明,一般使用还是按具体需求,将共用的,通用的一些配置,参数都封装在一起,独有的再每次调用的时候在确认(比如每次的请求方式,是post还是get,可以不封装),以Vue中为例,安装或者引入之后,

//引入axios

import axios from ‘axios’;

//引入elementUI

import { Message } from ‘element-ui’;

//设置默认地址

const configBaseURL = ‘’;

//创建一个axios实例,设置超时时间为10秒,

const service = axios.create({

timeout:10000, //超市时间

baseUrl:configBaseURL

})

//设置请求拦截器

service.interceptors.request.use((config) => {

//如果使用了UI库,还可以在这边添加loading动画,效果就是每次请求的时候都会出现loading

//if的作用:判断本地localStorage中存不存在token,如果存在,就给每一个http的header都加上token

if(localStorage.tsToken){

//设置自动给每一个header都加上token

config.headers.Authorization = localStorage.tsToken;

}

return config;

},(err) => {

Promise.reject(err);

})

//设置响应拦截,如果设置了loading动画,这里在响应中把loading关闭

service.interceptors.response.use((response) => {

return response

},(err) => {

let errMsg = “”;

if(err && err.response.status){

switch (err.response.status){

case 401:

errMsg = ‘登录失效了,请重新登录’;

//返回401,说明token已经失效了,那么就跳转到登录页面

localStorage.removeItem(‘tsToken’);

router.push(‘/login’);

break;

case 403:

errMsg = ‘拒绝访问’;

break;

case 408:

errMsg = ‘请求超时’;

break;

case 500:

errMsg = ‘服务器内部错误’;

break;

case 501:

errMsg = ‘服务未实现’;

break;

case 502:

errMsg = ‘网关错误’;

break;

举报

相关推荐

0 条评论