专栏首页前端皮小蛋使用 axios 拦截器解决「 前端并发冲突 」 问题

使用 axios 拦截器解决「 前端并发冲突 」 问题

背景

并发冲突问题, 是日常开发中一个比较常见的问题。

不同用户在较短时间间隔内变更数据,或者某一个用户进行的重复提交操作都可能导致并发冲突。

并发场景在开发和测试阶段难以排查全面,出现线上 bug 以后定位困难,因此做好并发控制是前后端开发过程中都需要重视的问题。

对于同一用户短时间内重复提交数据的问题,前端通常可以先做一层拦截。

本文将讨论前端如何利用 axios 的拦截器过滤重复请求,解决并发冲突。

一般的处理方式 — 每次发请求添加 loading

在尝试 axios 拦截器之前,先看看我们之前业务是怎么处理并发冲突问题的:

每次用户操作页面上的控件(输入框、按钮等),向后端发送请求的时候,都给页面对应的控件添加 loading 效果,提示正在进行数据加载,同时也阻止 loading 效果结束前用户继续操作控件。

这是最直接有效的方式,如果你们前端团队成员足够细心耐心,拥有良好的编码习惯,这样就可以解决大部分用户不小心重复提交带来的并发问题了。

更优的解决方案:axios 拦截器统一处理

项目中需要前端限制并发的场景这么多,我们当然要思考更优更省事的方案。

既然是在每次发送请求的时候进行并发控制,那如果能重新封装下发请求的公共函数,统一处理重复请求实现自动拦截,就可以大大简化我们的业务代码。

项目使用的 axios 库来发送 http 请求,axios 官方为我们提供了丰富的 API,我们来看看拦截请求需要用到的两个核心 API:

1. interceptors

拦截器包括请求拦截器和响应拦截器,可以在请求发送前或者响应后进行拦截处理,用法如下:

// 添加请求拦截器
axios.interceptors.request.use(function (config) {
  // 在发送请求之前做些什么
  return config;
}, function (error) {
  // 对请求错误做些什么
  return Promise.reject(error);
});

// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    // 对响应数据做点什么
    return response;
  }, function (error) {
    // 对响应错误做点什么
    return Promise.reject(error);
  });

2. cancel token:

调用 cancel token API 可以取消请求。

官网提供了两种方式来构建 cancel token,我们采用这种方式:

通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token,方便在上面的请求拦截器中检测到重复请求可以立即执行:

const CancelToken = axios.CancelToken;
let cancel;

axios.get('/user/12345', {
  cancelToken: new CancelToken(function executor(c) {
    // executor 函数接收一个 cancel 函数作为参数
    cancel = c;
  })
});

// cancel the request
cancel();

本文提供的思路就是利用 axios interceptors API 拦截请求,检测是否有多个相同的请求同时处于 pending 状态,如果有就调用 cancel token API 取消重复的请求。

假如用户重复点击按钮,先后提交了 A 和 B 这两个完全相同(考虑请求路径、方法、参数)的请求,我们可以从以下几种拦截方案中选择其一:

  • 取消 A 请求,只发出 B 请求
  • 取消 B 请求,只发出 A 请求
  • 取消 B 请求,只发出 A 请求,把收到的 A 请求的返回结果也作为 B 请求的返回结果

第三种方案需要做监听处理增加了复杂性,结合我们实际的业务需求,最后采用了第二种方案来实现,即:

只发第一个请求。在 A 请求还处于 pending 状态时,后发的所有与 A 重复的请求都取消,实际只发出 A 请求,直到 A 请求结束(成功/失败)才停止对这个请求的拦截。

具体实现

  1. 存储所有 pending 状态的请求

首先我们要将项目中所有的 pending 状态的请求存储在一个变量中,叫它 pendingRequests

可以通过把 axios 封装为一个单例模式的类,或者定义全局变量,来保证 pendingRequests 变量在每次发送请求前都可以访问,并检查是否为重复的请求。

let pendingRequests = new Map()

把每个请求的方法、url 和参数组合成一个字符串,作为标识该请求的唯一 key,同时也是 pendingRequests 对象的 key:

const requestKey = `${config.url}/${JSON.stringify(config.params)}/${JSON.stringify(config.data)}&request_type=${config.method}`;

帮助理解的小 tips:

  • 定义 pendingRequests 为 map 对象的目的是为了方便我们查询它是否包含某个 key,以及添加和删除 key。添加 key 时,对应的 value 可以设置用户自定义的一些功能参数,后面扩展功能的时候会用到。
  • configaxios 拦截器中的参数,包含当前请求的信息
  1. 在请求发出前检查当前请求是否重复 在请求拦截器中,生成上面的 requestKey,检查 pendingRequests 对象中是否包含当前请求的 requestKey
    • 有:说明是重复的请求,cancel 掉当前请求
    • 没有:把 requestKey 添加到 pendingRequests 对象中

