axios基于常見(jiàn)業(yè)務(wù)場(chǎng)景的二次封裝(更新)

dailybird 發(fā)布于2019-08-26 10:20 / 526人閱讀

摘要：時(shí)隔一年再次更新下根據(jù)項(xiàng)目下常見(jiàn)業(yè)務(wù)場(chǎng)景對(duì)的二次封裝功能實(shí)現(xiàn)兼容瀏覽器避免緩存減少或更新重復(fù)請(qǐng)求接口域名使用環(huán)境變量全局狀態(tài)可關(guān)閉的全局錯(cuò)誤提醒可開(kāi)啟攜帶全局分頁(yè)參數(shù)攔截器請(qǐng)求攔截器請(qǐng)求開(kāi)始請(qǐng)求出錯(cuò)響應(yīng)攔截器請(qǐng)求結(jié)束請(qǐng)求錯(cuò)誤處理網(wǎng)絡(luò)請(qǐng)求中，

時(shí)隔一年再次更新下根據(jù)vue項(xiàng)目下常見(jiàn)業(yè)務(wù)場(chǎng)景對(duì)axios的二次封裝

功能實(shí)現(xiàn)：
1.兼容ie瀏覽器避免緩存
2.減少或更新重復(fù)請(qǐng)求
3.接口域名使用環(huán)境變量
4.全局loading狀態(tài)
5.可關(guān)閉的全局錯(cuò)誤提醒
6.可開(kāi)啟攜帶全局分頁(yè)參數(shù)
7...

攔截器

/**
 * 請(qǐng)求攔截器
 * @param  {} requestStart 請(qǐng)求開(kāi)始
 */
service.interceptors.request.use(
  config => {
    requestStart({ config });
    return config;
  },
  error => {
    Message.error("請(qǐng)求出錯(cuò)");
    Promise.reject(error);
  }
);
/**
 * 響應(yīng)攔截器
 * @param  {} requestEnd 1.請(qǐng)求結(jié)束
 * @param  {} responseResolve 2.請(qǐng)求錯(cuò)誤處理
 */
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("網(wǎng)絡(luò)請(qǐng)求中，請(qǐng)不要重復(fù)操作！");
    } else {
      const { response } = error;
      Message.error({
        dangerouslyUseHTMLString: true,
        message: `請(qǐng)求接口: ${
          response.config.url
        }
請(qǐng)求方法 : ${
          response.config.method
        }
響應(yīng)狀態(tài) : ${response.status}
響應(yīng)信息 : ${
          response.statusText
        }`
      });
    }
    store.commit("setLoading", false);
    store.commit("setPageTotal", 0);
    return Promise.reject(error);
  }
);

請(qǐng)求開(kāi)始

處理請(qǐng)求頭

處理請(qǐng)求參數(shù)

處理重復(fù)請(qǐng)求

/**
 * 請(qǐng)求開(kāi)始&&loading=true
 * @param  {} requestHeaders 請(qǐng)求頭
 * @param  {} requestParams 請(qǐng)求參數(shù)
 * @param  {} removePending 重復(fù)請(qǐng)求
 */
const requestStart = ({ config } = {}) => {
  requestHeaders({ config });
  requestParams({ config });
  removePending({ config });
  addPending({ config });
  store.commit("setLoading", true);
};

請(qǐng)求響應(yīng)

全局錯(cuò)誤提醒，在需要前端自定義提醒的場(chǎng)景下可關(guān)閉

