[[390119]]

Node.js v15.0.0 提供了一個全局實用 API AbortController，用于在選定的基于 Promise API 中發(fā)出取消信號。無需引入在所有模塊中均可使用，該 API 的實現(xiàn)是基于瀏覽器中的 Web API AbortController。

簡單示例

通俗的講 AbortController 表示一個控制器對象，允許我們根據(jù)需要中止一個或多個 Web 請求。

下面是一個示例，在 1 秒后會執(zhí)行 ac.abort() 方法，將會觸發(fā) abort 事件，并且僅會觸發(fā)一次，這可通過 abortSignal.aborted 屬性查看前后改變狀態(tài)。

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。

假設(shè)這個請求需要等待 5 秒鐘，大約在 2 秒鐘后執(zhí)行 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); 
} 

中止 Promise

傳遞 ac.signal 中止一個正在運行的 Promise，這需要我們?yōu)?ac.signal 注冊一個 abort 事件，做一些處理。之后在任何地方調(diào)用 ac.abort() 中止 Promise。

使用 Promise 表示中止操作的任何 Web 平臺 APIs 都必須遵循以下原則：

• 通過一個 signal 字典成員接受 AbortSignal 對象。
• 通過 reject 一個帶有 "AbortError" DOMException 這個類的 Promise 來表示操作已中止。
• 檢查 AbortSignal 對象的 aborted 標(biāo)志是否已經(jīng)被設(shè)置，如果是則立即 reject，否則：
• 使用中止算法機制來觀察對 AbortSignal 對象的更改，并以不會導(dǎo)致與其他觀察者沖突的方式進行觀察。

以下關(guān)于 doSomeThingAsync 這個異步 Promise Function 的實現(xiàn)基本上也是遵循的這些規(guī)則。

class AbortError extends Error { 
  constructor(message) { 
    super(message); 
    this.name = 'AbortError'; 
  } 
} 
function doSomethingAsync({ ac }) { 
  return new Promise((resolve, reject) => { 
    console.log('task start...'); 
    if (ac.aborted) { 
      return reject(new AbortError('task handler failed', 'AbortError')); 
    } 
 
    const timer = setTimeout(() => { 
      console.log('task end...'); 
      resolve(1); 
    }, 5000); 
    ac.signal.addEventListener('abort', () => { 
      clearTimeout(timer); 
      reject(new AbortError('task handler failed', 'AbortError')); 
    }, { once: true });     
  }); 
} 
 
setTimeout(() => ac.abort(), 2000) 
try { 
  await doSomethingAsync({ ac }); 
} catch (err) { 
  console.error(err.name, err.message); // AbortError task handler failed 
} 

注意：在 Node.js 中目前并沒有 DOMException 這個類，我們無法這樣做 new DOMException('task handler failed', 'AbortError') 所以我在剛開始先創(chuàng)建了一個 AbortError 類來模擬。

Node.js 中已經(jīng)有一些異步 API 支持傳遞 signal，但是它的 DOMException 錯誤也是在內(nèi)部通過封裝來實現(xiàn)的：

// https://github.com/nodejs/node/blob/f6b1df2226/lib/internal/fs/promises.js#L98 
 
const lazyDOMException = hideStackFrames((message, name) => { 
  if (DOMException === undefined) 
    DOMException = internalBinding('messaging').DOMException; 
  return new DOMException(message, name); 
}); 
 
// 例如 writeFileHandle 
// https://github.com/nodejs/node/blob/f6b1df2226/lib/internal/fs/promises.js#L282 
if (signal?.aborted) { 
  throw lazyDOMException('The operation was aborted', 'AbortError'); 
} 

Reference

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

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