IAsyncEnumerable<T> 提供异步流式处理数据的能力,解决同步枚举阻塞线程的问题。通过 async yield return 生成数据,配合 await foreach 异步消费,支持取消操作,适用于大数据、文件、网络流等场景,提升性能与资源利用率。

IAsyncEnumerable<T> 是 .net 中用于表示可异步枚举的流式数据集合的接口,它允许你一边异步获取数据,一边处理这些数据,而不需要等待整个集合加载完成。这在处理大量数据、文件读取、网络流、数据库查询或实时数据推送等场景中非常有用。
为什么需要 IAsyncEnumerable?
传统的 IEnumerable<T> 在遍历数据时是同步的,如果每条数据的获取涉及 I/O 操作(如从网络或磁盘读取),就会阻塞线程。而 IAsyncEnumerable<T> 结合 await foreach,可以实现非阻塞式的数据流处理,提升响应性和资源利用率。
如何使用 IAsyncEnumerable?
定义一个返回 IAsyncEnumerable<T> 的方法,通常使用 async yield return 语法:
- 方法返回类型为 IAsyncEnumerable<T>
- 使用 [EnumeratorCancellation] 参数接收取消令牌(可选)
- 用 yield return 异步生成每一项
示例:模拟异步产生数据流
public async IAsyncEnumerable<string> GetDataAsync([EnumeratorCancellation] CancellationToken ct = default) { for (int i = 1; i <= 5; i++) { await Task.Delay(1000, ct); // 模拟异步延迟 yield return $"Item {i}"; } }
如何消费 IAsyncEnumerable?
使用 await foreach 来安全地异步遍历数据流:
await foreach (var item in GetDataAsync()) { Console.WriteLine(item); }
支持取消操作:
using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(3)); await foreach (var item in GetDataAsync(cts.Token)) { Console.WriteLine(item); }
上面代码会在 3 秒后自动取消枚举。
常见应用场景
- 从 API 流式下载数据(如分页拉取日志)
- 读取大文件或日志流,逐行处理
- 数据库中使用 EF Core 6+ 的 AsAsyncEnumerable() 查询大数据集
- SignalR 或 gRPC 中推送实时消息
EF Core 示例:
await foreach (var user in dbContext.Users .AsAsyncEnumerable() .WithCancellation(ct)) { Console.WriteLine(user.Name); }
基本上就这些。IAsyncEnumerable 让你在处理数据流时更高效、更可控,尤其适合高吞吐或资源受限的环境。合理使用它可以避免内存暴增和线程阻塞问题。