快捷導(dǎo)航

十分鐘封裝一個好用的axios步驟示例

更新時間：2022年06月16日 15:43:10 作者：szqlovexyt

這篇文章主要為大家介紹了十分鐘封裝一個好用的axios步驟示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

前言

項目啟動會議上，大家各種出排期，各種出方案，大多數(shù)人的焦點都放在后端技術(shù)方案上，感情大家好像都覺得前期準(zhǔn)備工作前端沒啥好做的，不都有現(xiàn)成的腳手架嗎？別人不都幫你做好了嗎？????我丟。。。。你說的好像不是沒有道理，但是你真的用過官方的腳手架嗎，除了幫我生成項目目錄和打包編譯之類的配置，還是有些框架層面的東西要我自己做的好吧。我不管我不管，你們都有啟動準(zhǔn)備排期，我他喵的也要??！??

想想需要做什么

我爭取到了一周的準(zhǔn)備（劃水摸魚）時間，主要還是后端的大佬們牛批會爭取啊，我只能和他們持平了，啊哈哈哈。先用vue-cli生成一個project吧，想想做些什么，想到以前的做項目通用請求能力封裝這一塊前期做的不太好，導(dǎo)致后面寫起來一堆冗余代碼，著實惡心到我了。那我必須前期把這個整整????

通用能力

列一下我想要這個通用請求能達到什么樣的效果

1.正常請求該有的（跨域攜帶cookie，token，超時設(shè)置）

2.請求響應(yīng)攔截器

請求成功，業(yè)務(wù)狀態(tài)碼200，解析result給我，我不想一層一層的去判斷拿數(shù)據(jù)
http請求200，業(yè)務(wù)狀態(tài)碼非200，說明邏輯判斷這是不成功的，那就全局message提示服務(wù)端的報錯
http請求非200，說明http請求都有問題，也全局message提示報錯
http請求或者業(yè)務(wù)狀態(tài)碼401都做注銷操作

3.全局的loading配置, 默認開啟，可配置關(guān)閉（由于后端的問題，經(jīng)常會讓前端加防抖節(jié)流或者loading不讓用戶在界面上瘋狂亂點，行吧行吧，你們的問題前端幫你們解決，你的規(guī)矩就是規(guī)矩是吧??）

4.統(tǒng)一文件下載處理（不要再去各寫各的下載了，你寫一個，他寫一個，一個項目就是這樣整的跟屎一樣）

一步一步添加功能實現(xiàn)

正常請求該有的

import axios, { AxiosInstance, AxiosRequestConfig } from "axios";
export const createAxiosByinterceptors = (
  config?: AxiosRequestConfig
): AxiosInstance => {
  const instance = axios.create({
    timeout: 1000,    //超時配置
    withCredentials: true,  //跨域攜帶cookie
    ...config,   // 自定義配置覆蓋基本配置
  });
  return instance;
};

請求響應(yīng)攔截器

import axios, { AxiosInstance, AxiosRequestConfig } from "axios";
import { Message } from "element-ui";
import { jumpLogin } from "@/utils";
export const createAxiosByinterceptors = (
  config?: AxiosRequestConfig
): AxiosInstance => {
  const instance = axios.create({
    timeout: 1000,    //超時配置
    withCredentials: true,  //跨域攜帶cookie
    ...config,   // 自定義配置覆蓋基本配置
  });
  // 添加請求攔截器
  instance.interceptors.request.use(
    function (config: any) {
      // 在發(fā)送請求之前做些什么
      console.log("config:", config);
      // config.headers.Authorization = vm.$Cookies.get("vue_admin_token");
      return config;
    },
    function (error) {
      // 對請求錯誤做些什么
      return Promise.reject(error);
    }
  );
  // 添加響應(yīng)攔截器
  instance.interceptors.response.use(
    function (response) {
      // 對響應(yīng)數(shù)據(jù)做點什么
      console.log("response:", response);
      const { code, data, message } = response.data;
      if (code === 200) return data;
      else if (code === 401) {
         jumpLogin();
      } else {
         Message.error(message);
         return Promise.reject(response.data);
      }
    },
    function (error) {
      // 對響應(yīng)錯誤做點什么
      console.log("error-response:", error.response);
      console.log("error-config:", error.config);
      console.log("error-request:", error.request);
      if (error.response) {
        if (error.response.status === 401) {
          jumpLogin();
        }
      }
      Message.error(error?.response?.data?.message || "服務(wù)端異常");
      return Promise.reject(error);
    }
  );
  return instance;
};

