C# 异步流(async streams)的用法 - await foreach循环

畫卷琴夢 2025-12-09 00:00:00 次阅读

C# 8.0+ 引入异步流（IAsyncEnumerable）和 await foreach，支持非阻塞式异步枚举；可配合 CancellationToken 实现取消，需 C# 8.0+ 和兼容 SDK（如 net6.0）。

在 C# 8.0 及更高版本中，引入了异步流（async streams）的概念，允许你以异步方式枚举数据流。这特别适用于处理大量数据、I/O 操作或从网络、文件、数据库等逐步获取数据的场景。核心特性之一是 await foreach 循环，它可以消费实现了 IAsyncEnumerable 的异步数据源。

什么是 IAsyncEnumerable？

IAsyncEnumerable 是一个接口，表示一个可以异步枚举的序列。与传统的 IEnumerable 不同，它不会阻塞调用线程，适合用于耗时的数据读取操作。

要创建一个异步流，方法需返回 IAsyncEnumerable 并使用 yield return 配合 async IAsyncEnumerable 语法。

示例：定义一个异步流方法

以下是一个模拟逐条返回字符串的异步流：

async IAsyncEnumerable GetDataAsync()

{

    for (int i = 1; i <= 5; i++)

    {

        await Task.Delay(1000); // 模拟异步延迟

        yield return $"Item {i}";

    }

}

使用 await foreach 消费异步流

要消费上面生成的数据流，使用 await foreach 语法。它会等待每一项可用后再处理，不会阻塞主线程。

示例：使用 await foreach 遍历异步流

await foreach (var item in GetDataAsync())

{

    Console.WriteLine(item);

}

这段代码每秒输出一条信息，总共五条。整个过程是非阻塞的，适合用于 UI 应用或 Web API 中避免线程挂起。

控制异步流的取消

异步流支持取消操作。你可以通过传入 CancellationToken 来中断正在运行的流。

修改方法签名以接收 token：

async IAsyncEnumerable GetDataAsync([EnumeratorCancellation] CancellationToken ct = default)

{

    for (int i = 1; i <= 5; i++)

    {

        await Task.Delay(1000, ct); // 支持取消的延迟

        yield return $"Item {i}";

    }

}

调用时传入 token：

using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(3));

await foreach (var item in GetDataAsync(cts.Token))

{

    Console.WriteLine(item);

}

三秒后循环将被取消，防止继续执行。