57

下面调用的所有四个函数作为update回报承诺。

async function update() {
   var urls = await getCdnUrls();
   var metadata = await fetchMetaData(urls);
   var content = await fetchContent(metadata);
   await render(content);
   return;
}

如果我们想在任何给定时间从外部中止序列怎么办?

例如,在fetchMetaData执行时,我们意识到我们不再需要渲染组件,我们想取消剩余的操作(fetchContentrender)。有没有办法从update函数外部中止/取消这些操作?

我们可以在每个 之后检查一个条件await,但这似乎是一个不优雅的解决方案,即使这样我们也必须等待当前操作完成。

4

10 回答 10

44

现在执行此操作的标准方法是通过 AbortSignals

async function update({ signal } = {}) {
   // pass these to methods to cancel them internally in turn
   // this is implemented throughout Node.js and most of the web platform
   try {
     var urls = await getCdnUrls({ signal });
     var metadata = await fetchMetaData(urls);
     var content = await fetchContent(metadata);
     await render(content);
   } catch (e) {
      if(e.name !== 'AbortError') throw e;
   }
   return;
}
// usage
const ac = new AbortController();
update({ signal: ac.signal });
ac.abort(); // cancel the update

OLD 2016 内容如下,小心龙

我刚刚讨论了这个——这是一个很好的话题,但遗憾的是你不会真正喜欢我要提出的解决方案,因为它们是网关解决方案。

规范为您做什么

取消“恰到好处”实际上非常困难。人们已经为此工作了一段时间,并决定不阻止异步功能。