因为后面的响应拦截器中还要用到当前请求的 requestKey,为了避免踩坑,最好不要再次生成。

在这一步就把 requestKey 存回 axios 拦截器的 config 参数中,后面可以直接在响应拦截器中通过 response.config.requestKey 取到。

代码示例:

// 请求拦截器
axios.interceptors.request.use(
  (config) => {
    if (pendingRequests.has(requestKey)) {
      config.cancelToken = new axios.CancelToken((cancel) => {
        // cancel 函数的参数会作为 promise 的 error 被捕获
        cancel(`重复的请求被主动拦截: ${requestKey}`);
      });
    } else {
      pendingRequests.set(requestKey, config);
      config.requestKey = requestKey;
    }
    return config;
  },
  (error) => {
    // 这里出现错误可能是网络波动造成的,清空 pendingRequests 对象
    pendingRequests.clear();
    return Promise.reject(error);
  }
);
  1. 在请求返回后维护 pendingRequests 对象

如果请求顺利走到了响应拦截器这一步,说明这个请求已经结束了 pending 状态,那我们要把它从 pendingRequests 中除名:

axios.interceptors.response.use((response) => {
  const requestKey = response.config.requestKey;
  pendingRequests.delete(requestKey);
  return Promise.resolve(response);
}, (error) => {
  if (axios.isCancel(error)) {
    console.warn(error);
    return Promise.reject(error);
  }
  pendingRequests.clear();
  return Promise.reject(error);
})
  1. 需要清空 pendingRequests 对象的场景

遇到网络波动或者超时等情况造成请求错误时,需要清空原来存储的所有 pending 状态的请求记录,在上面演示的代码已经作了注释说明。

此外,页面切换时也需要清空之前缓存的 pendingRequests 对象,可以利用 Vue RouterbeforeEach 钩子:

router.beforeEach((to, from, next) => {
  request.clearRequestList();
  next();
});

功能扩展

  1. 统一处理接口报错提示

与后端约定好接口返回数据的格式,对接口报错的情况,可以统一在响应拦截器中添加 toast 给用户提示,

对于特殊的不需要报错的接口,可以设置一个参数存入 axios 拦截器的 config 参数中,过滤掉报错提示:

// 接口返回 retcode 不为 0 时需要报错,请求设置了 noError 为 true 则这个接口不报错 
if (
  response.data.retcode &&
  !response.config.noError
) {
  if (response.data.message) {
    Vue.prototype.$message({
      showClose: true,
      message: response.data.message,
      type: 'error',
    });
  }
  return Promise.reject(response.data);
}
  1. 发送请求时给控件添加 loading 效果

上面利用 axios interceptors 过滤重复请求时,可以在控制台抛出信息给开发者提示,在这个基础上如果能给页面上操作的控件添加 loading 效果就会对用户更友好。

常见的 ui 组件库都有提供 loading 服务,可以指定页面上需要添加 loading 效果的控件。下面是以 element UI 为例的示例代码:

// 给 loadingTarget 对应的控件添加 loading 效果,储存 loadingService 实例
addLoading(config) {
  if (!document.querySelector(config.loadingTarget)) return;
  config.loadingService = Loading.service({
    target: config.loadingTarget,
  });
}

// 调用 loadingService 实例的 close 方法关闭对应元素的 loading 效果
closeLoading(config) {
  config.loadingService && config.loadingService.close();
}

与上面过滤报错方式类似,发请求的时候将元素的 class name 或 id 存入 axios 拦截器的 config 参数中,

在请求拦截器中调用 addLoading 方法, 响应拦截器中调用 closeLoading 方法,就可以实现在请求 pending 过程中指定控件(如 button) loading,请求结束后控件自动取消 loading 效果。

  1. 支持多个拦截器组合使用

简单看下 axios interceptors 部分实现源码可以理解,它支持定义多个 interceptors,所以只要我们定义的 interceptors 符合 Promise.then 链式调用的规范,还可以添加更多功能:

this.interceptors.request.forEach(function unshiftRequestInterceptors(interceptor) {
  chain.unshift(interceptor.fulfilled, interceptor.rejected);
});

this.interceptors.response.forEach(function pushResponseInterceptors(interceptor) {
  chain.push(interceptor.fulfilled, interceptor.rejected);
});

while (chain.length) {
  promise = promise.then(chain.shift(), chain.shift());
}

总结

并发问题很常见,处理起来又相对繁琐,前端解决并发冲突时,可以利用 axios 拦截器统一处理重复请求,简化业务代码。

同时 axios 拦截器支持更多应用,本文提供了部分常用扩展功能的实现,感兴趣的同学可以继续挖掘补充拦截器的其他用法。

今天的内容就这么多,希望对你有帮助。

