Vue 项目中对 Axios 的二次封装

Question

近来在使用 Vue 重构公司 m 站时，使用了 axios 来进行数据的请求，由于项目的需要，对 axios 进行了二次封装，点击进入 axios

//引入axios import axios from 'axios' 
let cancel ,promiseArr = {}
const CancelToken = axios.CancelToken;
//请求拦截器
axios.interceptors.request.use(config => {
    //发起请求时，取消掉当前正在进行的相同请求 if (promiseArr[config.url]) {
        promiseArr[config.url]('操作取消')
        promiseArr[config.url] = cancel
    } else {
        promiseArr[config.url] = cancel
    }
      return config
}, error => {
    return Promise.reject(error)
})

//响应拦截器
axios.interceptors.response.use(response => {
    return response
}, error => {
    return Promise.resolve(error.response)
})

axios.defaults.baseURL = '/api' //设置默认请求头
axios.defaults.headers = {
    'X-Requested-With': 'XMLHttpRequest'
}
axios.defaults.timeout = 10000 export default {
  //get请求
    get (url,param) {
      return new Promise((resolve,reject) => {
        axios({
          method: 'get',
          url,
          params: param,
          cancelToken: new CancelToken(c => {
            cancel = c
          })
        }).then(res => {
          resolve(res)
        })
      })
    },
  //post请求
    post (url,param) {
      return new Promise((resolve,reject) => {
        axios({
          method: 'post',
          url,
          data: param,
          cancelToken: new CancelToken(c => {
            cancel = c
          })
        }).then(res => {
          resolve(res)
        })
      })
     }
  }

说明

为防止发起请求时，当前正在进行的相同请求，在请求拦截器中加入了 hash 判断，将相同请求 url 拦截

将 axios 中 get，post 公共配置抽离出来 axios.defaults.baseURL = '/api'

// 设置默认请求头
axios.defaults.headers = { 'X-Requested-With': 'XMLHttpRequest' }
axios.defaults.timeout = 10000

get，post 请求的封装

可能你会问，这里的 axios 返回的就是 promise 对象，为什么还要再次对 get、post 封装一次 promise，因为我这边的话，在开发中使用 async await 会出现数据请求失败的情况，报的错就是返回的不是 promise 对象。（可 async await 返回的就是 promise 呀，这个问题后续再搞一下）就直接 return 了一个 promise 对象，以避免上面的错误。下面是请求接口的一个例子

import req from '../api/requestType'
/**
拼团详情
*/
export const groupDetail = param => {
return req.get('/RestHome/GroupDetail',param)
}

下面是数据的获取

async getData() {
    const params = {
        TopCataID: 0,
        pageNumber: this.pageNumber,
        pageSize: this.pageSize
    }
    const res = await groupList(params)
},

到这里我们就简单的封装了一下适合自己项目的 axios

//请求失败后的统一拦截，以及ajax的基本设置
import axios from 'axios';
import qs from 'qs';
import Bus from './BUS';

function cleanRequest(req) {
  for (const i in req) {
    /* eslint guard-for-in: 0 */
    if (req[i] !== 0 && !req[i]) {
      delete req[i];
    }
  }
}

axios.defaults.withCredentials = true;
axios.defaults.xsrfCookieName = null;
axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest';
axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
//系统弹层
import Toast from 'mint-ui/lib/toast';
import 'mint-ui/lib/toast/style.css';

module.exports.install = function (Vue) {
  axios.defaults.baseURL="/";
  Vue.prototype.$http = axios;
  Vue.http = axios;

  axios.interceptors.request.use(
    function (request) {
      const params = request.params;
      if (params) {
        cleanRequest(params);
      }
      if (request.data) {
        cleanRequest(request.data);
        request.data=qs.stringify(Object.assign(request.data,Bus.Config))
      }else{
        request.data=qs.stringify(Bus.movieConfig)
      }
      return request;
    },
    function (error) {
      return Promise.reject(error);
    }
  );

  // Add a response interceptor
  axios.interceptors.response.use(
    function (response) {

      return response;
    },
    function (error) {
      Toast('系统繁忙，请稍后重试!');
      // Do something with response error
      return Promise.reject(error);
    }
  );
};