在 ECMAScript 核心中有两个提议试图解决这个问题:

  • 取消令牌- 添加旨在解决此问题的取消令牌。
  • 可取消的承诺- 添加旨在解决此问题的catch cancel (e) { 语法和语法。throw.cancel

这两项提案在上周发生了重大变化,因此我不会指望任何一个会在明年左右到达。这些建议有些互补,并不矛盾。

你可以做些什么来从你身边解决这个问题

取消令牌很容易实现。遗憾的是,由于您无法控制它们的运行方式,因此目前异步函数不可能实现您真正想要的那种取消(又名“第三状态取消,其中取消也不例外)。您可以做两件事:

  • 改用协程 - bluebird使用您可以使用的生成器和承诺提供声音消除功能。
  • 实现带有中止语义的标记 - 这实际上很容易,所以让我们在这里做

取消令牌

好吧,令牌表示取消:

class Token {
   constructor(fn) {
      this.isCancellationRequested = false; 
      this.onCancelled = []; // actions to execute when cancelled
      this.onCancelled.push(() => this.isCancellationRequested = true);
      // expose a promise to the outside
      this.promise = new Promise(resolve => this.onCancelled.push(resolve));
      // let the user add handlers
      fn(f => this.onCancelled.push(f));
   }
   cancel() { this.onCancelled.forEach(x => x); }
}

这将使您可以执行以下操作:

async function update(token) {
   if(token.isCancellationRequested) return;
   var urls = await getCdnUrls();
   if(token.isCancellationRequested) return;
   var metadata = await fetchMetaData(urls);
   if(token.isCancellationRequested) return;
   var content = await fetchContent(metadata);
   if(token.isCancellationRequested) return;
   await render(content);
   return;
}

var token = new Token(); // don't ned any special handling here
update(token);
// ...
if(updateNotNeeded) token.cancel(); // will abort asynchronous actions

这是一种非常丑陋的工作方式,最好是您希望异步函数意识到这一点,但它们还没有()。

最理想的情况是,您的所有临时函数都会知道并会throw在取消时(再次,只是因为我们不能拥有第三状态),看起来像:

async function update(token) {
   var urls = await getCdnUrls(token);
   var metadata = await fetchMetaData(urls, token);
   var content = await fetchContent(metadata, token);
   await render(content, token);
   return;
}

由于我们的每个函数都具有取消意识,它们可以执行实际getCdnUrls的逻辑取消 - 可以中止请求并抛出,fetchMetaData可以中止底层请求并抛出等等。

以下是在浏览器中使用 API编写getCdnUrl(注意单数)的方式:XMLHttpRequest

function getCdnUrl(url, token) {
    var xhr = new XMLHttpRequest();
    xhr.open("GET", url);
    var p = new Promise((resolve, reject) => {
      xhr.onload = () => resolve(xhr);
      xhr.onerror = e => reject(new Error(e));
      token.promise.then(x => { 
        try { xhr.abort(); } catch(e) {}; // ignore abort errors
        reject(new Error("cancelled"));
      });
   });
   xhr.send();
   return p;
}

这与我们在没有协程的情况下使用异步函数所能达到的一样接近。它不是很漂亮,但它肯定是可用的。

请注意,您希望避免将取消视为例外。这意味着如果您的函数throw取消,您需要在全局错误处理程序process.on("unhandledRejection", e => ...等上过滤这些错误。

于 2016-06-05T12:46:26.037 回答
5

你可以使用 Typescript + Bluebird + cancelable-awaiter得到你想要的。

现在所有证据都表明取消令牌没有进入 ECMAScript,我认为取消的最佳解决方案是@BenjaminGruenbaum提到的蓝鸟实现,但是,我发现协同程序和生成器的使用有点笨拙和不安.

因为我使用的是 Typescript,它现在支持 es5 和 es3 目标的 async/await 语法,所以我创建了一个简单的模块,用__awaiter支持蓝鸟取消的模块替换默认帮助器:https ://www.npmjs.com/package /cancelable-awaiter

于 2016-12-24T16:22:27.640 回答
4

不幸的是,不,您无法控制默认异步/等待行为的执行流程——这并不意味着问题本身是不可能的,这意味着您需要稍微改变您的方法。

首先,您关于将每个异步行包装在检查中的建议是一个可行的解决方案,如果您只有几个具有此类功能的地方,那么它没有任何问题。

如果您想经常使用这种模式,最好的解决方案可能是切换到生成器:虽然不是那么普遍,但它们允许您定义每个步骤的行为,并且添加取消是最简单的。生成器非常强大,但是,正如我已经提到的,它们需要一个运行器函数,而不是像 async/await 那样简单。

另一种方法是创建可取消标记模式——您创建一个对象,该对象将填充一个想要实现此功能的函数:

async function updateUser(token) {
  let cancelled = false;

  // we don't reject, since we don't have access to
  // the returned promise
  // so we just don't call other functions, and reject
  // in the end
  token.cancel = () => {
    cancelled = true;
  };

  const data = await wrapWithCancel(fetchData)();
  const userData = await wrapWithCancel(updateUserData)(data);
  const userAddress = await wrapWithCancel(updateUserAddress)(userData);
  const marketingData = await wrapWithCancel(updateMarketingData)(userAddress);

  // because we've wrapped all functions, in case of cancellations
  // we'll just fall through to this point, without calling any of
  // actual functions. We also can't reject by ourselves, since
  // we don't have control over returned promise
  if (cancelled) {
    throw { reason: 'cancelled' };
  }

  return marketingData;

  function wrapWithCancel(fn) {
    return data => {
      if (!cancelled) {
        return fn(data);
      }
    }
  }
}

const token = {};
const promise = updateUser(token);
// wait some time...
token.cancel(); // user will be updated any way

我写过关于取消和生成器的文章:

总而言之——你必须做一些额外的工作来支持取消,如果你想让它在你的应用程序中成为一等公民,你必须使用生成器。

于 2018-05-12T07:32:27.803 回答
2

这是一个带有承诺的简单示例:

let resp = await new Promise(function(resolve, reject) {
    // simulating time consuming process
    setTimeout(() => resolve('Promise RESOLVED !'), 3000);
    // hit a button to cancel the promise
    $('#btn').click(() => resolve('Promise CANCELED !'));
});

请参阅此codepen以获取演示

于 2019-08-27T17:49:19.003 回答
1

不幸的是,到目前为止还没有对cancellable承诺的支持。有一些自定义实现,例如

扩展/包装可取消和可解决的承诺


function promisify(promise) {
  let _resolve, _reject

  let wrap = new Promise(async (resolve, reject) => {
    _resolve = resolve
    _reject = reject
    let result = await promise
    resolve(result)
  })

  wrap.resolve = _resolve
  wrap.reject = _reject
    
  return wrap
}

用法:取消promise并在它之后立即停止进一步执行

async function test() {
  // Create promise that should be resolved in 3 seconds
  let promise = new Promise(resolve => setTimeout(() => resolve('our resolved value'), 3000))
  
  // extend our promise to be cancellable
  let cancellablePromise = promisify(promise)
  
  // Cancel promise in 2 seconds.
  // if you comment this line out, then promise will be resolved.
  setTimeout(() => cancellablePromise.reject('error code'), 2000)

  // wait promise to be resolved
  let result = await cancellablePromise
  
  // this line will never be executed!
  console.log(result)
}

在这种方法中,promise 本身会一直执行到最后,但是等待 promise 结果的调用者代码可以被“取消”。

于 2020-12-25T21:07:12.137 回答
1

使用 CPromise(c-promise2 包)可以通过以下方式轻松完成(演示):

import CPromise from "c-promise2";

async function getCdnUrls() {
  console.log(`task1:start`);
  await CPromise.delay(1000);
  console.log(`task1:end`);
}

async function fetchMetaData() {
  console.log(`task2:start`);
  await CPromise.delay(1000);
  console.log(`task2:end`);
}

function* fetchContent() {
  // using generators is the recommended way to write asynchronous code with CPromise
  console.log(`task3:start`);
  yield CPromise.delay(1000);
  console.log(`task3:end`);
}

function* render() {
  console.log(`task4:start`);
  yield CPromise.delay(1000);
  console.log(`task4:end`);
}

const update = CPromise.promisify(function* () {
  var urls = yield getCdnUrls();
  var metadata = yield fetchMetaData(urls);
  var content = yield* fetchContent(metadata);
  yield* render(content);
  return 123;
});

const promise = update().then(
  (v) => console.log(`Done: ${v}`),
  (e) => console.warn(`Fail: ${e}`)
);

setTimeout(() => promise.cancel(), 2500);

控制台输出:

task1:start 
task1:end 
task2:start 
task2:end 
task3:start 
Fail: CanceledError: canceled 
于 2020-12-26T00:21:47.977 回答
0

就像在常规代码中一样,您应该从第一个函数(或接下来的每个函数)抛出一个异常,并在整个调用集周围设置一个 try 块。无需额外的 if-else。这是关于 async/await 的优点之一,您可以按照我们习惯于常规代码的方式处理错误。

无需取消其他操作。在解释器遇到它们的表达式之前,它们实际上不会开始。所以第二个异步调用只会在第一个完成后开始,没有错误。其他任务可能有机会同时执行,但出于所有意图和目的,这部分代码是串行的,并将按所需的顺序执行。

于 2016-06-04T13:02:36.160 回答
0

我发布的这个答案可能会帮助您将函数重写为:

async function update() {
   var get_urls = comPromise.race([getCdnUrls()]);
   var get_metadata = get_urls.then(urls=>fetchMetaData(urls));
   var get_content = get_metadata.then(metadata=>fetchContent(metadata);
   var render = get_content.then(content=>render(content));
   await render;
   return;
}

// this is the cancel command so that later steps will never proceed:
get_urls.abort();

但是我还没有实现“类保留”then功能,所以目前你必须包装你希望能够取消的每个部分comPromise.race

于 2020-08-06T16:40:37.423 回答
0

我创建了一个名为@kaisukez/cancellation-token的库

这个想法是将 a 传递CancellationToken给每个异步函数,然后将每个 Promise 包装在AsyncCheckpoint. 这样当令牌被取消时,您的异步功能将在下一个检查点被取消。

这个想法来自tc39/proposal-cancelable-promises conradreuter/cancellationtoken


如何使用我的图书馆

  1. 重构你的代码
// from this
async function yourFunction(param1, param2) {
    const result1 = await someAsyncFunction1(param1)
    const result2 = await someAsyncFunction2(param2)
    return [result1, result2]
}

// to this
import { AsyncCheckpoint } from '@kaisukez/cancellation-token'
async function yourFunction(token, param1, param2) {
    const result1 = await AsyncCheckpoint.after(token, () => someAsyncFunction1(param1))
    const result2 = await AsyncCheckpoint.after(token, () => someAsyncFunction2(param2))
    return [result1, result2]
}
  1. 创建一个令牌,然后使用该令牌调用您的函数
import { CancellationToken, CancellationError } from '@kaisukez/cancellation-token'

const [token, cancel] = CancellationToken.source()

// spawn background task (run async function without using `await`)
CancellationError.ignoreAsync(() => yourAsyncFunction(token, param1, param2))

// ... do something ...

// then cancel the background task
await cancel()

所以这是OP问题的解决方案。

import { CancellationToken, CancellationError, AsyncCheckpoint } from '@kaisukez/cancellation-token'

async function update(token) {
   var urls = await AsyncCheckpoint.after(token, () => getCdnUrls());
   var metadata = await AsyncCheckpoint.after(token, () => fetchMetaData(urls));
   var content = await AsyncCheckpoint.after(token, () => fetchContent(metadata));
   await AsyncCheckpoint.after(token, () => render(content));
   return;
}

const [token, cancel] = CancellationToken.source();

// spawn background task (run async function without using `await`)
CancellationError.ignoreAsync(() => update(token))

// ... do something ...

// then cancel the background task
await cancel()
于 2021-10-11T18:55:08.203 回答
-1

用 Node 编写的示例,带有可以从外部中止的调用的 Typescript:

function cancelable(asyncFunc: Promise<void>): [Promise<void>, () => boolean] {
  class CancelEmitter extends EventEmitter { }

  const cancelEmitter = new CancelEmitter();
  const promise = new Promise<void>(async (resolve, reject) => {

    cancelEmitter.on('cancel', () => {
      resolve();
    });

    try {
      await asyncFunc;
      resolve();
    } catch (err) {
      reject(err);
    }

  });

  return [promise, () => cancelEmitter.emit('cancel')];
}

用法:

const asyncFunction = async () => {
  // doSomething
}

const [promise, cancel] = cancelable(asyncFunction());

setTimeout(() => {
  cancel();
}, 2000);

(async () => await promise)();
于 2019-08-29T20:52:16.573 回答