乐趣区

axios基于常见业务场景的二次封装更新

jiezi

时隔一年再次更新下根据 vue 项目下常见业务场景对 axios 的二次封装

功能实现：
1. 兼容 ie 浏览器避免缓存
2. 减少或更新重复请求
3. 接口域名使用环境变量
4. 全局 loading 状态
5. 可关闭的全局错误提醒
6. 可开启携带全局分页参数
7…

拦截器 

/**
 * 请求拦截器
 * @param  {} requestStart 请求开始
 */
service.interceptors.request.use(
  config => {requestStart({ config});
    return config;
  },
  error => {Message.error("请求出错");
    Promise.reject(error);
  }
);
/**
 * 响应拦截器
 * @param  {} requestEnd 1. 请求结束
 * @param  {} responseResolve 2. 请求错误处理
 */
service.interceptors.response.use(
  response => {const { status, data, config} = response;
    requestEnd({config, data});
    return responseResolve({status, data, config});
  },
  error => {if (axios.isCancel(error)) {Message.warning("网络请求中，请不要重复操作！");
    } else {const { response} = error;
      Message.error({
        dangerouslyUseHTMLString: true,
        message: `<p> 请求接口: ${response.config.url}</p><p> 请求方法 : ${response.config.method}</p><p> 响应状态 : ${response.status}</p><p> 响应信息 : ${response.statusText}</p>`
      });
    }
    store.commit("setLoading", false);
    store.commit("setPageTotal", 0);
    return Promise.reject(error);
  }
);

请求开始

  1. 处理请求头
  2. 处理请求参数
  3. 处理重复请求 
/**
 * 请求开始 &&loading=true
 * @param  {} requestHeaders 请求头
 * @param  {} requestParams 请求参数
 * @param  {} removePending 重复请求
 */
const requestStart = ({config} = {}) => {requestHeaders({ config});
  requestParams({config});
  removePending({config});
  addPending({config});
  store.commit("setLoading", true);
};

请求响应

  • 全局错误提醒，在需要前端自定义提醒的场景下可关闭 
/**
 * @param  {} {status HTTP 状态码
 * @param  {} data 响应体
 * @param  {} config}={} AxiosRequestConfig
 */
const responseResolve = ({status, data, config} = {}) => {const { code, text} = data;
  if (status === 200) {switch (code) {
      case 200:
        return Promise.resolve(data);
      case 900401:
        Message.error(text || "登录超时，请重新登录！");
        window.location.href = process.env.VUE_APP_AUTH_URL;
        return Promise.reject(data);
      default:
        // 可配置错误提醒
        if (!config.headers["hide-message"]) {Message.error(text || "操作失败！");
        }
        return Promise.reject(data);
    }
  } else {Message.error(text || "操作失败！");
    store.commit("setLoading", false);
    return Promise.reject(data);
  }
};

请求结束

  1. 处理重复请求
  2. 处理分页
  3. 处理 loading 状态 
/**
 * 请求结束 &&loading=false
 * @param  {} {config}={} AxiosRequestConfig
 * @param  {} {config}={} response body
 */
const requestEnd = ({config, data} = {}) => {removePending({ config});
  store.commit("setLoading", false);
  // 配置分页
  if (config.headers.pagination) {const { data: content} = data;
    if (content) {store.commit("setPageTotal", content.total);
    }
  }
};

以下为具体功能实现

请求头预处理

  • 时间戳：避免 ie 内核浏览器缓存
  • token
/**
 * 请求头预处理
 * @param  {} {config} AxiosRequestConfig
 */
const requestHeaders = ({config}) => {
  //1. 时间戳
  const timestamp = new Date().getTime();
  config.headers.timestamp = timestamp;
  //2.token
  const token = sessionStorage.getItem("token");
  if (token) {config.headers.token = token;}
};

请求参数预处理

  • 可配置的全局分页参数，提供给需要用到全局分页组件的列表请求使用 
/**
 * 请求参数预处理
 * @param  {} {config}={} AxiosRequestConfig
 */
const requestParams = ({config} = {}) => {
  // 配置分页
  if (config.headers.pagination) {const { pageNum, pageSize} = store.getters.getPagination;
    config.data = Object.assign({}, config.data, {
      pageNum,
      pageSize
    });
  }
};

处理重复请求

  • 此处根据需要可以改为取消上一次的请求 
/**
 * 处理重复请求
 * @param  {} {config}={} AxiosRequestConfig
 */