/**
 * @param  {} {status HTTP狀態(tài)碼
 * @param  {} data 響應(yīng)體
 * @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 || "登錄超時(shí)，請(qǐng)重新登錄！");
        window.location.href = process.env.VUE_APP_AUTH_URL;
        return Promise.reject(data);
      default:
        //可配置錯(cuò)誤提醒
        if (!config.headers["hide-message"]) {
          Message.error(text || "操作失敗！");
        }
        return Promise.reject(data);
    }
  } else {
    Message.error(text || "操作失??！");
    store.commit("setLoading", false);
    return Promise.reject(data);
  }
};

請(qǐng)求結(jié)束

處理重復(fù)請(qǐng)求

處理分頁(yè)

處理loading狀態(tài)

/**
 * 請(qǐng)求結(jié)束&&loading=false
 * @param  {} {config}={} AxiosRequestConfig
 * @param  {} {config}={} response body
 */
const requestEnd = ({ config, data } = {}) => {
  removePending({ config });
  store.commit("setLoading", false);
  //配置分頁(yè)
  if (config.headers.pagination) {
    const { data: content } = data;
    if (content) {
      store.commit("setPageTotal", content.total);
    }
  }
};

以下為具體功能實(shí)現(xiàn) 請(qǐng)求頭預(yù)處理

時(shí)間戳：避免ie內(nèi)核瀏覽器緩存

token

/**
 * 請(qǐng)求頭預(yù)處理
 * @param  {} {config} AxiosRequestConfig
 */
const requestHeaders = ({ config }) => {
  //1.時(shí)間戳
  const timestamp = new Date().getTime();
  config.headers.timestamp = timestamp;
  //2.token
  const token = sessionStorage.getItem("token");
  if (token) {
    config.headers.token = token;
  }
};

請(qǐng)求參數(shù)預(yù)處理

可配置的全局分頁(yè)參數(shù)，提供給需要用到全局分頁(yè)組件的列表請(qǐng)求使用

/**
 * 請(qǐng)求參數(shù)預(yù)處理
 * @param  {} {config}={} AxiosRequestConfig
 */
const requestParams = ({ config } = {}) => {
  //配置分頁(yè)
  if (config.headers.pagination) {
    const { pageNum, pageSize } = store.getters.getPagination;
    config.data = Object.assign({}, config.data, {
      pageNum,
      pageSize
    });
  }
};

處理重復(fù)請(qǐng)求

此處根據(jù)需要可以改為取消上一次的請(qǐng)求

/**
 * 處理重復(fù)請(qǐng)求
 * @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("取消重復(fù)請(qǐng)求:" + 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;

/**
 * 處理重復(fù)請(qǐng)求
 * @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("取消重復(fù)請(qǐng)求:" + config.url);
      pending.splice(index, 1);
    }
  });
};
/**
 * 請(qǐng)求頭預(yù)處理
 * @param  {} {config} AxiosRequestConfig
 */
const requestHeaders = ({ config }) => {
  //1.時(shí)間戳
  const timestamp = new Date().getTime();
  config.headers.timestamp = timestamp;
  //2.token
  const token = sessionStorage.getItem("token");
  if (token) {
    config.headers.token = token;
  }
};
/**
 * 請(qǐng)求參數(shù)預(yù)處理
 * @param  {} {config}={} AxiosRequestConfig
 */
const requestParams = ({ config } = {}) => {
  //配置分頁(yè)
  if (config.headers.pagination) {
    const { pageNum, pageSize } = store.getters.getPagination;
    config.data = Object.assign({}, config.data, {
      pageNum,
      pageSize
    });
  }
};
/**
 * 請(qǐng)求開(kāi)始&&loading=true
 * @param  {} requestHeaders 1.配置請(qǐng)求頭
 * @param  {} requestParams 2.配置請(qǐng)求體
 * @param  {} removePending 3.處理重復(fù)請(qǐng)求
 */
const requestStart = ({ config } = {}) => {
  requestHeaders({ config });
  requestParams({ config });
  removePending({ config });
  addPending({ config });
  store.commit("setLoading", true);
};
/**
 * 請(qǐng)求結(jié)束&&loading=false
 * @param  {} {config}={} AxiosRequestConfig
 * @param  {} {config}={} response body
 */
