【Web】axios 工具类封装

Axios 封装工具类,包含更完善的功能和更清晰的代码结构,提升了可读性、复用性和扩展性:

关键点

  1. 响应类型的细化
    明确 ApiResponse 类型,使其更具通用性。
  2. 全局配置的抽离
    axios 的默认配置集中管理,方便后续维护。
  3. 拦截器的增强
    添加更详细的错误处理和日志功能。
  4. 文件上传的参数增强
    支持动态添加额外的表单字段。
  5. 请求方法类型优化
    通过 TypeScript 类型定义提高类型安全性。
  6. 取消请求功能
    添加取消请求的功能,便于在某些场景中手动中断请求。

完整代码

import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
import qs from "qs";
import { showToastFail } from "@/utils/my-utils";
import { getUrlParam } from "@/utils";
import { sign } from "@/utils/aes";

// 全局配置
const TIME_OUT = 30 * 1000;
const BASE_URL = process.env.VITE_API_BASE_URL || ""; // 支持环境变量配置

interface ApiResponse<T = any> {
  code: number;
  message?: string;
  data: T;
  msg?: string;
}

// 初始化 Axios 实例
const createAxiosInstance = (): AxiosInstance => {
  const instance = axios.create({
    baseURL: BASE_URL,
    timeout: TIME_OUT,
    headers: {
      "Content-Type": "application/json",
    },
    paramsSerializer: params => qs.stringify(params, { arrayFormat: "brackets" }),
  });

  // 设置拦截器
  setInterceptors(instance);

  return instance;
};

const axiosInstance = createAxiosInstance();

// 请求拦截器
function setInterceptors(instance: AxiosInstance) {
  const { type = "usdt", tgid = "123456" } = getUrlParam();

  // 请求拦截
  instance.interceptors.request.use((config: AxiosRequestConfig) => {
    const params = config.params || {};
    const data = config.data ? queryStringToObject(config.data) : {};

    const headers = {
      "Content-Type": "application/x-www-form-urlencoded",
    };

    config.headers = {
      ...headers,
      ...config.headers,
    };

    return config;
  });

  // 响应拦截
  instance.interceptors.response.use(
    (response: AxiosResponse<ApiResponse>) => {
      const { data } = response;
      if (data.code !== 0) {
        showToastFail(data?.message || data?.msg || "Request failed");
        return Promise.reject(data);
      }
      return Promise.resolve(data);
    },
    (error: any) => {
      const errorMsg = error.response?.data?.message || "Network error occurred";
      showToastFail(errorMsg);
      return Promise.reject(error);
    }
  );
}

// 查询字符串转换为对象
function queryStringToObject(queryString: string) {
  const params: Record<string, any> = {};
  new URLSearchParams(queryString).forEach((value, key) => {
    params[key] = isNaN(Number(value)) ? value : Number(value);
  });
  return params;
}

// HTTP 工具类
export const http = {
  get<T = any>(url: string, params?: any, headers?: any): Promise<ApiResponse<T>> {
    return axiosInstance({
      url,
      method: "get",
      params,
      headers,
    });
  },

  post<T = any>(url: string, data?: any, headers?: any): Promise<ApiResponse<T>> {
    return axiosInstance({
      url,
      method: "post",
      data: qs.stringify(data),
      headers,
    });
  },

  postJson<T = any>(url: string, data?: any): Promise<ApiResponse<T>> {
    return axiosInstance({
      url,
      method: "post",
      data,
      headers: {
        "Content-Type": "application/json",
      },
    });
  },

  put<T = any>(url: string, data?: any, headers?: any): Promise<ApiResponse<T>> {
    return axiosInstance({
      url,
      method: "put",
      data: qs.stringify(data),
      headers,
    });
  },

  delete<T = any>(url: string, params?: any, headers?: any): Promise<ApiResponse<T>> {
    return axiosInstance({
      url,
      method: "delete",
      params,
      headers,
    });
  },

  uploadFile<T = any>(url: string, file: File, additionalData?: Record<string, any>): Promise<ApiResponse<T>> {
    const formData = new FormData();
    formData.append("file", file);
    if (additionalData) {
      Object.keys(additionalData).forEach(key => formData.append(key, additionalData[key]));
    }

    return axiosInstance({
      url,
      method: "post",
      data: formData,
      headers: {
        "Content-Type": "multipart/form-data",
      },
    });
  },

  cancelToken(): { token: any; cancel: () => void } {
    const CancelToken = axios.CancelToken;
    let cancel: () => void;
    const token = new CancelToken(c => {
      cancel = c;
    });
    return { token, cancel };
  },
};

// 导出默认实例
export default http;

调用示例

普通请求

http.get("/api/users", { page: 1, size: 10 }).then(res => {
  console.log("User data:", res.data);
}).catch(err => {
  console.error("Request error:", err);
});

文件上传

const file = document.querySelector("input[type='file']").files[0];
http.uploadFile("/api/upload", file, { userId: 123 }).then(res => {
  console.log("Upload success:", res.data);
}).catch(err => {
  console.error("Upload failed:", err);
});

取消请求

const { token, cancel } = http.cancelToken();

http.get("/api/data", {}, { cancelToken: token })
  .then(res => console.log(res))
  .catch(err => console.error("Request canceled or failed:", err));

// 手动取消请求
cancel();
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,753评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,668评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,090评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,010评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,054评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,806评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,484评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,380评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,873评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,021评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,158评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,838评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,499评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,044评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,159评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,449评论 3 374
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,136评论 2 356

推荐阅读更多精彩内容