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

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

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

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

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

相关推荐

Java常用工具类技术文档(java常用util工具类)

一、概述Java工具类(UtilityClasses)是封装了通用功能的静态方法集合,能够简化代码、提高开发效率。本文整理Java原生及常用第三方库(如ApacheCommons、GoogleG...

建议收藏!深入理解Java虚拟机:JVM垃圾回收算法+垃圾收集器

02JVM垃圾回收算法2.1什么是垃圾回收?...

Java 开发者线上问题排查常用的 15 个 Linux 命令

作为Java开发者,线上环境的问题排查是日常工作的重要组成部分。熟练掌握Linux命令能大幅提升排查效率,快速定位进程异常、日志错误、性能瓶颈等核心问题。本文结合Java应用特点,整理1...

Java-Maven详解(maven for java)

一、什么是Maven?ApacheMaven是一个软件...

java 文件操作(I/O流)(java文件流写入文件)

一、文件操作技术演进二、核心类对比分析...

如何使用Java API操作HDFS系统?(java编程操作hdfs能完成的功能有)

1.搭建项目环境打开Eclipse选择FileàNewàMavenProject创建Maven工程,选择“Createasimpleproject”选项,点击【Next】按钮,会进入“New...

那些被&quot;删除&quot;却仍占用空间的文件

在服务器运维过程中,磁盘空间不足是一个常见问题。而有时候,即使清理了大量文件,系统仍然报告磁盘几乎已满,这种情况尤为令人困惑。本文将通过一个实际案例,分享如何排查和解决Linux服务器上的"幽...

SpringBoot的Web应用开发——Web缓存利器Redis的应用!

 Web缓存利器Redis的应用Redis是目前使用非常广泛的开源的内存数据库,是一个高性能的keyvalue数据库,它支持多种数据结构,常用做缓存、消息代理和配置中心。本节将简单介绍Redis的使...

如何使用C#中的Lambda表达式操作Redis Hash结构,简化缓存中对象属性的读写操作

...

Redis 常用命令大全(redis常用命令及详解)

Redis常用命令全解析在当今的数据处理与存储领域,Redis凭借其高性能、丰富的数据结构等特性,成为了众多开发者和企业的首选内存数据库。下面将为大家详细介绍Redis的常用命令。键(Key)...

Redis+Lua脚本防超卖是万能解?这3个致命漏洞你可能没发现!

在高并发秒杀场景中,Redis+Lua脚本常被视为防止超卖的“银弹”。然而,许多开发者因对其底层逻辑理解不足,踩中了致命漏洞却不自知。本文通过真实案例剖析三个隐藏极深的问题,并提供完整解决方案,助你避...

10w qps缓存数据库——Redis(缓存技术 redis)

一、Redis数据库介绍:Redis:非关系型缓存数据库...

Redis安装及核心数据结构(redis一般安装在哪)

Redis安装官方下载地址:http://redis.io/downloadhttp://download.redis.io/releases/...

Python Redis数据库新玩法:从零到高手掌握操作技巧

介绍Redis(RemoteDictionaryServer)是一种高性能的开源内存数据库,它支持多种数据结构,如字符串、哈希、列表、集合、有序集合等,并提供了丰富的操作命令。Redis具有快速、...

redis知识总结(基础篇,可复习,可学习)

最近redis差不多看完了,前面学的也忘了好多,所以正好写篇博客复习复习。此篇介绍的是redis的基础篇,希望这篇能帮到各位大佬。...