本文分享自微信公众号 - 前端皮小蛋(gh_e69260c16440),作者:南山皮小蛋

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2021-05-06

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • vue axios封装以及API统一管理

    在vue项目中,每次和后台交互的时候,经常用到的就是axios请求数据,它是基于promise的http库,可运行在浏览器端和node.js中。当项目越来越大的...

    小周sri的码农
  • 使用Vue完成前后端分离开发Spring,Django,Flask(一)

    本篇题为 使用Vue,Spring Boot,Flask,Django 完成Vue前后端分离开发 将通过一个项目整合(一前端项目对应三个后端项目),完成一个简单...

    双鬼带单
  • Spring Boot + Vue 前后端分离开发,前端网络请求封装与配置

    前端网络访问,主流方案就是 Ajax,Vue 也不例外,在 Vue2.0 之前,网络访问较多的采用 vue-resources,Vue2.0 之后,官方不再建议...

    江南一点雨
  • 77.9K 的 Axios 项目有哪些值得借鉴的地方

    Axios 是一个基于 Promise 的 HTTP 客户端,同时支持浏览器和 Node.js 环境。它是一个优秀的 HTTP 客户端,被广泛地应用在大量的 W...

    ConardLi
  • axios网络交互应用-Vue

    Axios 是一个基于 promise 的 HTTP 库,可以用在浏览器和 node.js 中。

    达达前端
  • 前端网红框架的插件机制全梳理(axios、koa、redux、vuex)

    前端中的库很多,开发这些库的作者会尽可能的覆盖到大家在业务中千奇百怪的需求,但是总有无法预料到的,所以优秀的库就需要提供一种机制,让开发者可以干预插件中间的一些...

    若川
  • 面试官不要再问我axios了?我能手写简易版的axios

    axios作为我们工作中的常用的ajax请求库,作为前端工程师的我们当然是想一探究竟,axios究竟是如何去架构整个框架,中间的拦截器、适配器、 取消请求这些都...

    coder_koala
  • 面试官不要再问我axios了?我能手写简易版的axios

    axios作为我们工作中的常用的ajax请求库,作为前端工程师的我们当然是想一探究竟,axios究竟是如何去架构整个框架,中间的拦截器、适配器、 取消请求这些都...

    @超人
  • Vue中Axios的封装和API接口的管理

    回归正题,我们所要的说的axios的封装和api接口的统一管理,其实主要目的就是在帮助我们简化代码和利于后期的更新维护。

    前端老道
  • vue中Axios的封装和API接口的管理

    回归正题,我们所要的说的axios的封装和api接口的统一管理,其实主要目的就是在帮助我们简化代码和利于后期的更新维护。

    Nealyang
  • 【Web技术】920- Axios 如何取消重复请求?

    在 Web 项目开发过程中,我们经常会遇到重复请求的场景,如果系统不对重复的请求进行处理,则可能会导致系统出现各种问题。比如重复的 post 请求可能会导致服务...

    pingan8787
  • 中了源码的毒,给你一副良药

    近期阿宝哥在团队内搞了一个 「如何读源码」 的专题,主要目的是让团队的小伙伴们了解读源码的思路与技巧。在此期间,阿宝哥也写了 77.9K 的 Axios 项目有...

    若川
  • [Vue 牛刀小试]:第十五章 - 传统开发模式下的 axios 使用入门

      在没有接触 React、Angular、Vue 这类 MVVM 的前端框架之前,无法抛弃 Jquery 的重要理由,除了优秀的前端 DOM 元素操作性以外,...

    程序员宇说
  • 实现无感刷新token我是这样做的

    最近在做需求的时候,涉及到登录token,产品提出一个问题:能不能让token过期时间长一点,我频繁的要去登录。

    @超人
  • axios请求封装和异常统一处理

    当前后端分离时,权限问题的处理也和我们传统的处理方式有一点差异。笔者前几天刚好在负责一个项目的权限管理模块,现在权限管理模块已经做完了,我想通过5-6篇文章,来...

    江南一点雨
  • 前端API层架构,也许你做得还不够

    上午好,今天为大家分享下个人对于前端API层架构的一点经验和看法。架构设计是一条永远走不完的路,没有最好,只有更好。这个道理适用于软件设计的各个场景,前端API...

    Tusi
  • Vue 项目里戳中你痛点的问题及解决办法(上)

    作者:愣锤 https://juejin.im/post/5b174de8f265da6e410e0b4e

    Nealyang
  • 如何防止重复发送ajax请求

    作为一个成熟的ajax应用,它应该能自己在pending过程中选择请求拦截和请求取消

    coder_koala
  • 【总结】1023- 如何优雅的管理 HTTP 请求和响应拦截器?

    最近重构一个老项目,发现其中处理请求的拦截器写得相当乱,于是我将整个项目的请求处理层重构了,目前已经在项目中正常运行。

    pingan8787

扫码关注云+社区

领取腾讯云代金券