vue中Axios的封装

时间 2019-12-01

原文原文链接

在项目中使用axios来做为和后台的数据交互，那每每须要根据本身的须要来对axios作一些定制化的封装，也便于项目的后期更新维护。咱们所使用的axios库是基于promise的http库。拥有不少的特性，如拦截请求和响应、取消请求、转换json等，因此这也是它能够代替原先vue-resource的缘由

1.安装

npm install axios;
复制代码

2.引入

能够选择在src下建一个axios.js,用于封装咱们的axios（固然这个能够本身选择，只要作到正确引入便可）javascript

// axios.js中引入axios
import axios from 'axios'; // 引入axios
import QS from 'qs'; // 引入qs模块，用来序列化post类型的数据
复制代码

3.环境的切换(环境的切换也是能够在config下的index.js里面进行配置，能够自行选择)

项目环境会有开发环境，测试环境和生产环境。咱们能够经过node的环境变量来设置咱们的默认的接口url前缀。此处的axios.defaults.baseURL能够设置axios的默认请求地址。在发送请求的时候会家在接口url的前面。这在项目开发过程当中能够显得很高效。vue

// 环境的切换
if (process.env.NODE_ENV == 'development') {    
    axios.defaults.baseURL = 'https://www.dev.com';
} else if (process.env.NODE_ENV == 'production') {    
    axios.defaults.baseURL = 'https://www.pro.com';
}
复制代码

4.设置请求超时

经过axios.defaults.timeout设置默认的请求超时时间。例如超过了10s，就会给用户反馈，告知用户当前请求超时，请从新刷新等java

5.post请求头的设置

post请求的时候，咱们须要加上一个请求头，因此能够在这里进行一个默认的设置，即设置post的请求头为application/x-www-form-urlencoded;charset=UTF-8node

axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8';
复制代码

6.请求拦截

咱们在发送请求前能够进行一个请求的拦截，拦截的意义在哪里呢，咱们拦截请求是用来作什么的呢？好比，有些请求是须要用户登陆以后才能访问的，或者post请求的时候，咱们须要序列化咱们提交的数据。这时候，咱们能够在请求被发送以前进行一个拦截，对一些必要的条件进行验证。从而进行咱们想要的操做。ios

// 先导入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;    
    },    
    error => {        
        return Promise.error(error);    
})
复制代码

此处的token是在用户登录完成以后，将用户的token经过localStorage或者cookie存在本地，而后在每次进入页面的时候（也就是在main.js中进行判断），会首先从本地存储token,若是token存在说明用户已经登录过。而后，在每次请求接口的时候，都会在请求的header中携带token，后台人员就能够根据你携带的token来判断你的登陆是否过时，若是没有携带，则说明没有登陆过vuex

7.响应拦截

// 响应拦截器
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);
        }
    }    
});
复制代码

响应拦截器很好理解，就是服务器返回给咱们的数据，咱们在拿到以前能够对他进行一些处理。例如上面的思想：若是后台返回的状态码是200，则正常返回数据，不然的根据错误的状态码类型进行一些咱们须要的错误，其实这里主要就是进行了错误的统一处理和没登陆或登陆过时后调整登陆页的一个操做。npm