资讯专栏INFORMATION COLUMN

Ajax 如何保证请求接口数据符合预期?如何去重?

Darkgel / 1807人阅读

摘要:将的,和包含全部请求参数的字符串存入管理器。如满足条件,则当前请求不需要发起。如果参数不同,或者是人为操作,则视为两个不同请求。此时取消中的,并将当前请求重新注册。如果不设置此项,则只会保留最后一次,前面的请求会被掉。

先描述两个场景:

快速点击分页码1.2.3.4.5...。假设网络不好或接口速度不佳,此时可能有多个pending中请求。而我们无法控制返回顺序。假如用户最后点击到分页5,而最后一个返回的接口是第三页的。那现在虽然页码为5,但实际展示的数据却是第三页的。

以Vue为例,created中调用接口A,某watch中也调用接口A。那在页面初始化时,A可能被调用了两次,如果两次结果一致,那除了浪费,也不会造成其他严重问题。可结果不一致,会概率复现场景1中描述的问题。

解决办法其实很多,比如:

调用时加锁,判断该接口是否处于pending?

pending状态时,禁用操作按钮;

但这些方法不可避免的会引入多余状态。如果同页面出现N个接口,情况会更糟糕。如何维护那么多状态呢?

其实我们可以在拦截器中解决这些问题,直接贴代码。逻辑看注释:

以下以 axios 为例。

请求管理器

</>复制代码

  1. 多带带封装管理器,是为了拦截器中的代码逻辑更清晰,也为扩展性。假设你需要在其他地方获取所有pending中的请求,并将其全部取消。
    注意 cancel() 方法中的 this.pendings[name].source.cancel(),要想此方法有效,我们需要在register请求时,将ajax工具中包含取消请求api的对象作为 source 存入管理器。详见过滤器中代码。

</>复制代码

  1. /**
  2. * requestManage.js 请求管理器
  3. */
  4. class RequestManage {
  5. constructor () {
  6. if (!RequestManage.instance) {
  7. // 这个属性可以用来判断是人为操作,还是机器。
  8. this.nerveVelocity = 100
  9. // 进行中的请求
  10. this.pendings = {}
  11. RequestManage.instance = this
  12. }
  13. return RequestManage.instance
  14. }
  15. /**
  16. * 向管理器中注册请求
  17. * @param {String,Number} name - 请求标识
  18. * @param {*} [payload] - 负载信息,用来保存你期望管理器帮你存储的内容
  19. */
  20. register (name, payload = {}) {
  21. payload.time = new Date() * 1
  22. this.pendings[name] = payload
  23. }
  24. /**
  25. * 取消请求
  26. * @param {String,Number} name - 请求标识
  27. * @param {*} [payload] - 包含负载信息时,销毁后会重新注册
  28. */
  29. cancel (name, payload) {
  30. this.pendings[name].source.cancel()
  31. if (payload) {
  32. this.register(name, payload)
  33. }
  34. }
  35. /**
  36. * 在管理器中移除制定请求
  37. * @param {String,Number} name - 请求标识
  38. */
  39. remove (name) {
  40. delete this.pendings[name]
  41. }
  42. }
  43. export default new RequestManage()
过滤器

