快捷導(dǎo)航

vue3結(jié)合typescript中使用class封裝axios

更新時(shí)間：2023年06月13日 10:47:09 作者：阿淮iya

這篇文章主要為大家介紹了vue3結(jié)合typescript中使用class封裝axios實(shí)現(xiàn)示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

vue3 + Ts 中如何封裝 axios

安裝 axios 和 Element-plus

yarn add axios
//  因?yàn)樵谡?qǐng)求中使用到了 loading
yarn add element-plus@2.2.12

在 request 文件中創(chuàng)建三個(gè)文件： type.ts 、 index.ts 、 config.ts

1.定義接口類型：創(chuàng)建 type.ts 文件

// 引入 axios 
import type { AxiosRequestConfig, AxiosResponse } from 'axios';
// 定義接口
export interface HRequestInterceptors<T = AxiosResponse> {
  // 請(qǐng)求攔截器（成功與失敗）
  requestInterceptors?: (config: AxiosRequestConfig) => AxiosRequestConfig;
  requestInterceptorsCatch?: (error: any) => any;
  // 相應(yīng)攔截器（成功與失?。?
  responseInterceptor?: (res: T) => T;
  responseInterceptorCatch?: (error: any) => any;
}
// 繼承接口: 定義每個(gè)請(qǐng)求的攔截器并且設(shè)置請(qǐng)求狀態(tài)顯示
export interface HRequestConfig<T = AxiosResponse> extends AxiosRequestConfig {
  interceptors?: HRequestInterceptors<T>;
  // 是否展示請(qǐng)求加載狀態(tài)
  showLoading?: boolean;
}

2.根據(jù)1 type 使用 class 封裝axios

//  引入axios
import axios from 'axios';
import type { AxiosInstance } from 'axios';
// 引入類型
import type { HRequestInterceptors, HRequestConfig } from './type';
// 引入加載等待組件
import { ElLoading } from 'element-plus';
// 引入loading 類型：不同版本路勁不同
import { LoadingInstance } from 'element-plus/es/components/loading/src/loading';
// 請(qǐng)求加載顯示狀態(tài)
const DEFAULT_LOADING = false;
class HRequest {
 // 類型
  instance: AxiosInstance;
  interceptors?: HRequestInterceptors;
  showLoading: boolean;
  loading?: LoadingInstance;
  constructor(config: HRequestConfig) {
    // 創(chuàng)建請(qǐng)求
    this.instance = axios.create(config);
    // 保存基本信息
    this.interceptors = config.interceptors;
    this.showLoading = config.showLoading ?? DEFAULT_LOADING;
    // 使用攔截器
    // 1.從config中獲取的攔截器是對(duì)應(yīng)的實(shí)例的攔截器
    this.instance.interceptors.request.use(
      this.interceptors?.requestInterceptors,
      this.interceptors?.requestInterceptorsCatch
    );
    // 響應(yīng)攔截類型
    this.instance.interceptors.response.use(
      this.interceptors?.responseInterceptor,
      this.interceptors?.responseInterceptorCatch
    );
    // 2.所有示實(shí)例的請(qǐng)求攔截
    this.instance.interceptors.request.use(
      (config) => {
        if (this.showLoading) {
          this.loading = ElLoading.service({
            lock: true,
            text: '請(qǐng)求加載中...',
            background: 'rgba(255,255,255,0.5)'
          });
        }
        return config;
      },
      (err) => {
        return err;
      }
    );
    // 所有實(shí)例響應(yīng)攔截
    this.instance.interceptors.response.use(
      (res) => {
        // 通過http的錯(cuò)誤碼
        // 服務(wù)器返回的status
        const data = res.data;
        // 清除loading
        this.loading?.close();
        if (data.returnCode === '-1001') {
          console.log('請(qǐng)求失敗,錯(cuò)誤信息');
        } else {
          return data;
        }
      },
      (err) => {
        // 4xx -> 5xx 在這里攔截
        if (err.response.status == 404) {
          console.log('404 的錯(cuò)誤');
        }
        return err;
      }
    );
  }
  request<T>(config: HRequestConfig<T>): Promise<T> {
    return new Promise((resolve, reject) => {
      // 1. 單個(gè)請(qǐng)求的cofig 的處理
      if (config.interceptors?.requestInterceptors) {
        config = config.interceptors.requestInterceptors(config);
      }
      // 判斷是否顯示loading
      if (config.showLoading) {
        this.showLoading = config.showLoading;
      }
      this.instance
        .request<any, T>(config)
        .then((res) => {
          if (config.interceptors?.responseInterceptor) {
            res = config.interceptors.responseInterceptor(res);
          }
          // 不影響下一個(gè)loading 的使用
          this.showLoading = DEFAULT_LOADING;
          // 返回結(jié)果
          resolve(res);
        })
        .catch((err) => {
          // 不影響下一個(gè)loading 的使用
          this.showLoading = DEFAULT_LOADING;
          reject(err);
        });
    });
  }
  // 對(duì)request 二次封裝
  get<T>(config: HRequestConfig<T>): Promise<T> {
    return this.request<T>({ ...config, method: 'GET' });
  }
  post<T>(config: HRequestConfig<T>): Promise<T> {
    return this.request<T>({ ...config, method: 'POST' });
  }
  put<T>(config: HRequestConfig<T>): Promise<T> {
    return this.request<T>({ ...config, method: 'PUT' });
  }
  delete<T>(config: HRequestConfig<T>): Promise<T> {
    return this.request<T>({ ...config, method: 'DELETE' });
  }
}
export default HRequest;

3.創(chuàng)建 config.ts 文件

// 根據(jù)相關(guān)開發(fā)環(huán)境進(jìn)行獲取 BASEURL
export const BASE_URL = process.env.VUE_APP_BASE_API;
// 請(qǐng)求等待時(shí)間
export const TIME_OUT = 1000;
// export { BASE_URL, TIME_OUT };

4.新建 serivce統(tǒng)一出口

import HRequest from './request';
// 
import { BASE_URL, TIME_OUT } from './request/config';
import localCache from '@/utils/cache';
// 攜帶參數(shù)
const hRequest = new HRequest({
  baseURL: BASE_URL,
  timeout: TIME_OUT,
  interceptors: {
    requestInterceptors: (config) => {
      //  獲取token 根據(jù) 自己 對(duì)token存儲(chǔ) 獲取
      const token = localCache.getCache({ key: 'token' });
      if (token && config.headers) {
        config.headers.Authorization = `Bearer ${token}`;
      }
      return config;
    },
    requestInterceptorsCatch(error) {
      return error;
    },
    responseInterceptor: (res) => {
      return res;
    },
    responseInterceptorCatch(error) {
      return error;
    }
  }
});
export default hRequest;

5.最后定義請(qǐng)求接口和使用

import hRequest from '../index';
// 參數(shù)類型
interface IData {}
// 返回結(jié)果類型 
interface IResult{}
// url
enum LoginAPI {
  AccontLogin = '/login'
}
// 導(dǎo)出接口 showLoading：loading顯示 ：默認(rèn)情況下為不展示
export function accountLoginRequst(data:IData) {
  return hRequest.post<IResult>({
    url: LoginAPI.AccontLogin,
    data，
    showLoading: true
  });
}
// 使用
accountLoginRequst({userName:'admin',password:'123456'}).then(res=>{
  console.log(res)
})

以上就是vue3結(jié)合typescript中使用class封裝axios的詳細(xì)內(nèi)容，更多關(guān)于vue3 Ts封裝axios的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: