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

来源:这里教程网 时间:2026-02-21 17:32:59 作者:

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

IAsyncEnumerable<t></t>
的异步数据源。

什么是 IAsyncEnumerable

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

要创建一个异步流,方法需返回

IAsyncEnumerable<t></t>
并使用
yield return
配合
async IAsyncEnumerable
语法。

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

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

async IAsyncEnumerable<string> GetDataAsync()<br/>
{<br/>
    for (int i = 1; i <= 5; i++)<br/>
    {<br/>
        await Task.Delay(1000); // 模拟异步延迟<br/>
        yield return $"Item {i}";<br/>
    }<br/>
}

使用 await foreach 消费异步流

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

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

await foreach (var item in GetDataAsync())<br/>
{<br/>
    Console.WriteLine(item);<br/>
}

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

控制异步流的取消

异步流支持取消操作。你可以通过传入

CancellationToken
来中断正在运行的流。

修改方法签名以接收 token:

async IAsyncEnumerable<string> GetDataAsync([EnumeratorCancellation] CancellationToken ct = default)<br/>
{<br/>
    for (int i = 1; i <= 5; i++)<br/>
    {<br/>
        await Task.Delay(1000, ct); // 支持取消的延迟<br/>
        yield return $"Item {i}";<br/>
    }<br/>
}

调用时传入 token:

using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(3));<br/>
await foreach (var item in GetDataAsync(cts.Token))<br/>
{<br/>
    Console.WriteLine(item);<br/>
}

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

注意事项和使用建议

确保项目 SDK 支持 C# 8.0 或更高版本(如
netstandard2.1
net6.0
await foreach
只能在
async
方法中使用
若不需要异步生成数据,仍应使用普通
foreach
IEnumerable<t></t>
在 ASP.NET Core 等环境中,异步流可用于 Streaming API 响应,提升性能和响应性

基本上就这些。await foreach 让你能够自然地处理异步数据流,写法简洁,逻辑清晰,是现代 C# 异步编程的重要补充。不复杂但容易忽略细节,比如取消支持和编译器要求。

相关推荐