axios封装【https://juejin.im/post/5b55c118f265da0f6f1aa354】
在vue项目中,一般和后台数据交互获取,使用的是axios库,它是基于promise的http库,可运行到浏览器和node.js中。
axios的特性:
安装:
npm install axios; //安装axios
引入:【可以在项目的src中,新建一个request文件夹,然后里面新建两个文件,http.js和api.js。http.js文件用来封装axios,api.js文件用来统一管理我们的接口。】
//在http.js中引入axios import axios from ‘axios‘; //引入axios import QS from ‘qs‘; //引入qs模块,用来序列化post类型的数据
环境的切换:【项目中有开发环境、测试环境和生产环境,我们通过node的环境变量来匹配我们的默认接口url前缀。】
//环境的切换 if(process.env.NODE_ENV == ‘development‘){ axios.defaults.baseURL = ‘https://www.baidu.com‘;//开发地址 } else if (process.env.NODE_ENV == ‘debug‘) { axios.defaults.baseURL = ‘https://www.ceshi.com‘;//测试地址 } else if (process.env.NODE_ENV == ‘production‘) { axios.defaults.baseURL = ‘https://www.production.com‘;//生产地址 }
设置请求超时:【通过axios.defaults.timeout设置默认的请求超时时间。例如超过了10s,就会告知用户当前请求超时,请刷新等。】
axios.defaults.timeout = 10000;
post请求头的设置:【post请求的时候,我们需要加上一个请求头,所以可以在这里进行一个默认的设置,即设置post的请求头为application/x-www-form-urlencoded;charset=UTF-8
】
axios.defaults.headers.post[‘Content-Type‘] = ‘application/x-www-form-urlencoded;charset=UTF-8‘;
请求拦截:
我们在发送请求前可以进行一个请求的拦截,为什么要拦截呢,我们拦截请求是用来做什么的呢?比如,有些请求是需要用户登录之后才能访问的,或者post请求的时候,我们需要序列化我们提交的数据。这时候,我们可以在请求被发送之前进行一个拦截,从而进行我们想要的操作。
//先导入vuex,因为我们要使用到里面的状态对象 //vuex的路径根据自己的路径去写 import store from ‘@/store/index‘; //请求拦截器 axios.interceptors.request.use( config => { // 每次发送请求之前判断vuex中是否存在token // 如果存在,则统一在http请求的header都加上token,这样后台根据token判断你的登录情况 // 即使本地存在token,也有可能token是过期的,所以在响应拦截器中要对返回状态进行判断 const token = store.state.token; token && (config.headers.Authorization = token); return config; }, err => { return Promise.error(error); } )
// 响应拦截器 axios.interceptors.response.use( response => { // 如果返回的状态码为200,说明接口请求成功,可以正常拿到数据 // 否则的话抛出错误 if (response.status === 200) { return Promise.resolve(response); } else { return Promise.reject(response); } }, // 服务器状态码不是2开头的的情况 // 这里可以跟你们的后台开发人员协商好统一的错误状态码 // 然后根据返回的状态码进行一些操作,例如登录过期提示,错误提示等等 // 下面列举几个常见的操作,其他需求可自行扩展 error => { if (error.response.status) { switch (error.response.status) { // 401: 未登录 // 未登录则跳转登录页面,并携带当前页面的路径 // 在登录成功后返回当前页面,这一步需要在登录页操作。 case 401: router.replace({ path: ‘/login‘, query: { redirect: router.currentRoute.fullPath } }); break; // 403 token过期 // 登录过期对用户进行提示 // 清除本地token和清空vuex中token对象 // 跳转登录页面 case 403: Toast({ message: ‘登录过期,请重新登录‘, duration: 1000, forbidClick: true }); // 清除token localStorage.removeItem(‘token‘); store.commit(‘loginSuccess‘, null); // 跳转登录页面,并将要浏览的页面fullPath传过去,登录成功后跳转需要访问的页面 setTimeout(() => { router.replace({ path: ‘/login‘, query: { redirect: router.currentRoute.fullPath } }); }, 1000); break; // 404请求不存在 case 404: Toast({ message: ‘网络请求不存在‘, duration: 1500, forbidClick: true }); break; // 其他错误,直接抛出错误提示 default: Toast({ message: error.response.data.message, duration: 1500, forbidClick: true }); } return Promise.reject(error.response); } } });
/** * get方法,对应get请求 * @param {String} url [请求的url地址] * @param {Object} params [请求时携带的参数] */ export function get(url, params){ return new Promise((resolve, reject) =>{ axios.get(url, { params: params }).then(res => { resolve(res.data); }).catch(err =>{ reject(err.data) }) });}
post方法:【
】
** * post方法,对应post请求 * @param {String} url [请求的url地址] * @param {Object} params [请求时携带的参数] */ export function post(url, params) { return new Promise((resolve, reject) => { axios.post(url, QS.stringify(params)) .then(res => { resolve(res.data); }) .catch(err =>{ reject(err.data) }) }); }
完整的axios封装
/**axios封装 * 请求拦截、相应拦截、错误统一处理 */ import axios from ‘axios‘;import QS from ‘qs‘; import { Toast } from ‘vant‘; import store from ‘../store/index‘ // 环境的切换 if (process.env.NODE_ENV == ‘development‘) { axios.defaults.baseURL = ‘/api‘; } else if (process.env.NODE_ENV == ‘debug‘) { axios.defaults.baseURL = ‘‘; } else if (process.env.NODE_ENV == ‘production‘) { axios.defaults.baseURL = ‘http://api.123dailu.com/‘; } // 请求超时时间 axios.defaults.timeout = 10000; // post请求头 axios.defaults.headers.post[‘Content-Type‘] = ‘application/x-www-form-urlencoded;charset=UTF-8‘; // 请求拦截器 axios.interceptors.request.use( config => { // 每次发送请求之前判断是否存在token,如果存在,则统一在http请求的header都加上token,不用每次请求都手动添加了 // 即使本地存在token,也有可能token是过期的,所以在响应拦截器中要对返回状态进行判断 const token = store.state.token; token && (config.headers.Authorization = token); return config; }, error => { return Promise.error(error); }) // 响应拦截器 axios.interceptors.response.use( response => { if (response.status === 200) { return Promise.resolve(response); } else { return Promise.reject(response); } }, // 服务器状态码不是200的情况 error => { if (error.response.status) { switch (error.response.status) { // 401: 未登录 // 未登录则跳转登录页面,并携带当前页面的路径 // 在登录成功后返回当前页面,这一步需要在登录页操作。 case 401: router.replace({ path: ‘/login‘, query: { redirect: router.currentRoute.fullPath } }); break; // 403 token过期 // 登录过期对用户进行提示 // 清除本地token和清空vuex中token对象 // 跳转登录页面 case 403: Toast({ message: ‘登录过期,请重新登录‘, duration: 1000, forbidClick: true }); // 清除token localStorage.removeItem(‘token‘); store.commit(‘loginSuccess‘, null); // 跳转登录页面,并将要浏览的页面fullPath传过去,登录成功后跳转需要访问的页面 setTimeout(() => { router.replace({ path: ‘/login‘, query: { redirect: router.currentRoute.fullPath } }); }, 1000); break; // 404请求不存在 case 404: Toast({ message: ‘网络请求不存在‘, duration: 1500, forbidClick: true }); break; // 其他错误,直接抛出错误提示 default: Toast({ message: error.response.data.message, duration: 1500, forbidClick: true }); } return Promise.reject(error.response); } } ); /** * get方法,对应get请求 * @param {String} url [请求的url地址] * @param {Object} params [请求时携带的参数] */ export function get(url, params){ return new Promise((resolve, reject) =>{ axios.get(url, { params: params }) .then(res => { resolve(res.data); }) .catch(err => { reject(err.data) }) }); } /** * post方法,对应post请求 * @param {String} url [请求的url地址] * @param {Object} params [请求时携带的参数] */ export function post(url, params) { return new Promise((resolve, reject) => { axios.post(url, QS.stringify(params)) .then(res => { resolve(res.data); }) .catch(err => { reject(err.data) }) }); }
原文:https://www.cnblogs.com/miaoLAY/p/11578865.html