全局的loading配置

import axios, { AxiosInstance, AxiosRequestConfig } from "axios";
import { Message } from "element-ui";
import { jumpLogin } from "@/utils";
import { Loading } from "element-ui";
import { ElLoadingComponent } from "element-ui/types/loading";
// import vm from "@/main";
let loadingInstance: ElLoadingComponent | null = null;
let requestNum = 0;
const addLoading = () => {
  // 增加loading 如果pending請求數(shù)量等于1，彈出loading, 防止重復(fù)彈出
  requestNum++;
  if (requestNum == 1) {
    loadingInstance = Loading.service({
      text: "正在努力加載中....",
      background: "rgba(0, 0, 0, 0)",
    });
  }
};
const cancelLoading = () => {
  // 取消loading 如果pending請求數(shù)量等于0，關(guān)閉loading
  requestNum--;
  if (requestNum === 0) loadingInstance?.close();
};
export const createAxiosByinterceptors = (
  config?: AxiosRequestConfig
): AxiosInstance => {
  const instance = axios.create({
    timeout: 1000,    //超時配置
    withCredentials: true,  //跨域攜帶cookie
    ...config,   // 自定義配置覆蓋基本配置
  });
  // 添加請求攔截器
  instance.interceptors.request.use(
    function (config: any) {
      // 在發(fā)送請求之前做些什么
      const { loading = true } = config;
      console.log("config:", config);
      // config.headers.Authorization = vm.$Cookies.get("vue_admin_token");
      if (loading) addLoading();
      return config;
    },
    function (error) {
      // 對請求錯誤做些什么
      return Promise.reject(error);
    }
  );
  // 添加響應(yīng)攔截器
  instance.interceptors.response.use(
    function (response) {
      // 對響應(yīng)數(shù)據(jù)做點什么
      console.log("response:", response);
      const { loading = true } = response.config;
      if (loading) cancelLoading();
      const { code, data, message } = response.data;
      if (code === 200) return data;
      else if (code === 401) {
        jumpLogin();
      } else {
         Message.error(message);
         return Promise.reject(response.data);
      }
    },
    function (error) {
      // 對響應(yīng)錯誤做點什么
      console.log("error-response:", error.response);
      console.log("error-config:", error.config);
      console.log("error-request:", error.request);
      const { loading = true } = error.config;
      if (loading) cancelLoading();
      if (error.response) {
        if (error.response.status === 401) {
          jumpLogin();
        }
      }
      Message.error(error?.response?.data?.message || "服務(wù)端異常");
      return Promise.reject(error);
    }
  );
  return instance;
};

統(tǒng)一文件下載處理

