TaskCompletionSource 是 C# 中把“回调式异步操作”包装成 Task、从而支持 await 的核心工具。它不执行任何异步逻辑,只负责手动控制一个 Task 的完成状态(成功、失败、取消)。什么时候需要 TaskCompletionSource常见于以下场景:调用老式 API(比如基于事件或">

C# TaskCompletionSource的用法 - 将回调模式转换为async/await

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

c# taskcompletionsource<t>的用法 - 将回调模式转换为async/await - php中文网

TaskCompletionSource 是 C# 中把“回调式异步操作”包装成

Task<t></t>
、从而支持
await
的核心工具。它不执行任何异步逻辑,只负责手动控制一个
Task
的完成状态(成功、失败、取消)。

什么时候需要 TaskCompletionSource

常见于以下场景:

调用老式 API(比如基于事件或回调的 SDK,如 WebSocket.OnMessage、HttpClient.SendAsync 的旧封装) 需要自己定义异步契约,比如实现超时控制、延迟触发、信号等待(类似 ManualResetEventSlim + Task) 桥接非 Task 的异步模型(如 Begin/End 模式、IAsyncResult)

基本用法:三步走

以“监听一次 WebSocket 消息”为例:

var tcs = new TaskCompletionSource<string>();// 1. 订阅回调(比如 WebSocket 收到消息时触发)
webSocket.OnMessage += (msg) =>
{
// 2. 成功完成 Task,值为 msg
tcs.TrySetResult(msg);
};// 3. 返回可 await 的 Task
return tcs.Task;

调用方就可以这样写:

string msg = await WaitForNextMessage(); // 干净、线性、可异常传播

务必注意 TrySetXXX 的安全性

TrySetResult
/
TrySetException
/
TrySetCanceled
是线程安全且幂等的 —— 多次调用只生效第一次,不会抛异常。推荐始终用
TrySet*
系列,而不是
Set*

常见错误:

重复调用
SetResult
→ 抛
InvalidOperationException
在 Task 已完成后再设置 → 同样崩溃 忘记处理异常或取消路径 → Task 永远不完成(死等)

配合 CancellationToken 实现可取消等待

不能直接取消

TaskCompletionSource
本身,但可以监听 token 并主动取消:

var tcs = new TaskCompletionSource<string>();using var registration = cancellationToken.Register(() =>
{
tcs.TrySetCanceled(); // 注意:传入 token 可选,但建议显式传入
});// ... 后续回调中调用 TrySetResult 或 TrySetException

这样

await tcs.Task
就能响应
cancellationToken
,抛出
OperationCanceledException

基本上就这些。它不复杂,但容易忽略线程安全和完成唯一性 —— 用好

TrySet*
和及时清理资源(比如注销事件),就能稳稳把回调转成 async/await。

相关推荐