0

0

C# 异步流IAsyncEnumerable实现方法 C#如何自定义异步迭代器

月夜之吻

月夜之吻

发布时间:2026-03-16 09:09:13

|

867人浏览过

|

来源于php中文网

原创

IAsyncEnumerable 不能直接 new,因其是只读接口且无公开构造函数,必须由编译器从 async + yield return 方法自动生成状态机;手动实现易出错且丢失取消、异常、清理保障。

c# 异步流iasyncenumerable实现方法 c#如何自定义异步迭代器

为什么 IAsyncEnumerable<t></t> 不能直接 new

因为 IAsyncEnumerable<t></t> 是只读接口,没有公开构造函数,也不能手动实现其内部状态机。你无法通过 new 或继承来“造一个”——它必须由编译器从 async enumerable 方法(即返回 IAsyncEnumerable<t></t>async 方法)自动编译生成状态机。试图手写 GetAsyncEnumerator() 实现极易出错,且丢失编译器对取消、异常传播、资源清理的保障。

yield return + async 写最简自定义异步迭代器

这是官方推荐、最安全、也最常用的方式:在返回 IAsyncEnumerable<t></t> 的方法中,用 awaityield return 混合编写。编译器会将其转换为基于 AsyncIteratorStateMachine 的高效实现。

示例:从 API 分页拉取日志,每页异步等待:

public async IAsyncEnumerable<LogEntry> ReadLogsAsync([EnumeratorCancellation] CancellationToken ct = default)
{
    int page = 0;
    while (true)
    {
        var pageData = await _httpClient.GetFromJsonAsync<LogPage>($"/api/logs?page={page}", ct);
        if (!pageData.Items.Any()) break;
<pre class="brush:php;toolbar:false;">    foreach (var item in pageData.Items)
    {
        yield return item; // 同步产出
    }

    page++;
    await Task.Delay(100, ct); // 模拟节流
}

}

  • [EnumeratorCancellation] 必须加在 CancellationToken 参数上,否则调用方用 WithCancellation(ct) 时取消信号不会传入迭代器体
  • 所有 await 表达式都受该 CancellationToken 约束(前提是底层 API 正确支持)
  • yield return 是同步的,不引入额外 await;真正异步发生在 await 表达式处
  • 方法体中抛出的异常会原样传递给消费者(如 await foreachcatch

什么时候不该用 yield return?改用手动实现 IAsyncEnumerator<t></t>

极少数场景下需要精细控制生命周期,比如:复用已有异步枚举器实例、与非托管资源绑定、或需在 DisposeAsync() 中执行特定清理逻辑。这时可手动实现 IAsyncEnumerator<t></t>,再包装成 IAsyncEnumerable<t></t>

Tweeze
Tweeze

Tweeze.app是一个AI驱动的个性化新闻简报服务,定位为个人互联网AI阅读助手

下载

关键点:

  • 必须实现 IAsyncDisposable,并在 DisposeAsync() 中释放资源(如关闭网络流、取消后台任务)
  • MoveNextAsync() 返回 ValueTask<bool></bool>,避免无谓分配;若内部逻辑本身是同步完成的,应直接返回 ValueTask.FromResult(true/false)
  • 不要在 Current 属性里做异步操作——它必须是同步获取
  • 手动实现不自动支持 [EnumeratorCancellation],需自行把 CancellationToken 传入构造并参与每个 await

这类实现容易漏掉 DisposeAsync 调用链或状态竞争,除非有明确性能/控制需求,否则优先走 yield return 路线。

await foreach 消费时的隐含行为和坑

消费者看似简单,但有几个关键细节常被忽略:

  • 每次循环迭代前,await foreach 会检查 CancellationToken 是否已触发(如果用了 WithCancellation(ct)),但**不会主动中断当前正在执行的 MoveNextAsync()** —— 中断是否生效,完全取决于你迭代器内部的 await 是否响应了该 token
  • 如果迭代器中 await 的操作不接受 CancellationToken(如某些老 SDK 的 API),那么 WithCancellation 就形同虚设
  • await foreach 隐式调用 DisposeAsync(),但如果循环提前 break 或发生异常,仍会确保调用;不过若消费者忘了用 await foreach 而是直接调用 GetAsyncEnumerator(),就可能泄漏资源
  • 不要在 await foreach 循环体内修改正在迭代的集合(即使它是异步流)——这不是线程安全问题,而是语义错误:流本身不可变,但你的消费逻辑若触发了流的重新生成或重置,会导致行为不可预测

异步流的复杂性不在语法,而在取消传播路径、资源生命周期和异常边界的对齐;写的时候多看一眼 CancellationToken 是否真正贯穿到底,比优化 yield 逻辑更重要。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
php中foreach用法
php中foreach用法

本专题整合了php中foreach用法的相关介绍,阅读专题下面的文章了解更多详细教程。

268

2025.12.04

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6659

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

845

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

1092

2023.12.21

token什么意思
token什么意思

token是一种用于表示用户权限、记录交易信息、支付虚拟货币的数字货币。可以用来在特定的网络上进行交易,用来购买或出售特定的虚拟货币,也可以用来支付特定的服务费用。想了解更多token什么意思的相关内容可以访问本专题下面的文章。

2218

2024.03.01

java中break的作用
java中break的作用

本专题整合了java中break的用法教程,阅读专题下面的文章了解更多详细内容。

120

2025.10.15

java break和continue
java break和continue

本专题整合了java break和continue的区别相关内容,阅读专题下面的文章了解更多详细内容。

262

2025.10.24

java中break的作用
java中break的作用

本专题整合了java中break的用法教程,阅读专题下面的文章了解更多详细内容。

120

2025.10.15

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 11.4万人学习

C 教程
C 教程

共75课时 | 5.5万人学习

C++教程
C++教程

共115课时 | 22.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号