讲师中心 微信公众号
AI工具推荐 视频效率加速

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

云涛君_7828

云涛君_7828

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

|

907人浏览过

|

来源于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> 的方法中,用 await 和 yield 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 foreach 的 catch)

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

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

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

关键点:

  • 必须实现 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工具

更多
切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3729

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2468

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1420

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1358

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1436

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2398

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

4000

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

18975

2023.09.22

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn