axios封装总结以及拦截重复提交设置

项目采用vue-cli脚手架，在src文件夹内新建request文件夹，新建http.js。

1.工程目录如下：

2.实例axios

安装axios后，在http.js中：

（1）引入axios：

import axios from "axios";
import store from "../store/index";//vuex中存储登录token

（2）状态码处理方法：

/**
 * 请求失败后的错误统一处理
 * @param {Number} status 请求失败的状态码
 */
const errorHandle = (status, other) => {
  // 状态码判断
  switch (status) {
    // 401: 未登录状态，跳转登录页
    case 401:
      toLogin();
      break;
    // 403 token过期
    // 清除token并跳转登录页
    case 403:
      alertError("登录过期，请重新登录");
      removeStore("token");
      store.commit("loginSuccess", null);
      setTimeout(() => {
        toLogin();
      }, 1000);
      break;
    // 404请求不存在
    case 404:
      alertError("请求的资源不存在");
      break;
    default:
      console.log(other);
  }
};

（3）创建axios实例：

// 创建axios实例
var instance = axios.create({ timeout: 1000 * 300 });
// 设置post请求头
instance.defaults.headers.post["Content-Type"] =
  "application/x-www-form-urlencoded";

（4）请求拦截器：

/**
 * 请求拦截器
 * 每次请求前，如果存在token则在请求头中携带token
 */

instance.interceptors.request.use(
  config => {
    
      // 登录流程控制中，根据本地是否存在token判断用户的登录情况
      // 但是即使token存在，也有可能token是过期的，所以在每次的请求头中携带token
      // 后台根据携带的token判断用户的登录情况，并返回给我们对应的状态码
      // 而后我们可以在响应拦截器中，根据状态码进行一些统一的操作。
      const token = store.state.token;
      token && (config.headers.Authorization = token);
   
    return config;
  },
  error => Promise.error(error)
);

（5）响应拦截器：

// 响应拦截器
instance.interceptors.response.use(
  // 请求成功
  response => {
    hideLoading(); //关闭加载
    return response.status === 200
      ? Promise.resolve(response)
      : Promise.reject(response);
  },
  // 请求失败
  error => {
    hideLoading(); //关闭加载
   
    const { response } = error;
    if (response) {
      // 请求已发出，但是不在2xx的范围
      errorHandle(response.status, response.data.message);
      return Promise.reject(response);
    } else {
      // 处理断网的情况
      // eg:请求超时或断网时，更新state的network状态
      // network状态在app.vue中控制着一个全局的断网提示组件的显示隐藏
      // 关于断网组件中的刷新重新获取数据，会在断网组件中说明
      if (!window.navigator.onLine) {
        store.commit("changeNetwork", false);
      } else {
        return Promise.reject(error);
      }
    }
  }
);

（6）抛出模块：

export default instance;

3.使用axios实例

完成对axios示例的创建之后，需要使用axios的地方将刚刚建好的模块import过来。项目管理中会对接口统一管理，即在src文件夹目录中新建apis文件夹统一管理接口调用。举例：

arc/apis/apiHome.js

import axios from "@/request/http"; // 导入http中创建的axios实例

import qs from "qs"; // 根据需求是否导入qs模块
const baseUrl = ""; // 接口公共部分
const apiHome= {
  // post提交
  login(params) {
    return axios.post(`${baseUrl}/accesstoken`, qs.stringify(params));
  },
  // get提交
  articleDetail(id, params) {
    return axios.get(`${baseUrl}/topic/${id}`, {
      params: params
    });
  },
}

export default apiHome;

接口调用处引入即可。

如果需要防重复提交，做如下修改：

在axios请求拦截处将即将请求的接口与正在请求的接口做对比，若有相同请求则return。

具体实现如下：

建立数组存储请求列表，在请求拦截处push进数组，请求完成后移出数组：

/**
 * axios封装
 * 请求拦截、响应拦截、错误统一处理
 */
import axios from "axios";
import router from "../router";
import store from "../store/index";