import axios, { AxiosInstance, AxiosRequestConfig } from "axios";
import { Message } from "element-ui";
import { jumpLogin, downloadFile } from "@/utils";
import { Loading } from "element-ui";
import { ElLoadingComponent } from "element-ui/types/loading";
// import vm from "@/main";
let loadingInstance: ElLoadingComponent | null = null;
let requestNum = 0;
const addLoading = () => {
  // 增加loading 如果pending請求數(shù)量等于1，彈出loading, 防止重復(fù)彈出
  requestNum++;
  if (requestNum == 1) {
    loadingInstance = Loading.service({
      text: "正在努力加載中....",
      background: "rgba(0, 0, 0, 0)",
    });
  }
};
const cancelLoading = () => {
  // 取消loading 如果pending請求數(shù)量等于0，關(guān)閉loading
  requestNum--;
  if (requestNum === 0) loadingInstance?.close();
};
export const createAxiosByinterceptors = (
  config?: AxiosRequestConfig
): AxiosInstance => {
  const instance = axios.create({
    timeout: 1000,    //超時配置
    withCredentials: true,  //跨域攜帶cookie
    ...config,   // 自定義配置覆蓋基本配置
  });
  // 添加請求攔截器
  instance.interceptors.request.use(
    function (config: any) {
      // 在發(fā)送請求之前做些什么
      const { loading = true } = config;
      console.log("config:", config);
      // config.headers.Authorization = vm.$Cookies.get("vue_admin_token");
      if (loading) addLoading();
      return config;
    },
    function (error) {
      // 對請求錯誤做些什么
      return Promise.reject(error);
    }
  );
  // 添加響應(yīng)攔截器
  instance.interceptors.response.use(
    function (response) {
      // 對響應(yīng)數(shù)據(jù)做點什么
      console.log("response:", response);
      const { loading = true } = response.config;
      if (loading) cancelLoading();
      const { code, data, message } = response.data;
      // config設(shè)置responseType為blob 處理文件下載
      if (response.data instanceof Blob) {
        return downloadFile(response);
      } else {
        if (code === 200) return data;
        else if (code === 401) {
          jumpLogin();
        } else {
          Message.error(message);
          return Promise.reject(response.data);
        }
      }
    },
    function (error) {
      // 對響應(yīng)錯誤做點什么
      console.log("error-response:", error.response);
      console.log("error-config:", error.config);
      console.log("error-request:", error.request);
      const { loading = true } = error.config;
      if (loading) cancelLoading();
      if (error.response) {
        if (error.response.status === 401) {
          jumpLogin();
        }
      }
      Message.error(error?.response?.data?.message || "服務(wù)端異常");
      return Promise.reject(error);
    }
  );
  return instance;
};

src/utils/index.ts
import { Message } from "element-ui";
import { AxiosResponse } from "axios";
import vm from "@/main";
/**
 *   跳轉(zhuǎn)登錄
 */
export const jumpLogin = () => {
  vm.$Cookies.remove("vue_admin_token");
  vm.$router.push(`/login?redirect=${encodeURIComponent(vm.$route.fullPath)}`);
};
/**
 * 下載文件
 * @param response
 * @returns
 */
export const downloadFile = (response: AxiosResponse) => {
  console.log("response.data.type:", response.data.type);
  return new Promise((resolve, reject) => {
    const fileReader = new FileReader();
    fileReader.onload = function () {
      try {
        console.log("result:", this.result);
        const jsonData = JSON.parse((this as any).result); // 成功 說明是普通對象數(shù)據(jù)
        if (jsonData?.code !== 200) {
          Message.error(jsonData?.message ?? "請求失敗");
          reject(jsonData);
        }
      } catch (err) {
        // 解析成對象失敗，說明是正常的文件流
        const blob = new Blob([response.data]);
        // 本地保存文件
        const url = window.URL.createObjectURL(blob);
        const link = document.createElement("a");
        link.href = url;
        const filename = response?.headers?.["content-disposition"]
          ?.split("filename*=")?.[1]
          ?.substr(7);
        link.setAttribute("download", decodeURI(filename));
        document.body.appendChild(link);
        link.click();
        resolve(response.data);
      }
    };
    fileReader.readAsText(response.data);
  });
};

使用

import { createAxiosByinterceptors } from "@/api/request";
const request = createAxiosByinterceptors({
  baseURL: localhost:7007,
});
//lodaing配置
export const appList = (params: any): Promise<any> =>
  request.get("/app", { params, loading: true }); // 不需要默認的全局loading效果可配置loading為false關(guān)閉 loading默認為true
// 文件下載
export const exportGoods = (data: any) =>
  request.post("/export", data, {
    responseType: "blob",
  });

完結(jié)撒花??????

以上就是十分鐘省時又省力封裝一個好用的axios步驟示例的詳細內(nèi)容，更多關(guān)于axios封裝步驟的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: