基于element-plus封装Axios

import axios, { AxiosInstance, AxiosError, AxiosRequestConfig, InternalAxiosRequestConfig, AxiosResponse } from "axios";
import { showFullScreenLoading, tryHideFullScreenLoading } from "@/config/serviceLoading";
import { LOGIN_URL } from "@/config";
import { ElMessage } from "element-plus";
import { ResultData } from "@/api/interface";
import { ResultEnum } from "@/enums/httpEnum";
import { checkStatus } from "./helper/checkStatus";
import { useUserStore } from "@/stores/modules/user";
import router from "@/routers";

export interface CustomAxiosRequestConfig extends InternalAxiosRequestConfig {
  noLoading?: boolean;
}

const config = {
  // 默认地址请求地址,可在 .env.** 文件中修改
  baseURL: import.meta.env.VITE_API_URL as string,
  // 设置超时时间
  timeout: ResultEnum.TIMEOUT as number,
  // 跨域时候允许携带凭证
  withCredentials: true
};

class RequestHttp {
  service: AxiosInstance;
  public constructor(config: AxiosRequestConfig) {
    // instantiation
    this.service = axios.create(config);

    /**
     * @description 请求拦截器
     * 客户端发送请求 -> [请求拦截器] -> 服务器
     * token校验(JWT) : 接受服务器返回的 token,存储到 vuex/pinia/本地储存当中
     */
    this.service.interceptors.request.use(
      (config: CustomAxiosRequestConfig) => {
        const userStore = useUserStore();
        // 当前请求不需要显示 loading,在 api 服务中通过指定的第三个参数: { noLoading: true } 			来控制
        config.noLoading || showFullScreenLoading();
        if (config.headers && typeof config.headers.set === "function") {
          config.headers.set("x-access-token", userStore.token);
        }
        return config;
      },
      (error: AxiosError) => {
        return Promise.reject(error);
      }
    );
    
    /**
     * @description 响应拦截器
     *  服务器换返回信息 -> [拦截统一处理] -> 客户端JS获取到信息
     */
    this.service.interceptors.response.use(
      (response: AxiosResponse) => {
        const { data } = response;
        const userStore = useUserStore();
        tryHideFullScreenLoading();
        // 登陆失效
        if (data.code == ResultEnum.OVERDUE) {
          userStore.setToken("");
          router.replace(LOGIN_URL);
          ElMessage.error(data.msg);
          return Promise.reject(data);
        }
        // 全局错误信息拦截(防止下载文件的时候返回数据流,没有 code 直接报错)
        if (data.code && data.code !== ResultEnum.SUCCESS) {
          ElMessage.error(data.msg);
          return Promise.reject(data);
        }
        // 成功请求(在页面上除非特殊情况,否则不用处理失败逻辑)
        return data;
      },
      async (error: AxiosError) => {
        const { response } = error;
        tryHideFullScreenLoading();
        // 请求超时 && 网络错误单独判断,没有 response
        if (error.message.indexOf("timeout") !== -1) ElMessage.error("请求超时!请您稍后重		试");
        if (error.message.indexOf("Network Error") !== -1) ElMessage.error("网络错误!请您			稍后重试");
        // 根据服务器响应的错误状态码,做不同的处理
        if (response) checkStatus(response.status);
        // 服务器结果都没有返回(可能服务器错误可能客户端断网),断网处理:可以跳转到断网页面
        if (!window.navigator.onLine) router.replace("/500");
        return Promise.reject(error);
      }
    );

  }

  /**

   * @description 常用请求方法封装
     */
  get<T>(url: string, params?: object, _object = {}): Promise<ResultData<T>> {
    return this.service.get(url, { params, ..._object });
  }
  post<T>(url: string, params?: object | string, _object = {}): Promise<ResultData<T>> {
    return this.service.post(url, params, _object);
  }
  put<T>(url: string, params?: object, _object = {}): Promise<ResultData<T>> {
    return this.service.put(url, params, _object);
  }
  delete<T>(url: string, params?: any, _object = {}): Promise<ResultData<T>> {
    return this.service.delete(url, { params, ..._object });
  }
  download(url: string, params?: object, _object = {}): Promise<BlobPart> {
    return this.service.post(url, params, { ..._object, responseType: "blob" });
  }
}

export default new RequestHttp(config);

这段代码是一个使用 Axios 封装的请求类 RequestHttp。让我们逐步分析它的核心部分:

定义了一个 config 对象,其中包含了默认的请求配置项,例如 baseURL、timeout 和 withCredentials。这些配置项可以在创建 RequestHttp 实例时传递参数进行自定义。

创建了一个 Axios 实例,通过调用 axios.create(config) 方法,并将配置对象 config 传递进去。这样,Axios 实例就使用了这些默认的请求配置项。

RequestHttp 类的构造函数接受一个名为 config 的参数(与前面的 config 对象名字相同,但是此处指的是不同的对象),这个参数是用来在请求拦截器中进行个性化配置的。具体的用法是在请求拦截器中根据传入的 config 中的属性值判断是否需要执行一些操作,例如显示 loading。

在请求拦截器中,首先判断传入的 config 对象中的 headers 属性是否存在,并且确保 headers 具有 set 方法。然后使用 set 方法将 x-access-token 请求头字段的值设置为 userStore.token。这里的 userStore 应该是一个用于存储用户相关信息的状态管理对象。

在响应拦截器中,首先获取响应中的 data 数据。然后根据具体的情况,判断响应状态码是否为登录失效的状态码。如果是,清空用户的 token 并跳转到登录页面。如果不是,继续判断响应状态码是否为全局错误状态码。如果是,使用 ElMessage.error() 方法显示错误信息,并返回一个拒绝的 Promise 对象。最后,如果以上情况均不满足,返回响应的 data 数据。

RequestHttp 类中还定义了常用的请求方法,包括 get、post、put、delete 和 download,它们调用 Axios 实例相应的方法来发送请求,并返回 Promise 对象。

最后,通过 export default new RequestHttp(config) 导出了一个 RequestHttp 类的实例,该实例具有默认的 Axios 配置和请求方法。

总体而言,这段代码封装了一个可配置的请求类 RequestHttp,它使用 Axios 发送 HTTP 请求,并提供了一些额外的功能,例如请求拦截器和响应拦截器,用于处理请求和响应,以及设置请求头、显示错误信息等操作。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值