时隔一年再次更新下根据vue项目下常见业务场景对axios的二次封装
功能实现:
1.兼容ie浏览器避免缓存
2.减少或更新重复请求
3.接口域名使用环境变量
4.全局loading状态
5.可关闭的全局错误提醒
6.可开启携带全局分页参数
/**
* 请求拦截器
* @param {} requestStart 请求开始
*/
service.interceptors.request.use(
config => {
requestStart({ config });
return config;
},
error => {
Message.error("请求出错");
Promise.reject(error);
}
);
/**
* 响应拦截器
* @param {} requestEnd 1.请求结束
* @param {} responseResolve 2.请求错误处理
*/
service.interceptors.response.use(
response => {
const { status, data, config } = response;
requestEnd({ config, data });
return responseResolve({ status, data, config });
},
error => {
if (axios.isCancel(error)) {
Message.warning("网络请求中,请不要重复操作!");
} else {
const { response } = error;
Message.error({
dangerouslyUsehtmlString: true,
message: `<p>请求接口: ${
response.config.url
}</p><p>请求方法 : ${
response.config.method
}</p><p>响应状态 : ${response.status}</p><p>响应信息 : ${
response.statusText
}</p>`
});
}
store.commit("setLoading", false);
store.commit("setPageTotal", 0);
return Promise.reject(error);
}
);
/**
* 请求开始&&loading=true
* @param {} requestHeaders 请求头
* @param {} requestParams 请求参数
* @param {} removePending 重复请求
*/
const requestStart = ({ config } = {}) => {
requestHeaders({ config });
requestParams({ config });
removePending({ config });
addPending({ config });
store.commit("setLoading", true);
};
/**
* @param {} {status HTTP状态码
* @param {} data 响应体
* @param {} config}={} AxiosRequestConfig
*/
const responseResolve = ({ status, data, config } = {}) => {
const { code, text } = data;
if (status === 200) {
switch (code) {
case 200:
return Promise.resolve(data);
case 900401:
Message.error(text || "登录超时,请重新登录!");
window.location.href = process.env.VUE_APP_AUTH_URL;
return Promise.reject(data);
default:
//可配置错误提醒
if (!config.headers["hide-message"]) {
Message.error(text || "操作失败!");
}
return Promise.reject(data);
}
} else {
Message.error(text || "操作失败!");
store.commit("setLoading", false);
return Promise.reject(data);
}
};
/**
* 请求结束&&loading=false
* @param {} {config}={} AxiosRequestConfig
* @param {} {config}={} response body
*/
const requestEnd = ({ config, data } = {}) => {
removePending({ config });
store.commit("setLoading", false);
//配置分页
if (config.headers.pagination) {
const { data: content } = data;
if (content) {
store.commit("setPageTotal", content.total);
}
}
};
/**
* 请求头预处理
* @param {} {config} AxiosRequestConfig
*/
const requestHeaders = ({ config }) => {
//1.时间戳
const timestamp = new Date().getTime();
config.headers.timestamp = timestamp;
//2.token
const token = sessionStorage.getItem("token");
if (token) {
config.headers.token = token;
}
};
/**
* 请求参数预处理
* @param {} {config}={} AxiosRequestConfig
*/
const requestParams = ({ config } = {}) => {
//配置分页
if (config.headers.pagination) {
const { pageNum, pageSize } = store.getters.getPagination;
config.data = Object.assign({}, config.data, {
pageNum,
pageSize
});
}
};
/**
* 处理重复请求
* @param {} {config}={} AxiosRequestConfig
*/
const addPending = ({ config }) => {
const url =
config.url + "&" + config.method + "&" + qs.stringify(config.data);
config.cancelToken = new cancelToken(cancel => {
if (!pending.some(item => item.url === url)) {
pending.push({
url,
cancel
});
}
});
};
const removePending = ({ config }) => {
const url =
config.url + "&" + config.method + "&" + qs.stringify(config.data);
pending.forEach((item, index) => {
if (item.url === url) {
item.cancel("取消重复请求:" + config.url);
pending.splice(index, 1);
}
});
};
import { Message } from "element-ui";
import axios from "axios";
import store from "../store/index";
const qs = require("qs");
const service = axios.create({
baseURL: process.env.VUE_APP_BASE_api,
timeout: 100000
});
const pending = [];
const cancelToken = axios.CancelToken;
/**
* 处理重复请求
* @param {} {config}={} AxiosRequestConfig
*/
const addPending = ({ config }) => {
const url =
config.url + "&" + config.method + "&" + qs.stringify(config.data);
config.cancelToken = new cancelToken(cancel => {
if (!pending.some(item => item.url === url)) {
pending.push({
url,
cancel
});
}
});
};
const removePending = ({ config }) => {
const url =
config.url + "&" + config.method + "&" + qs.stringify(config.data);
pending.forEach((item, index) => {
if (item.url === url) {
item.cancel("取消重复请求:" + config.url);
pending.splice(index, 1);
}
});
};
/**
* 请求头预处理
* @param {} {config} AxiosRequestConfig
*/
const requestHeaders = ({ config }) => {
//1.时间戳
const timestamp = new Date().getTime();
config.headers.timestamp = timestamp;
//2.token
const token = sessionStorage.getItem("token");
if (token) {
config.headers.token = token;
}
};
/**
* 请求参数预处理
* @param {} {config}={} AxiosRequestConfig
*/
const requestParams = ({ config } = {}) => {
//配置分页
if (config.headers.pagination) {
const { pageNum, pageSize } = store.getters.getPagination;
config.data = Object.assign({}, config.data, {
pageNum,
pageSize
});
}
};
/**
* 请求开始&&loading=true
* @param {} requestHeaders 1.配置请求头
* @param {} requestParams 2.配置请求体
* @param {} removePending 3.处理重复请求
*/
const requestStart = ({ config } = {}) => {
requestHeaders({ config });
requestParams({ config });
removePending({ config });
addPending({ config });
store.commit("setLoading", true);
};
/**
* 请求结束&&loading=false
* @param {} {config}={} AxiosRequestConfig
* @param {} {config}={} response body
*/
const requestEnd = ({ config, data } = {}) => {
removePending({ config });
store.commit("setLoading", false);
//配置分页
if (config.headers.pagination) {
const { data: content } = data;
if (content) {
store.commit("setPageTotal", content.total);
}
}
};
/**
* @param {} {status HTTP状态码
* @param {} data 响应体
* @param {} config}={} AxiosRequestConfig
*/
const responseResolve = ({ status, data, config } = {}) => {
const { code, text } = data;
if (status === 200) {
switch (code) {
case 200:
return Promise.resolve(data);
case 900401:
Message.error(text || "登录超时,请重新登录!");
window.location.href = process.env.VUE_APP_AUTH_URL;
return Promise.reject(data);
default:
//可配置错误提醒
if (!config.headers["hide-message"]) {
Message.error(text || "操作失败!");
}
return Promise.reject(data);
}
} else {
Message.error(text || "操作失败!");
store.commit("setLoading", false);
return Promise.reject(data);
}
};
/**
* 请求拦截器
* @param {} requestStart 请求开始
*/
service.interceptors.request.use(
config => {
requestStart({ config });
return config;
},
error => {
Message.error("请求出错");
Promise.reject(error);
}
);
/**
* 响应拦截器
* @param {} requestEnd 1.请求结束
* @param {} responseResolve 2.请求错误处理
*/
service.interceptors.response.use(
response => {
const { status, data, config } = response;
requestEnd({ config, data });
return responseResolve({ status, data, config });
},
error => {
if (axios.isCancel(error)) {
Message.warning("网络请求中,请不要重复操作!");
} else {
const { response } = error;
Message.error({
dangerouslyUseHTMLString: true,
message: `<p>请求接口: ${
response.config.url
}</p><p>请求方法 : ${
response.config.method
}</p><p>响应状态 : ${response.status}</p><p>响应信息 : ${
response.statusText
}</p>`
});
}
store.commit("setLoading", false);
store.commit("setPageTotal", 0);
return Promise.reject(error);
}
);
export default service;
1
axios的功能特性:在浏览器中发送 XMLHttpRequests 请求,在 node.js 中发送 http请求,支持 Promise API,拦截请求和响应,转换请求和响应数据,自动转换 JSON 数据,客户端支持保护安全免受 XSRF 攻击
axios基于 Promise 的 HTTP 请求客户端,可同时在浏览器和 node.js 中使用。项目中发现,在安卓4.3及以下的手机不支持axios的使用,主要就是无法使用promise。加上以下polyfill就可以了。
Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。axios中get/post/put/patch请求。传参格式为 formData ,传参格式为 query 形式 ,传参格式为 raw等
axios-mock-adapter可以用来拦截http请求,并模拟响应,使用起来也很简单,比如你想模拟下服务器返回个500错误,什么404找不到、403禁止访问、500服务器错误、503服务不可用、504网关超时等等,你都能模拟出来
分享下我自己的axios封装,axios是个很好用的插件,都是一些params对象,所以很方便做一些统一处理。当然首先是npm安装axios 很简单。在src下新建文件夹 service / index.js,接着上代码
最近做项目遇到一款浏览器,由于缓存了get请求,导致不管如何刷新,数据都不更新的问题。以下分享一下解决办法:解决思路就是给每一条get请求增加一个timestamp的参数,value为时间戳
发送请求模块目录,@/api/url中存放的是每个模块的URL,使用webpack提供的require.context将src/api/url下后缀为js的所有文件引入,并整理出一个对象。整合common.js & product.js,最终得到的对象如下:
在vue项目开发过程中,为了方便在各个组件中调用axios,我们通常会在入口文件将axios挂载到vue原型身上,如下:这样的话,我们在各个组件中进行请求时
项目中需要验证登录用户身份是否过期,是否有权限进行操作,所以需要根据后台返回不同的状态码进行判断。axios的拦截器分为请求拦截器和响应拦截器两种。我一般把拦截器写在main.js里。
作为一名前端er,对于数据请求的第三方工具axios,一定不会陌生,如果还是有没有用过,或者不了解的小伙伴,这里给你们准备了贴心的中文文档 ,聪明的你们一看就会~
内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!