import {
  showLoading,
  hideLoading,
  alertError,
  removeStore
} from "../utils/mUtil";

// 请求列表(防重复提交)
let requestList = [];
let jlist = [
  "/item-restBase/commodity/getTotalByCateGoryId",
  "/back/rest/v1/selectAllAbilityCategory",
  "/item-restBase/commodity/list"
];
let cancelToken = axios.CancelToken;

/**
 * 跳转登录页
 * 携带当前页面路由，以期在登录页面完成登录后返回当前页面
 */
const toLogin = () => {
  router.replace({
    path: "/login",
    query: {
      redirect: router.currentRoute.fullPath
    }
  });
};

/**
 * 请求失败后的错误统一处理
 * @param {Number} status 请求失败的状态码
 */
const errorHandle = (status, other) => {
  // 状态码判断
  switch (status) {
    // 401: 未登录状态，跳转登录页
    case 401:
      toLogin();
      break;
    // 403 token过期
    // 清除token并跳转登录页
    case 403:
      alertError("登录过期，请重新登录");
      removeStore("token");
      store.commit("loginSuccess", null);
      setTimeout(() => {
        toLogin();
      }, 1000);
      break;
    // 404请求不存在
    case 404:
      alertError("请求的资源不存在");
      break;
    default:
      console.log(other);
  }
};

// 创建axios实例
var instance = axios.create({ timeout: 1000 * 300 });
// 设置post请求头
instance.defaults.headers.post["Content-Type"] =
  "application/x-www-form-urlencoded";
/**
 * 请求拦截器
 * 每次请求前，如果存在token则在请求头中携带token
 */

instance.interceptors.request.use(
  config => {
    //防止重复提交（如果本次是重复操作，则取消，否则将该操作标记到requestList中）
    config.cancelToken = new cancelToken(cancel => {
      let requestFlag =
        JSON.stringify(config.url) +
        JSON.stringify(config.data) +
        "&" +
        config.method;
      if (!jlist.includes(config.url)) {
        if (requestList.includes(requestFlag)) {
          //请求标记已经存在，则取消本次请求，否则在请求列表中加入请求标记
          cancel(); //取消本次请求
        } else {
          requestList.push(requestFlag);
          showLoading(); //显示加载中
        }
      } else {
        showLoading(); //显示加载中
      }

      // 登录流程控制中，根据本地是否存在token判断用户的登录情况
      // 但是即使token存在，也有可能token是过期的，所以在每次的请求头中携带token
      // 后台根据携带的token判断用户的登录情况，并返回给我们对应的状态码
      // 而后我们可以在响应拦截器中，根据状态码进行一些统一的操作。
      const token = store.state.token;
      token && (config.headers.Authorization = token);
    });
    return config;
  },
  error => Promise.error(error)
);

// 响应拦截器
instance.interceptors.response.use(
  // 请求成功
  response => {
    hideLoading(); //关闭加载
    //请求返回后，将请求标记从requestList中移除
    let requestFlag =
      JSON.stringify(response.config.url) +
      JSON.stringify(response.config.data) +
      "&" +
      response.config.method;
    requestList.splice(
      requestList.findIndex(item => item === requestFlag),
      1
    );
    return response.status === 200
      ? Promise.resolve(response)
      : Promise.reject(response);
    // return response;
  },
  // 请求失败
  error => {
    hideLoading(); //关闭加载
    //置空请求列表
    requestList.length = 0;
    const { response } = error;
    if (response) {
      // 请求已发出，但是不在2xx的范围
      errorHandle(response.status, response.data.message);
      return Promise.reject(response);
    } else {
      // 处理断网的情况
      // eg:请求超时或断网时，更新state的network状态
      // network状态在app.vue中控制着一个全局的断网提示组件的显示隐藏
      // 关于断网组件中的刷新重新获取数据，会在断网组件中说明
      if (!window.navigator.onLine) {
        store.commit("changeNetwork", false);
      } else {
        return Promise.reject(error);
      }
    }
  }
);

export default instance;