建站
咨詢
售后
建站咨詢
新聞中心
Node.js v15.0.0 提供了一個(gè)全局實(shí)用 API AbortController，用于在選定的基于 Promise API 中發(fā)出取消信號(hào)。無(wú)需引入在所有模塊中均可使用，該 API 的實(shí)現(xiàn)是基于瀏覽器中的 Web API AbortController。
成都創(chuàng)新互聯(lián)公司是一家從事企業(yè)網(wǎng)站建設(shè)、成都做網(wǎng)站、成都網(wǎng)站制作、成都外貿(mào)網(wǎng)站建設(shè)、行業(yè)門(mén)戶網(wǎng)站建設(shè)、網(wǎng)頁(yè)設(shè)計(jì)制作的專業(yè)網(wǎng)站制作公司，擁有經(jīng)驗(yàn)豐富的網(wǎng)站建設(shè)工程師和網(wǎng)頁(yè)設(shè)計(jì)人員，具備各種規(guī)模與類型網(wǎng)站建設(shè)的實(shí)力，在網(wǎng)站建設(shè)領(lǐng)域樹(shù)立了自己獨(dú)特的設(shè)計(jì)風(fēng)格。自公司成立以來(lái)曾獨(dú)立設(shè)計(jì)制作的站點(diǎn)上1000+。
簡(jiǎn)單示例
通俗的講 AbortController 表示一個(gè)控制器對(duì)象，允許我們根據(jù)需要中止一個(gè)或多個(gè) Web 請(qǐng)求。
下面是一個(gè)示例，在 1 秒后會(huì)執(zhí)行 ac.abort() 方法，將會(huì)觸發(fā) abort 事件，并且僅會(huì)觸發(fā)一次，這可通過(guò) 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);
中止請(qǐng)求
Node.js 中我們可以選擇使用 node-fetch 這個(gè)請(qǐng)求處理庫(kù)，傳遞 signal 給 fetch。
假設(shè)這個(gè)請(qǐng)求需要等待 5 秒鐘，大約在 2 秒鐘后執(zhí)行 abort() 將會(huì)中止這個(gè)請(qǐng)求。
- 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 中止一個(gè)正在運(yùn)行的 Promise，這需要我們?yōu)?ac.signal 注冊(cè)一個(gè) abort 事件，做一些處理。之后在任何地方調(diào)用 ac.abort() 中止 Promise。
使用 Promise 表示中止操作的任何 Web 平臺(tái) APIs 都必須遵循以下原則：
- 通過(guò)一個(gè) signal 字典成員接受 AbortSignal 對(duì)象。
- 通過(guò) reject 一個(gè)帶有 "AbortError" DOMException 這個(gè)類的 Promise 來(lái)表示操作已中止。
- 檢查 AbortSignal 對(duì)象的 aborted 標(biāo)志是否已經(jīng)被設(shè)置，如果是則立即 reject，否則：
- 使用中止算法機(jī)制來(lái)觀察對(duì) AbortSignal 對(duì)象的更改，并以不會(huì)導(dǎo)致與其他觀察者沖突的方式進(jìn)行觀察。
以下關(guān)于 doSomeThingAsync 這個(gè)異步 Promise Function 的實(shí)現(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 中目前并沒(méi)有 DOMException 這個(gè)類，我們無(wú)法這樣做 new DOMException('task handler failed', 'AbortError') 所以我在剛開(kāi)始先創(chuàng)建了一個(gè) AbortError 類來(lái)模擬。
Node.js 中已經(jīng)有一些異步 API 支持傳遞 signal，但是它的 DOMException 錯(cuò)誤也是在內(nèi)部通過(guò)封裝來(lái)實(shí)現(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
新聞標(biāo)題：Node.js v15.x 新特性 — 控制器對(duì)象 AbortController
文章分享：http://www.fisionsoft.com.cn/article/dphdpsd.html
