前端通用请求层封装

什么决定了一个项目架构设计的好坏?很多优秀的项目构架都是基于分层的思想,比如开放互联的网络协议,分层方便我们快速调整以及功能的丰富。在前端项目中,我们也会做一些通用的逻辑设计,比如接口请求层、路由层、权限处理等等,这些是支撑一个复杂前端项目的基础。本文我对接口请求层做一个封装,查看示例代码

1. 功能设计

  • 支持取消请求 (这里要兼顾多种场景)
    • 路由跳转时,将未完成的请求取消,只取消 GET 请求;
    • 将两个相同的请求的前者取消,如何判断相同?url相同以及请求方法相同,只取消 GET 请求;
    • 开放取消某一个请求的能力,方便下一层业务逻辑的处理
  • 超时时间设置
  • 登录状态异常处理
  • 是否全局异常
  • 是否全局 loading
  • 错误异常是否 抛出 或者 return
  • 支持最小响应时间设置
  • 请求超时的重发

2. 代码实现

import axios, { AxiosRequestConfig } from "axios";
import UrlParse from "url-parse";
import { getToken } from "@/utils/auth";
import { Message } from "element-ui";

const cancelTokens: Function[] = [];
export function clearRequest() {
  while (cancelTokens.length) {
    const fn = cancelTokens.shift() as Function;
    fn("user-cancel");
  }
}

class AuthError extends Error {
  constructor(message: string) {
    super(message);
    this.name = "auth-error";
  }
}

const baseURL = "http://renwu.airtlab.com/api/";
const service = axios.create({
  baseURL,
  timeout: 10000
});

service.interceptors.request.use(
  config => {
    config.headers["token"] = getToken();
    return config;
  },
  error => {
    return Promise.reject(error);
  }
);

service.interceptors.response.use(
  response => {
    const data = response.data;
    // 自定义异常逻辑
    data.success = data.retCode === "0";
    if (!data.success && !(data instanceof Blob)) {
      return Promise.reject(new Error(data.msg || `未知错误 data (${data}) `));
    }
    return data;
  },
  error => {
    if (error.message.includes("401")) {
      return Promise.reject(new AuthError("未登录"));
    } else {
      return Promise.reject(error);
    }
  }
);

interface RequestOption extends AxiosRequestConfig {
  minTime?: number;     // 最小请求时间
  gLoading?: boolean;   // 全局loading
  igError?: boolean;    // 全局错误提示
  query?: object;       // 查询字符串
  cancelResolver?: (cancelFn: Function) => void;
}

export function createRequest(option: RequestOption) {
  return function (params: RequestOption) {
    return request({ ...option, ...params })
  }
}

export default function request(option: RequestOption, count = 0) {
  if (option.timeout === 0) {
    option.timeout = 1000 * 3600 * 24; // 不设置超时时间,24h
  }
  if (!option.minTime) {
    option.minTime = 200;
  }
  if (option.query) {
    const o = new UrlParse(baseURL + option.url, true);
    Object.assign(o.query, option.query);
    option.url = o.toString();
    delete option.query;
  }

  const cancelToken = new axios.CancelToken(function executor(fn) {
    if (option.cancelResolver) {
      option.cancelResolver(() => {
        fn('user-cancel');
      });
    } else {
      cancelTokens.push(fn);
    }
  })

  const p1 = service({ ...option, cancelToken });
  const p2 = new Promise(resolve => setTimeout(() => resolve(1), option.minTime));

  return Promise.allSettled([p1, p2]).then((res: any) => {
    const { value, reason } = res[0];
    if (!reason) return value;
    const isTimeout = reason.message.indexOf("timeout") === 0;
    const message = isTimeout ? "接口响应超时" : reason.message;

    if (isTimeout) {
      if (count === 0) {
        return request(option, 1)
      }
    }

    if (reason instanceof axios.Cancel) {
      // user-cancel
      option.igError = true;
      return Promise.reject(reason);
    }

    if (reason instanceof AuthError) {
      Message("未登录,去登录");
      return;
    }

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