</>复制代码

  1. // request.js
  2. import axios from "axios
  3. import { requestManage } from "utils"
  4. const request = axios.create({
  5. timeout: 5000,
  6. headers: {
  7. "Content-Type": "application/json",
  8. "X-Requested-With": "XMLHttpRequest"
  9. }
  10. })
  11. /**------------------------------------------------
  12. * axiox request 拦截器
  13. * 整体逻辑:
  14. * 1. 使用请求地址 url 作为请求标识。
  15. * 2. 将 axios 的 source,和包含全部请求参数的字符串存入管理器。(因为source中包含axios的cancel方法)
  16. * 3. 请求发起前,查看管理器中是否已存在一个请求?如果不存在,那注册一个进去。
  17. * 4. 如果已经存在,则对比参数,及判断是否为机器。如满足条件,则当前请求不需要发起。抛出错误 currentRequestCancelled。
  18. * 5. 如果参数不同,或者是人为操作,则视为两个不同请求。此时取消 pending 中的,并将当前请求重新注册。
  19. * 6. 使用 escape 配置,人为控制一些特殊接口不受约束。
  20. */
  21. request.interceptors.request.use(config => {
  22. const { data, params, url, escape } = config
  23. const
  24. requestTime = new Date() * 1,
  25. source = axios.CancelToken.source(),
  26. currentBody = `${JSON.stringify(data)}${JSON.stringify(params)}`,
  27. pendingRequest = requestManage.pendings[url],
  28. pendingBody = pendingRequest && pendingRequest.body,
  29. isRobot = pendingRequest && requestTime - pendingRequest.time < requestManage.nerveVelocity
  30. if (pendingRequest) {
  31. if (currentBody === pendingBody && isRobot) {
  32. return Promise.reject(new Error("currentRequestCancelled"))
  33. } else if (!escape) {
  34. requestManage.cancel(url, {
  35. source: source,
  36. body: currentBody
  37. })
  38. }
  39. } else {
  40. requestManage.register(url, {
  41. source: source,
  42. body: currentBody
  43. })
  44. }
  45. config.cancelToken = source.token
  46. return config
  47. }, error => {
  48. // 请求错误时做些事
  49. return Promise.reject(error)
  50. })
  51. /** ------------------------------------------------------------
  52. * axios response 拦截器
  53. * 接口正常返回后,在管理器中把对应请求移除。
  54. * 对 request 时抛出的错误做处理。
  55. */
  56. request.interceptors.response.use(response => {
  57. const { url } = response.config
  58. requestManage.remove(url)
  59. return response
  60. }, error => {
  61. if (axios.isCancel(error)) {
  62. throw new Error("cancelled")
  63. } else if (error.message === "currentRequestCancelled") {
  64. throw new Error("currentRequestCancelled")
  65. } else {
  66. return Promise.reject(error)
  67. }
  68. })
  69. export default request
封装API

</>复制代码

  1. // api.js
  2. import request from "@/utils/request"
  3. /**
  4. * escape: true 会跳过所有约束。
  5. * 通常只有一种场景需要这么做:
  6. * 页面初始化时,相同接口同时发起多个请求,但参数不一致,且多次返回的结果都会被使用。如果不设置此项,则只会保留最后一次,前面的请求会被 cancel 掉。
  7. */
  8. export default function (params) {
  9. return request({
  10. url: `api_path`,
  11. method: "GET",
  12. params: params,
  13. // escape: true
  14. })
  15. }
使用

</>复制代码

  1. import api from "api.js"
  2. async function getData () {
  3. try {
  4. const req = await api({
  5. a:1,
  6. b:2
  7. })
  8. } catch (error) {
  9. console.log(error)
  10. }
  11. }
  12. getData()
  13. getData()
  14. getData()
  15. getData()
  16. // 多次调用,控制台中只有第一次请求完成,并打印 `currentRequestCancelled`. (因为这几次请求完全一样)
  17. // 如果不捕获错误,控制台将报 cancelled 或 currentRequestCancelled 错误。

以上仅以 Axios 为例,方法可以扩展到所有请求工具

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/103802.html

相关文章

  • JavaScript 需要检查变量类型吗

    摘要:一返回值调用外部方法获取的值需要对类型做判断,因为我们对方法返回的值是有期望值类型,但是却不能保证这个接口返回的值一直是同一个类型。 19年目标:消灭英语!我新开了一个公众号记录一个程序员学英语的历程 有提升英语诉求的小伙伴可以关注公众号:csenglish 程序员学英语,每天花10分钟交作业,跟我一起学英语吧 javascript作为一门动态类型语言,具有很高的动态灵活性,当定义函数...

    Songlcy 评论0 收藏0
  • 接口测试常见问题

    摘要:同时我们也可以使用控件来实现小型的接口自动化来提高接口测试效率。接口测试的流程首先我们要了解需求,熟悉业务场景然后根据需求文档,接口文档以及业务场景来编写测试用例。 ...

    edgardeng 评论0 收藏0
  • 初级前端开发面试总结

    摘要:前端面试总结先说背景,本人年月毕业,去年十月校招到今年月一直在做前端开发工作,年前打算换工作,就重新梳理下面试考点总结包含基础,基础,常见算法和数据结构,框架,计算机网络相关知识,可能有的点很细,有的点很大,参考个人情况进行总结,方便对知识 前端面试总结 先说背景,本人2018年7月毕业,去年十月校招到今年10月一直在做前端开发工作,年前打算换工作,就重新梳理下面试考点总结包含: ...

    jifei 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<