百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT技术 > 正文

为何说 AbortController 是前端一把利剑?

wptr33 2025-02-19 14:10 35 浏览

大家好,很高兴又见面了,我是"高级前端进阶",由我带着大家一起关注前端前沿、深入前端底层技术,大家一起进步,也欢迎大家关注、点赞、收藏、转发!

1. 通过 AbortController 提前终止 fetch

首先看一个例子,其使用 AbortController 来实现可以提前中止的 fetch:

fetchButton.onclick = async () => {
  const controller = new AbortController();
  // 添加取消按钮
  abortButton.onclick = () => controller.abort();
  try {
    const r = await fetch("/json", { signal: controller.signal});
    const json = await r.json();
    // 这里执行业务逻辑
  } catch (e) {
    const isUserAbort = e.name === "AbortError";
    // 如果是 AbortController 取消的则是 AbortError(一种 DOMException)
  }
};

上面示例展示了在 AbortController 出现之前不可能实现的事情,即 主动取消网络请求。浏览器将提前终止 fetch,从而节省用户网络带宽。当然,提前终止也不必非要由用户手动发起。

上面示例中 controller.signal 返回的是 AbortSignal,其代表一个信号对象,其允许开发者与异步操作(例如 fetch 请求)进行通信,并在需要时通过 AbortController 对象中止。

如果开发者想从多个信号中中止,可以使用 AbortSignal.any() 组合成单个信号,比如下面的示例:

try {
  const controller = new AbortController();
  const timeoutSignal = AbortSignal.timeout(5000);
  const res = await fetch(url, {
    // This will abort the fetch when either signal is aborted
    signal: AbortSignal.any([controller.signal, timeoutSignal]),
  });
  const body = await res.json();
} catch (e) {
  if (e.name === "AbortError") {
    // Notify the user of abort.
  } else if (e.name === "TimeoutError") {
    // Notify the user of timeout
  } else {
    // A network error, or some other problem.
    console.log(`Type: ${e.name}, Message: ${e.message}`);
  }
}

AbortController 和 AbortSignal 两者用途还是有一定的区别:

  • AbortController:允许通过 controller.abort() 显式中止其附加的信号
  • AbortSignal :不能直接中止,但开发者可以将其传递给 fetch() 之类的调用或直接监听其中止状态。

可以使用 signal.aborted 检查其状态,或为 abort 事件添加事件监听器,例如:fetch() 在内部执行此操作 。

if (signal.aborted) {}
signal.addEventListener('abort', () => ());

AbortController 取消请求后服务器就不会继续处理该请求,也不会发送响应,从而避免了不必要的数据传输。同时,针对客户端来说会减少并发的连接数量,提高页面的响应性能。

2.AbortController 的典型使用场景

2.1 中止 WebSocket 等传统对象

很多老版本的 DOM API 其实并不支持 AbortSignal,例如:WebSocket,其只有一个 .close() 方法用于在请求完成后关闭连接。此时,开发者可以通过下面的方式显式取消请求:

function abortableSocket(url, signal) {
  const w = new WebSocket(url);

  if (signal.aborted) {
    w.close();
    // 已经取消,直接失败
  }
  signal.addEventListener("abort", () => w.close());
  return w;
}

请注意,如果已经中止,AbortSignal 不会触发其 “abort”,因此必须检查是否已经 aborted,在这种情况下立即 .close()。

2.2 移除事件处理程序

在通过 removeEventListener 移除 DOM 事件处理函数时,开发者必须保证第二个事件处理函数是同一个。

window.addEventListener('resize', () => doSomething());
// addEventListener 和 removeEventListener 非同一个函数
window.removeEventListener('resize', () => doSomething());

有了 AbortController 后,这一切变得非常简单,开发者只需要将 signal 传递给 addEventListener 的第三个参数即可。

const controller = new AbortController();
const {signal} = controller;
window.addEventListener("resize", () => doSomething(), { signal });
// 通过. abort() 方法移除事件处理函数
controller.abort();

当然,针对旧版本的浏览器可以尝试添加 Polyfill 以支持 AbortController。

2.3 React hooks 中的异步任务

在 React 中,如果 Effect 在再次触发之前没有完成,开发者一般不容易发现,此时 Effect 会并行运行。

function FooComponent({something}) {
  useEffect(async () => {
    const j = await fetch(url + something);
    // do something with J
  }, [something]);
  return <>...<>;
}

此时,开发者可以做的是创建一个 AbortController,每当下一个 useEffect 调用运行时就中止上一个请求:

function FooComponent({something}) {
  useEffect(() => {
    const controller = new AbortController();
    const {signal} = controller;
    const p = (async () => {
      // 真正执行的逻辑
      const j = await fetch(url + something, { signal});
      // 这里处理返回值
    })();
    return () => controller.abort();
  }, [something]);
  return <>...<>;
}

3.4 取消 setTimeout

Node.js 里新版的 setTimeout 可以用 AbortController 取消,例如下面的代码:

const {setTimeout: setTimeoutPromise} = require('node:timers/promises');

const ac = new AbortController();
const signal = ac.signal;
//  这里传入了 AbortSignal
setTimeoutPromise(1000, 'foobar', { signal})
  .then(console.log)
  .catch((err) => {
    if (err.name === 'AbortError')
      console.log('The timeout was aborted');
  });
