Node.js 中的 events.addAbortListener(signal,listener) 函数

Node.js 中的 events.addAbortListener(signal, listener) 是一个相对较新的功能，旨在帮助开发者更好地处理信号-监听器交互。它最适用于那些可能需要根据某个信号（例如 AbortController 信号）来取消或中止操作或事件的长时间运行的异步操作。

Node.js 中的中止信号 (Abort Signals)

让我们深入了解 events.addAbortListener 的详细信息，并从关于中止信号的通用讨论开始，以及 Node.js 如何应用它们。中止信号通常由 AbortSignal 接口的一个实例表示。该接口是更广泛的 AbortController API 的一部分，该 API 定义了一种在 JavaScript 中中止或取消异步任务或操作的机制。AbortController 可应用于 Node.js 和 Web 浏览器环境。

AbortController 是生成 AbortSignal 的对象。您可以创建一个信号，然后可以监听该信号以中止（即取消）某个进程。当您想取消一个 fetch 请求、任何长时间运行的任务，甚至是一个流操作（当某个特定条件变为真时）时，它特别有用。

AbortController 和 AbortSignal 的示例

这是一个展示 AbortController 用法的基本示例。

输出

说明

当调用 controller.abort() 函数时，会向信号发出 abort 事件，并且任何注册用于处理该事件的监听器都会被调用。在此示例中，监听器只是向控制台记录一条消息。

events.addAbortListener 概览

events.addAbortListener(signal, listener) 方法应该尽可能简化添加中止信号监听器的过程。它封装了 Node.js 提供的标准事件发出机制，并结合了 AbortController 和 AbortSignal 处理中止信号的能力。这样，当发送中止信号时，相应的监听器将自动执行。

语法

events.addAbortListener 函数具有以下签名：

参数

• Signal： 这是 AbortSignal 中的一个对象。该信号创建 AbortController API，并在中止时可作为信号传递给监听器。
• Listener： 当发出中止信号时要执行的 函数。监听器函数通常会执行清理程序、取消其他正在运行的进程，或将操作被取消的情况报告给应用程序的其他部分。

主要优势

简化的中止处理：您可以使用此函数直接将中止信号与监听器关联起来，而不是手动使用 addEventListener 方法在中止信号上附加监听器。

• 更简洁的代码： 这种方法减少了处理中止事件时常用的样板代码，提高了可读性。
• 自动清理： 每当监听器被激活时，像 events.addAbortListener 这样的函数会确保监听器自动清理，从而最大限度地减少内存泄漏的发生。

events.addAbortListener 的实际应用

当您使用需要根据特定条件取消或中止的长时间运行或异步任务时，events.addAbortListener 函数非常有用。

示例 1：取消文件下载操作

如果您正在编写一个下载器应用程序，并且需要能够根据用户意愿取消从服务器下载的文件。使用 events.addAbortListener 可以更简洁优雅地处理中止信号。

输出

说明

• 在此示例中，我们使用 events.addAbortListener 函数为中止信号注册一个监听器。
• 如果用户尝试触发中止操作（在我们的测试用例中，通过超时模拟），监听器将被调用，并且文件流将被关闭。
• 它会在收到中止信号后终止所有后续的文件写入操作。

示例 2：取消一个非常耗时的计算

另一个用例是在不再需要用户进行耗时计算（例如数据处理）时中止它。

输出