学习
实践
活动
专区
工具
TVP
写文章
专栏首页前端皮小蛋使用 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 拦截器支持更多应用,本文提供了部分常用扩展功能的实现,感兴趣的同学可以继续挖掘补充拦截器的其他用法。

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

文章分享自微信公众号:
前端皮小蛋

本文参与 腾讯云自媒体分享计划 ,欢迎热爱写作的你一起参与!

作者:南山皮小蛋
原始发表时间:2021-05-06
如有侵权,请联系 cloudcommunity@tencent.com 删除。
登录 后参与评论
0 条评论

相关文章

  • 前端axios下载excel,并解决axios返回header无法获取所有数据的问题

    需求:通过后端接口下载excel文件,后端没有文件地址,返回二进制流文件 实现:axios(ajax类似) 主要代码: axios:设置返回数据格式为blo...

    hbbliyong
  • vue使用axios解决跨域_vue前端解决跨域的方法

    工具版本: 【vue -V】:2.9.6 ide工具:VSCode / Idea

    全栈程序员站长
  • 详述使用 IntelliJ IDEA 解决 jar 包冲突的问题

    版权声明:Follow your heart and intuition. https://...

    CG国斌
  • 详述使用 IntelliJ IDEA 解决 jar 包冲突的问题

    在实际的 Maven 项目开发中,由于项目引入的依赖过多,遇到 jar 冲突算是一个很常见的问题了。在本文中,我们就一起来看看,如何使用 IntelliJ ID...

    CG国斌
  • Nuxt使用axios跨域问题解决方法

    Nuxt 是 Vue 项目服务器端渲染(SSR)解决方案。而在使用时,就会遇到前后端分离情况下的域名或端口不一致导致的跨域问题。本文将介绍如何通过设置代理解决 ...

    用户6167509
  • axios 跨域问题_前端跨域产生的原因和解决方法

    也就是在proxyTable中写上目标地址,主要是已经重写过/api了,之后的axios请求中都不需要再添加/api,也就是

    全栈程序员站长
  • 使用封锁协议解决事务的并发问题

    丢失修改由两次事务的修改导致,比如事务 T1 修改 A,同时事务 T2 也修改 A,那么最后 A 的值将由事务 T2 的修改结果决定,这样事务 T1 的修改就没...

    wsuo
  • Java项目实践,使用ReadWriteLock解决并发问题

    在多线程的环境下,对同一份数据进行读写,会涉及到线程安全的问题。比如在一个线程读取数据的时候,另外一个线程在写数据,而导致前后数据的不一致性;一个线程在写数据的...

    用户1289394
  • 使用dbms_rectifier_diff解决高级复制中的数据冲突问题

    « Oracle基于时间点的恢复 | Blog首页 | 关于Oracle的冲突解决机制的研究 »

    数据和云01
  • Spring Boot + Vue 前后端分离开发,前端网络请求封装与配置

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

    江南一点雨
  • vue-d2admin-axios异步请求登录,先对比一下Jquery ajax, Axios, Fetch区别

    前端技术真是一个发展飞快的领域,我三年前入职的时候只有原生XHR和Jquery ajax,我们还曾被JQuery 1.9版本版本以下不支持大文件请求这个问题卡了...

    landv
  • 前端使用Vue框架解决跨域问题「建议收藏」

    现在项目开发,都实现前后端分离开发,导致前端向后端发送请求,会出现跨域错误 ;如何解决这个问题?

    全栈程序员站长
  • NodeJS链路追踪与性能优化,首杀性能提升50%

    作者:覃志强,腾讯CSIG研发工程师。 |导语 微服务开发利器,网络调用链遥测,性能遥测。开发、测试、生产多套环境的链路与性能全在掌控之中,告别打日志定位性能问...

    腾讯大讲堂
  • axios使用指南

    axios作为jquery中ajax的替代产物,越来越多的被前端工程师所使用,这个npm包的使用非常灵活和强大,并且在nodejs端和浏览器端通用,在浏览器端a...

    挥刀北上
  • android 布局 使用 viewPager 时,如何解决 和 子页面 长按滑动 冲突问题

    使用 viewPager 时,如何解决 和 子页面 长按滑动 冲突问题。 我的问题原型:      这个问题,我相信遇到的人会比较少,我是在 一个 viewPa...

    林冠宏-指尖下的幽灵
  • 使用MySQL悲观锁解决电商扣库存并发问题

    昨天写了乐观锁《使用MySQL乐观锁解决电商扣库存并发问题》,有人提出想看悲观锁,所以今天我们就说一说如何抗悲观锁解决并发问题:

    业余草
  • ahooks 是怎么解决用户多次提交问题?

    本文是深入浅出 ahooks 源码系列文章的第四篇,这个系列的目标主要有以下几点:

    GopalFeng
  • [Redis]laravel中使用Redis分布式锁解决并发问题

    应用中一个第三方接口回调会产生并发请求,单次同时推送很多条信息,出现重复入库情况,需要在入库前拦截。

    BinGo_Blog

扫码关注腾讯云开发者

领取腾讯云代金券