ac.abort();

不过这个 Promise 版的 setTimeout 并不传入回调,回调需要在 .then() 里或者 await 后面自己调用。

但是,浏览器的 setTimeout 目前并不支持 AbortController,可能是原因是其已经设计了更先进的 scheduler.postTask() API,该方法用于根据优先级添加要执行的任务,因此 setTimeout 没理由增强了。

// Declare a TaskController with default priority
const abortTaskController = new TaskController();
// Post task passing the controller's signal
scheduler
  .postTask(() => console.log("Task executing"), {
    signal: abortTaskController.signal,
  })
  .then((taskResult) => console.log(`${taskResult}`)) //This won't run!
  .catch((error) => console.error("Error:", error)); // Log the error
// Abort the task
abortTaskController.abort();

值得一提的是, TaskController 是 AbortController 的子级,除了可以调用 abort() 取消 task,还可以通过 setPriority() 方法中途修改 task 的优先级,如果不需要控制优先级,则可以直接使用 AbortController。

参考资料

https://samthor.au/2022/abortcontroller-is-your-friend/

https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal

https://www.zhihu.com/question/545379005/answer/2593517694

https://nodejs.org/docs/v22.11.0/api/timers.html#timers-promises-api

https://developer.mozilla.org/en-US/docs/Web/API/Scheduler/postTask

https://www.youtube.com/watch?v=1GmCHKv5TSM

相关推荐

redis的八种使用场景

前言:redis是我们工作开发中,经常要打交道的,下面对redis的使用场景做总结介绍也是对redis举报的功能做梳理。缓存Redis最常见的用途是作为缓存,用于加速应用程序的响应速度。...

基于Redis的3种分布式ID生成策略

在分布式系统设计中,全局唯一ID是一个基础而关键的组件。随着业务规模扩大和系统架构向微服务演进,传统的单机自增ID已无法满足需求。高并发、高可用的分布式ID生成方案成为构建可靠分布式系统的必要条件。R...

基于OpenWrt系统路由器的模式切换与网页设计

摘要:目前商用WiFi路由器已应用到多个领域,商家通过给用户提供一个稳定免费WiFi热点达到吸引客户、提升服务的目标。传统路由器自带的Luci界面提供了工厂模式的Web界面,用户可通过该界面配置路...

这篇文章教你看明白 nginx-ingress 控制器

主机nginx一般nginx做主机反向代理(网关)有以下配置...

如何用redis实现注册中心

一句话总结使用Redis实现注册中心:服务注册...

爱可可老师24小时热门分享(2020.5.10)

No1.看自己以前写的代码是种什么体验?No2.DooM-chip!国外网友SylvainLefebvre自制的无CPU、无操作码、无指令计数器...No3.我认为CS学位可以更好,如...

Apportable:拯救程序员,IOS一秒变安卓

摘要:还在为了跨平台使用cocos2d-x吗,拯救objc程序员的奇葩来了,ApportableSDK:FreeAndroidsupportforcocos2d-iPhone。App...

JAVA实现超买超卖方案汇总,那个最适合你,一篇文章彻底讲透

以下是几种Java实现超买超卖问题的核心解决方案及代码示例,针对高并发场景下的库存扣减问题:方案一:Redis原子操作+Lua脚本(推荐)//使用Redis+Lua保证原子性publicbo...

3月26日更新 快速施法自动施法可独立设置

2016年3月26日DOTA2有一个79.6MB的更新主要是针对自动施法和快速施法的调整本来内容不多不少朋友都有自动施法和快速施法的困扰英文更新日志一些视觉BUG修复就不翻译了主要翻译自动施...

Redis 是如何提供服务的

在刚刚接触Redis的时候,最想要知道的是一个’setnameJhon’命令到达Redis服务器的时候,它是如何返回’OK’的?里面命令处理的流程如何,具体细节怎么样?你一定有问过自己...

lua _G、_VERSION使用

到这里我们已经把lua基础库中的函数介绍完了,除了函数外基础库中还有两个常量,一个是_G,另一个是_VERSION。_G是基础库本身,指向自己,这个变量很有意思,可以无限引用自己,最后得到的还是自己,...

China&#39;s top diplomat to chair third China-Pacific Island countries foreign ministers&#39; meeting

BEIJING,May21(Xinhua)--ChineseForeignMinisterWangYi,alsoamemberofthePoliticalBureau...

移动工作交流工具Lua推出Insights数据分析产品

Lua是一个适用于各种职业人士的移动交流平台,它在今天推出了一项叫做Insights的全新功能。Insights是一个数据平台,客户可以在上面实时看到员工之间的交流情况,并分析这些情况对公司发展的影响...

Redis 7新武器:用Redis Stack实现向量搜索的极限压测

当传统关系型数据库还在为向量相似度搜索的性能挣扎时,Redis7的RedisStack...

Nginx/OpenResty详解,Nginx Lua编程,重定向与内部子请求

重定向与内部子请求Nginx的rewrite指令不仅可以在Nginx内部的server、location之间进行跳转,还可以进行外部链接的重定向。通过ngx_lua模块的Lua函数除了能实现Nginx...