const addPending = ({config}) => {
  const url =
    config.url + "&" + config.method + "&" + qs.stringify(config.data);
  config.cancelToken = new cancelToken(cancel => {if (!pending.some(item => item.url === url)) {
      pending.push({
        url,
        cancel
      });
    }
  });
};
const removePending = ({config}) => {
  const url =
    config.url + "&" + config.method + "&" + qs.stringify(config.data);
  pending.forEach((item, index) => {if (item.url === url) {item.cancel("取消重复请求:" + config.url);
      pending.splice(index, 1);
    }
  });
};

完整代码 

import {Message} from "element-ui";
import axios from "axios";
import store from "../store/index";
const qs = require("qs");

const service = axios.create({
  baseURL: process.env.VUE_APP_BASE_API,
  timeout: 100000
});

const pending = [];
const cancelToken = axios.CancelToken;

/**
 * 处理重复请求
 * @param  {} {config}={} AxiosRequestConfig
 */
const addPending = ({config}) => {
  const url =
    config.url + "&" + config.method + "&" + qs.stringify(config.data);
  config.cancelToken = new cancelToken(cancel => {if (!pending.some(item => item.url === url)) {
      pending.push({
        url,
        cancel
      });
    }
  });
};
const removePending = ({config}) => {
  const url =
    config.url + "&" + config.method + "&" + qs.stringify(config.data);
  pending.forEach((item, index) => {if (item.url === url) {item.cancel("取消重复请求:" + config.url);
      pending.splice(index, 1);
    }
  });
};
/**
 * 请求头预处理
 * @param  {} {config} AxiosRequestConfig
 */
const requestHeaders = ({config}) => {
  //1. 时间戳
  const timestamp = new Date().getTime();
  config.headers.timestamp = timestamp;
  //2.token
  const token = sessionStorage.getItem("token");
  if (token) {config.headers.token = token;}
};
/**
 * 请求参数预处理
 * @param  {} {config}={} AxiosRequestConfig
 */
const requestParams = ({config} = {}) => {
  // 配置分页
  if (config.headers.pagination) {const { pageNum, pageSize} = store.getters.getPagination;
    config.data = Object.assign({}, config.data, {
      pageNum,
      pageSize
    });
  }
};
/**
 * 请求开始 &&loading=true
 * @param  {} requestHeaders 1. 配置请求头
 * @param  {} requestParams 2. 配置请求体
 * @param  {} removePending 3. 处理重复请求
 */
const requestStart = ({config} = {}) => {requestHeaders({ config});
  requestParams({config});
  removePending({config});
  addPending({config});
  store.commit("setLoading", true);
};
/**
 * 请求结束 &&loading=false
 * @param  {} {config}={} AxiosRequestConfig
 * @param  {} {config}={} response body
 */
const requestEnd = ({config, data} = {}) => {removePending({ config});
  store.commit("setLoading", false);
  // 配置分页
  if (config.headers.pagination) {const { data: content} = data;
    if (content) {store.commit("setPageTotal", content.total);
    }
  }
};
/**
 * @param  {} {status HTTP 状态码
 * @param  {} data 响应体
 * @param  {} config}={} AxiosRequestConfig
 */
const responseResolve = ({status, data, config} = {}) => {const { code, text} = data;
  if (status === 200) {switch (code) {
      case 200:
        return Promise.resolve(data);
      case 900401:
        Message.error(text || "登录超时，请重新登录！");
        window.location.href = process.env.VUE_APP_AUTH_URL;
        return Promise.reject(data);
      default:
        // 可配置错误提醒
        if (!config.headers["hide-message"]) {Message.error(text || "操作失败！");
        }
        return Promise.reject(data);
    }
  } else {Message.error(text || "操作失败！");
    store.commit("setLoading", false);
    return Promise.reject(data);
  }
};
/**
 * 请求拦截器
 * @param  {} requestStart 请求开始
 */
service.interceptors.request.use(
  config => {requestStart({ config});
    return config;
  },
  error => {Message.error("请求出错");
    Promise.reject(error);
  }
);
/**
 * 响应拦截器
 * @param  {} requestEnd 1. 请求结束
 * @param  {} responseResolve 2. 请求错误处理
 */
service.interceptors.response.use(
  response => {const { status, data, config} = response;
    requestEnd({config, data});
    return responseResolve({status, data, config});
  },
  error => {if (axios.isCancel(error)) {Message.warning("网络请求中，请不要重复操作！");
    } else {const { response} = error;
      Message.error({
        dangerouslyUseHTMLString: true,
        message: `<p> 请求接口: ${response.config.url}</p><p> 请求方法 : ${response.config.method}</p><p> 响应状态 : ${response.status}</p><p> 响应信息 : ${response.statusText}</p>`
      });
    }
    store.commit("setLoading", false);
    store.commit("setPageTotal", 0);
    return Promise.reject(error);
  }
);

export default service;
退出移动版