Node.js v15.x 新特性 — 控制器对象 AbortController

Node.js v15.0.0 提供了一个全局实用 API AbortController，用于在选定的基于 Promise API 中发出取消信号。无需引入在所有模块中均可使用，该 API 的实现是基于浏览器中的 Web API AbortController。

简单示例

通俗的讲 AbortController 表示一个控制器对象，允许我们根据需要中止一个或多个 Web 请求。

下面是一个示例，在 1 秒后会执行 ac.abort() 方法，将会触发 abort 事件，并且仅会触发一次，这可通过 abortSignal.aborted 属性查看前后改变状态。

ac.signal.addEventListener('abort', () => {
  console.log('Aborted!');
  console.log('ac.signal.aborted:', ac.signal.aborted);
}, { once: true });
setTimeout(() => ac.abort(), 1000)
console.log('ac.signal.aborted:', ac.signal.aborted);

中止请求

Node.js 中我们可以选择使用 node-fetch 这个请求处理库，传递 signal 给 fetch。

假设这个请求需要等待 5 秒钟，大约在 2 秒钟后执行 abort() 将会中止这个请求。

const ac = new AbortController();
import fetch from 'node-fetch';

const timer = setTimeout(() => ac.abort(), 2000)
try {
  const { statusText } = await fetch('http://localhost:3000/api', { signal: ac.signal })
  console.log(statusText);
} catch (err) {
  console.log(err.name); // AbortError
} finally {
  clearTimeout(timer);
}