vue中Axios的封装

·  阅读 328

在项目中使用axios来作为和后台的数据交互,那往往需要根据自己的需要来对axios做一些定制化的封装,也便于项目的后期更新维护。我们所使用的axios库是基于promise的http库。拥有很多的特性,如拦截请求和响应、取消请求、转换json等,所以这也是它可以代替原先vue-resource的原因

1.安装

npm install axios;
复制代码

2.引入

可以选择在src下建一个axios.js,用于封装我们的axios(当然这个可以自己选择,只要做到正确引入即可)

// 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的前面。这在项目开发过程中可以显得很高效。

// 环境的切换
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,就会给用户反馈,告知用户当前请求超时,请重新刷新等

5.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';
复制代码

6.请求拦截

我们在发送请求前可以进行一个请求的拦截,拦截的意义在哪里呢,我们拦截请求是用来做什么的呢?比如,有些请求是需要用户登录之后才能访问的,或者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;    
    },    
    error => {        
        return Promise.error(error);    
})
复制代码

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

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,则正常返回数据,否则的根据错误的状态码类型进行一些我们需要的错误,其实这里主要就是进行了错误的统一处理和没登录或登录过期后调整登录页的一个操作。

通过对axios的封装,可以使我们对每一个请求有更多的控制,并且可以针对不同的情况进行不一样的配置处理,显得更加的灵活