跳到主要内容
api工厂
JavaScript

AbortController 统一取消:fetch 超时、组件卸载清理、多请求联动

api工厂资讯栏目 约 7 分钟阅读
本文由 AI 辅助生成,内容基于公开资讯整理改写,技术细节以官方文档为准。

结论先行:AbortController 是 Web 平台统一的取消原语,一个 signal 可以挂到 fetch、流读取、事件监听乃至自定义异步任务上。fetch 超时用 AbortSignal.timeout,组件卸载清理用 useEffect 返回的 abort,多请求联动用 AbortSignal.any 合并信号。本文给出三类场景的完整写法,并讲清 AbortError 的识别、取消的边界与 SDK 封装的兼容技巧。

基本模型:controller 与 signal

AbortController 只有两个成员:signal 属性与 abort() 方法。signal 是只读的 AbortSignal,可以传给任何支持取消的 API;调用 abort(reason) 后 signal.aborted 变 true,所有订阅者收到 abort 事件。它是一次性的,abort 之后不能复位,新一轮任务要新建 controller。

js
const controller = new AbortController();
fetch('/api/list', { signal: controller.signal })
  .then((r) => r.json())
  .catch((err) => {
    if (err.name === 'AbortError') console.log('已取消');
  });
controller.abort(); // 请求立即中止,Promise 以 AbortError reject

场景一:fetch 超时

手写 setTimeout + abort 已经过时,AbortSignal.timeout 一行搞定,超时自动以 TimeoutError 中止:

js
const res = await fetch('/api/slow', { signal: AbortSignal.timeout(5000) });

如果既要超时又要手动取消,用 AbortSignal.any 合并两个信号,任一触发即取消:

js
const controller = new AbortController();
const signal = AbortSignal.any([controller.signal, AbortSignal.timeout(5000)]);
const res = await fetch('/api/slow', { signal });

这两个静态方法在主流浏览器与 Node.js 18+ 均已可用。注意区分错误类型:主动取消是 AbortError,超时是 TimeoutError,上报监控时应分开统计。

场景二:组件卸载清理

SPA 里最经典的内存泄漏与竞态:组件卸载后请求才返回,setState 落在已销毁的组件上,或者慢响应覆盖新响应。React 的标准写法是把 controller 放进 effect:

js
useEffect(() => {
  const controller = new AbortController();
  fetch('/api/detail/' + id, { signal: controller.signal })
    .then((r) => r.json())
    .then(setData)
    .catch((err) => {
      if (err.name !== 'AbortError') setError(err);
    });
  return () => controller.abort();
}, [id]);

id 变化时旧 effect 清理、旧请求中止,天然解决竞态。Vue 组合式 API 同理,在 onUnmounted 里调用 abort。事件监听也能挂信号:addEventListener('scroll', fn, { signal }),一次 abort 批量移除,比逐个 removeEventListener 干净。

场景三:多请求联动与自定义任务

页面级「全部取消」按钮、路由切换批量中止,用一个共享 controller 即可;更细的粒度用 AbortSignal.any 把页面信号与单请求超时组合。对不支持 signal 的旧 API 或第三方 Promise,可以自己订阅 abort 事件做竞态包装:

js
function cancellable(promise, signal) {
  return new Promise((resolve, reject) => {
    const onAbort = () => reject(signal.reason);
    if (signal.aborted) return onAbort();
    signal.addEventListener('abort', onAbort, { once: true });
    promise.then(resolve, reject).finally(() =>
      signal.removeEventListener('abort', onAbort)
    );
  });
}

要清醒认识取消的边界:abort 只是让本地不再等待与处理,服务端可能已经执行了写操作;它也不是暂停,不能恢复。涉及扣款、下单这类副作用,取消后仍需服务端幂等与对账兜底。

结合业务:SDK 请求的取消封装

api工厂(https://www.it120.cc/)的六端 SDK 方法统一返回 Promise、以 {code,data,msg} 的 code==0 表示成功。部分封装方法不直接暴露 signal 参数,页面切换时可以用上面的 cancellable 包装,避免旧页面响应污染新页面状态:

js
import WXAPI from 'apifm-wxapi';
WXAPI.init('your-subdomain');

const controller = new AbortController();
async function loadGoods() {
  const res = await cancellable(WXAPI.goodsList({ categoryId: 0 }), controller.signal);
  if (res.code === 0) render(res.data);
}
// 页面隐藏或切换分类时
controller.abort();

小程序端没有 fetch,但「页面卸载即放弃旧响应」的思路一致:用标记位或封装竞态即可。接口与参数可在 Playground(https://www.it120.cc/playground.html)先行验证,SDK 文档见 https://www.it120.cc/sdk/index.html 。

小结

把 AbortController 当成异步资源的「生命周期句柄」:每个页面、每次搜索、每个组件都持有自己的 controller,超时交给 AbortSignal.timeout,组合交给 AbortSignal.any,卸载时统一 abort。取消不是锦上添花,而是现代前端防竞态、防泄漏的基础设施。

文章标签

JavaScriptAbortControllerfetch请求取消前端工程

相关产品

api工厂是面向开发者的开放 SaaS 平台:开箱即用的后台管理系统 + 全端 SDK,只需前端开发即可构建小程序、App、H5 与网站。