const requestEnd = ({ config, data } = {}) => {
  removePending({ config });
  store.commit("setLoading", false);
  //配置分頁(yè)
  if (config.headers.pagination) {
    const { data: content } = data;
    if (content) {
      store.commit("setPageTotal", content.total);
    }
  }
};
/**
 * @param  {} {status HTTP狀態(tài)碼
 * @param  {} data 響應(yīng)體
 * @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 || "登錄超時(shí)，請(qǐng)重新登錄！");
        window.location.href = process.env.VUE_APP_AUTH_URL;
        return Promise.reject(data);
      default:
        //可配置錯(cuò)誤提醒
        if (!config.headers["hide-message"]) {
          Message.error(text || "操作失?。?);
        }
        return Promise.reject(data);
    }
  } else {
    Message.error(text || "操作失??！");
    store.commit("setLoading", false);
    return Promise.reject(data);
  }
};
/**
 * 請(qǐng)求攔截器
 * @param  {} requestStart 請(qǐng)求開(kāi)始
 */
service.interceptors.request.use(
  config => {
    requestStart({ config });
    return config;
  },
  error => {
    Message.error("請(qǐng)求出錯(cuò)");
    Promise.reject(error);
  }
);
/**
 * 響應(yīng)攔截器
 * @param  {} requestEnd 1.請(qǐng)求結(jié)束
 * @param  {} responseResolve 2.請(qǐng)求錯(cuò)誤處理
 */
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("網(wǎng)絡(luò)請(qǐng)求中，請(qǐng)不要重復(fù)操作！");
    } else {
      const { response } = error;
      Message.error({
        dangerouslyUseHTMLString: true,
        message: `請(qǐng)求接口: ${
          response.config.url
        }
請(qǐng)求方法 : ${
          response.config.method
        }
響應(yīng)狀態(tài) : ${response.status}
響應(yīng)信息 : ${
          response.statusText
        }`
      });
    }
    store.commit("setLoading", false);
    store.commit("setPageTotal", 0);
    return Promise.reject(error);
  }
);

export default service;

GPU云服務(wù)器云服務(wù)器視頻服務(wù)器的二次開(kāi)發(fā) 二次封裝二次淺封裝實(shí)踐【附源碼】基于webrtc二次開(kāi)發(fā)

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://m.hztianpu.com/yun/106002.html

發(fā)表評(píng)論

登陸后可評(píng)論

0條評(píng)論

dailybird

男|高級(jí)講師

我要關(guān)注我要私信

TA的文章

入手萬(wàn)彩錄屏大師體驗(yàn)高清錄屏視頻輸出且自帶視頻編輯特效素材

閱讀 1794·2021-10-18 13:34
ION Cloud：$120/年/2核/2GB內(nèi)存/60GB SSD空間/3TB流量/1Gbps端口

閱讀 3982·2021-09-08 10:42
搬瓦工VPS：高端線路，助力企業(yè)運(yùn)營(yíng)，10Gbps美國(guó) cn2 gia，1Gbps香港cn2 gia

閱讀 1614·2021-09-02 09:56
sublime text3 - 打造成小程序開(kāi)發(fā)神器

閱讀 1661·2019-08-30 15:54
校招筆試 | C語(yǔ)言筆試必考系列?。?！

閱讀 3200·2019-08-29 18:44
又是一波前端知識(shí)點(diǎn)總結(jié)

閱讀 3355·2019-08-26 18:37
react-lazy-load粗讀

閱讀 2288·2019-08-26 12:13
axios基于常見(jiàn)業(yè)務(wù)場(chǎng)景的二次封裝(更新)

閱讀 527·2019-08-26 10:20

成人无码视频,亚洲精品久久久久av无码,午夜精品久久久久久毛片,亚洲中文字幕日韩无码

資訊專欄INFORMATION COLUMN

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！

axios基于常見(jiàn)業(yè)務(wù)場(chǎng)景的二次封裝(更新)

相關(guān)文章