Axios 中断请求(AbortController、CancelToken)

1. 使用 AbortController

  • AbortControllerWeb API 的一部分,可以用来中止一个或多个 fetch 请求
  • 虽然 Axios 默认 不支持 直接使用 AbortController,但你可以通过传递 AbortController 的 signal 属性到 Axios请求 中来实现这一功能
  • 对于循环请求,你需要 为每个请求创建一个新的 AbortController 实例,并在合适的时机调用 abort 方法。
js 复制代码
const controller = new AbortController();
const { signal } = controller;

// 在你的请求中传递 signal
axios.get('/your-endpoint', { signal }).then(response => {
  // 处理响应
});

// 当需要中止请求时
controller.abort();

实例:如果有相同请求,先中断前一个

js 复制代码
const api = axios.create({
  baseURL: import.meta.env.VITE_APP_API_BASEURL,
  timeout: 1000 * 60,
})

const pendingMap = new Map() // abort 取消重复请求

function removePending(config: AxiosRequestConfig) {
  const key = `${config.method}:${config.url}:${JSON.stringify(filterNullUndefined(config.params || config.data))}`
  const abort = pendingMap.get(key)

  if (abort) {
    abort('cancel')
    pendingMap.delete(key)
  }
}

// axios实例拦截请求
api.interceptors.request.use(
  (config) => {
    // 如果有相同请求,先中断前一个
    removePending(config)
    const abortController = new AbortController()
    config.signal = abortController.signal
    pendingMap.set(
      `${config.method}:${config.url}:${JSON.stringify(filterNullUndefined(config.params || config.data))}`,
      () => abortController.abort('cancel'),
    )

    return config
  },
  (error) => {
    return Promise.reject(error)
  },
)

2. 使用 Axios 的 CancelToken

  • Axios 提供了 CancelToken 功能,可以用来取消请求。你可以创建一个 CancelToken 实例,并在请求中传递它
  • 对于循环请求,你同样需要 为每个请求创建一个新的 CancelToken 实例,并保存每个请求的 取消函数
js 复制代码
import axios from 'axios'
const CancelToken = axios.CancelToken
let cancel

axios.get('/your-endpoint', {
  cancelToken: new CancelToken((c) => {
    // 保存取消函数
    cancel = c
  }),
}).then((response) => {
  // 处理响应
})

// 当你需要取消请求时
cancel()

实例:离开页面前中断循环请求

js 复制代码
const cancel = reactive<any>({})

// 单个请求体,i为索引
function singleChunk(i: number) {
  const dId = dataId.value

  const p = () => {
    return new Promise((resolve, reject) => {
      chunkDownload({
        id: dId,
        chunk: i + 1,
      }, {
        cancelToken: new CancelToken((c) => {
          // 保存取消函数
          cancel[i + 1] = c
        }),
      }).then((info) => {
        // ....
      })
        .catch((err) => {
          reject(err)
        })
    })
  }

  return p
}

// ......................................

// 页面销毁前
onBeforeUnmount(() => {
  // 终止请求
  for (const key in cancel) {
    if (typeof (cancel[key] === 'function')) {
      cancel[key]()
    }
  }
})
相关推荐
一斤代码2 小时前
vue3 下载图片(标签内容可转图)
前端·javascript·vue
中微子2 小时前
React Router 源码深度剖析解决面试中的深层次问题
前端·react.js
光影少年2 小时前
从前端转go开发的学习路线
前端·学习·golang
中微子3 小时前
React Router 面试指南:从基础到实战
前端·react.js·前端框架
3Katrina3 小时前
深入理解 useLayoutEffect:解决 UI "闪烁"问题的利器
前端·javascript·面试
前端_学习之路4 小时前
React--Fiber 架构
前端·react.js·架构
伍哥的传说4 小时前
React 实现五子棋人机对战小游戏
前端·javascript·react.js·前端框架·node.js·ecmascript·js
qq_424409194 小时前
uniapp的app项目,某个页面长时间无操作,返回首页
前端·vue.js·uni-app
我在北京coding4 小时前
element el-table渲染二维对象数组
前端·javascript·vue.js
布兰妮甜4 小时前
Vue+ElementUI聊天室开发指南
前端·javascript·vue.js·elementui