axios基于常见业务场景的二次封装(更新)
时隔一年再次更新下根据vue项目下常见业务场景对axios的二次封装
功能实现：
1.兼容ie浏览器避免缓存
2.减小或更新重复请求
3.接口域名使用环境变量
4.全局loading状态
5.可关闭的全局错误提醒
6.可开启携带全局分页参数
7...前端
拦截器
/**
* 请求拦截器
* @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状态
/**
* 请求结束&&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);
}
}
};
如下为具体功能实现
请求头预处理
- 时间戳：避免ie内核浏览器缓存
- token
/**
* 请求头预处理
* @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基于常见业务场景的二次封装
- 2. 常见的业务场景
- 3. axios二次封装
- 4. Axios二次封装
- 5. vue-axios二次封装
- 6. Vue之封装二次axios
- 7. axios二次封装学习
- 8. 代码块-常见业务场景
- 9. Redis常见业务场景应用
- 10. 基于axios二次封装，适用vue项目
- 更多相关文章...
- • Spring基于Annotation装配Bean - Spring教程
- • Spring基于XML装配Bean - Spring教程
- • ☆基于Java Instrument的Agent实现
- • 常用的分布式事务解决方案
相关标签/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. No provider available from registry 127.0.0.1:2181 for service com.ddbuy.ser 解决方法
- 2. Qt5.7以上调用虚拟键盘(支持中文)，以及源码修改(可拖动，水平缩放)
- 3. 软件测试面试- 购物车功能测试用例设计
- 4. ElasticSearch（概念篇）：你知道的, 为了搜索…
- 5. redux理解
- 6. gitee创建第一个项目
- 7. 支持向量机之硬间隔（一步步推导，通俗易懂）
- 8. Mysql 异步复制延迟的原因及解决方案
- 9. 如何在运行SEPM配置向导时将不可认的复杂数据库密码改为简单密码
- 10. windows系统下tftp服务器使用
欢迎关注本站公众号,获取更多信息
相关文章
- 1. axios基于常见业务场景的二次封装
- 2. 常见的业务场景
- 3. axios二次封装
- 4. Axios二次封装
- 5. vue-axios二次封装
- 6. Vue之封装二次axios
- 7. axios二次封装学习
- 8. 代码块-常见业务场景
- 9. Redis常见业务场景应用
- 10. 基于axios二次封装，适用vue项目