迭代时如何突破 IAsyncEnumerable？

Question

C# 8 增加了对异步迭代器块的支持，因此您可以等待并返回 IAsyncEnumarator 而不是 IEnumerable：

public async IAsyncEnumerable<int> EnumerateAsync() {
    for (int i = 0; i < 10; i++) {
        yield return i;
        await Task.Delay(1000);
    }
}

使用如下所示的非阻塞消费代码：

await foreach (var item in EnumerateAsync()) {
    Console.WriteLine(item);
}

这将导致我的代码运行大约 10 秒。但是，有时我想在所有元素被消耗之前突破await foreach。但是，使用break，我们需要等到当前等待的Task.Delay 完成。 我们如何在不等待任何悬空异步任务的情况下立即跳出循环？

Answer 1

使用CancellationToken 是解决方案，因为这是唯一可以在您的代码中取消Task.Delay 的方法。我们在您的IAsyncEnumerable 中获取它的方式是在创建它时将其作为参数传递，所以让我们这样做：

public async IAsyncEnumerable<int> EnumerateAsync(CancellationToken cancellationToken = default) {
    for (int i = 0; i < 10; i++) {
        yield return i;
        await Task.Delay(1000, cancellationToken);
    }
}

消费方面：

// In this example the cancellation token will be caneled after 2.5 seconds
var cts = new CancellationTokenSource(TimeSpan.FromSeconds(2.5));
await foreach (var item in EnumerateAsync(cts.Token)) {
    Console.WriteLine(item);
}

当然，这将在返回 3 个元素后取消枚举，但将以 TaskCanceledException 结束，从 Task.Delay 中抛出。为了优雅地退出await foreach，我们必须抓住它并在生产端中断：

public async IAsyncEnumerable<int> EnumerateAsync(CancellationToken cancellationToken = default) {
    for (int i = 0; i < 10; i++) {
        yield return i;
        try {
            await Task.Delay(1000, cancellationToken);
        } catch (TaskCanceledException) {
            yield break;
        }
    }
}

注意

到目前为止，这仍处于预览阶段，可能会发生变化。如果您对此主题感兴趣，可以在IAsyncEnumeration 中watch a discussion of the C# language team 关于CancellationToken。