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 属性查看前后改变状态。

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

中止请求

 

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

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

1. const ac = new AbortController(); 
2. import fetch from 'node-fetch'; 
3.  
4. const timer = setTimeout(() => ac.abort(), 2000) 
5. try { 
6.   const { statusText } = await fetch('http://localhost:3000/api', { signal: ac.signal }) 
7.   console.log(statusText); 
8. } catch (err) { 
9.   console.log(err.name); // AbortError 
10. } finally { 
11.   clearTimeout(timer); 
12. } 

中止 Promise

 

传递 ac.signal 中止一个正在运行的 Promise，这需要我们为 ac.signal 注册一个 abort 事件，做一些处理。之后在任何地方调用 ac.abort() 中止 Promise。

使用 Promise 表示中止操作的任何 Web 平台 APIs 都必须遵循以下原则：

• 通过一个 signal 字典成员接受 AbortSignal 对象。
• 通过 reject 一个带有 "AbortError" DOMException 这个类的 Promise 来表示操作已中止。
• 检查 AbortSignal 对象的 aborted 标志是否已经被设置，如果是则立即 reject，否则：
• 使用中止算法机制来观察对 AbortSignal 对象的更改，并以不会导致与其他观察者冲突的方式进行观察。

以下关于 doSomeThingAsync 这个异步 Promise Function 的实现基本上也是遵循的这些规则。

1. class AbortError extends Error { 
2.   constructor(message) { 
3.     super(message); 
4.     this.name = 'AbortError'; 
5.   } 
6. } 
7. function doSomethingAsync({ ac }) { 
8.   return new Promise((resolve, reject) => { 
9.     console.log('task start...'); 
10.     if (ac.aborted) { 
11.       return reject(new AbortError('task handler failed', 'AbortError')); 
12.     } 
13.  
14.     const timer = setTimeout(() => { 
15.       console.log('task end...'); 
16.       resolve(1); 
17.     }, 5000); 
18.     ac.signal.addEventListener('abort', () => { 
19.       clearTimeout(timer); 
20.       reject(new AbortError('task handler failed', 'AbortError')); 
21.     }, { once: true });     
22.   }); 
23. } 
24.  
25. setTimeout(() => ac.abort(), 2000) 
26. try { 
27.   await doSomethingAsync({ ac }); 
28. } catch (err) { 
29.   console.error(err.name, err.message); // AbortError task handler failed 
30. } 

注意：在 Node.js 中目前并没有 DOMException 这个类，我们无法这样做 new DOMException('task handler failed', 'AbortError') 所以我在刚开始先创建了一个 AbortError 类来模拟。

Node.js 中已经有一些异步 API 支持传递 signal，但是它的 DOMException 错误也是在内部通过封装来实现的：

1. // https://github.com/nodejs/node/blob/f6b1df2226/lib/internal/fs/promises.js#L98 
2.  
3. const lazyDOMException = hideStackFrames((message, name) => { 
4.   if (DOMException === undefined) 
5.     DOMException = internalBinding('messaging').DOMException; 
6.   return new DOMException(message, name); 
7. }); 
8.  
9. // 例如 writeFileHandle 
10. // https://github.com/nodejs/node/blob/f6b1df2226/lib/internal/fs/promises.js#L282 
11. if (signal?.aborted) { 
12.   throw lazyDOMException('The operation was aborted', 'AbortError'); 
13. } 

Reference

https://dom.spec.whatwg.org/#abortcontroller-api-integration

https://nodejs.org/docs/latest-v15.x/api/globals.htm

原文地址：https://mp.weixin.qq.com/s/AM6ejivpPHjiM9bTyAOc9g