TaskCompletionSource是C#中将回调式异步操作包装为可await的Task的核心工具,不执行异步逻辑,仅手动控制Task完成状态(成功/失败/取消),适用于桥接事件、回调、IAsyncResult等非Task异步模型。
的用法 - 将回调模式转换为async/await - "/>
TaskCompletionSourceTask、从而支持 await 的核心工具。它不执行任何异步逻辑,只负责手动控制一个 Task 的完成状态(成功、失败、取消)。
常见于以下场景:
以“监听一次 WebSocket 消息”为例:
var tcs = new TaskCompletionSource();// 1. 订阅回调(比如 WebSocket 收到消息时触发) webSocket.OnMessage += (msg) => { // 2. 成功完成 Task,值为 msg tcs.TrySetResult(msg); };// 3. 返回可 aw ait 的 Task return tcs.Task;
调用方就可以这样写:
string msg = await WaitForNextMessage(); // 干净、线性、可异常传播
TrySetResult/TrySetException/TrySetCanceled 是线程安全且幂等的 —— 多次调用只生效第一次,不会抛异常。推荐始终用 TrySet* 系列,而不是 Set*。
常见错误:
SetResult → 抛 InvalidOperationException
不能直接取消 TaskCompletionSource 本身,但可以监听 token 并主动取消:
var tcs = new TaskCompletionSource();using var registration = cancellationToken.Register(() => { tcs.TrySetCanceled(); // 注意:传入 token 可选,但建议显式传入 });// ... 后续回调中调用 TrySetResult 或 TrySetException
这样 await tcs.Task 就能响应 cancellationToken,抛出 OperationCanceledException。
基本上就这些。它不复杂,但容易忽略线程安全和完成唯一性 —— 用好 TrySet* 和及时清理资源(比如注销事件),就能稳稳把回调转成 async/await。