CancellationToken 是 .NET 中用于协作式取消异步或长时间运行操作的机制。它本身不强制终止任务,而是提供一种“通知”方式,让目标操作可以主动响应取消请求,从而实现优雅退出。
什么是 CancellationToken?
CancellationToken 通常由 CancellationTokenSource 创建。当调用 CancellationTokenSource 的 Cancel() 方法时,所有监听该 token 的操作会收到取消通知。关键在于“协作”——任务必须定期检查 token 状态并自行决定如何退出。
常用场景包括: 用户点击“取消”按钮中断后台下载 API 请求超时自动终止 应用关闭时清理正在执行的任务如何使用 CancellationToken 取消异步任务?
在实际编码中,需要将 token 传递给支持取消的操作,并在适当位置检查其状态。
示例:取消一个模拟的长时间异步任务
var cts = new CancellationTokenSource();
var token = cts.Token;
async Task LongRunningOperation(CancellationToken ct)
{
for (int i = 0; i < 100; i++)
{
// 模拟工作
await Task.Delay(100, ct); // 支持取消的延迟
// 手动检查是否已取消
ct.ThrowIfCancellationRequested();
Console.WriteLine($"处理进度: {i + 1}%");
}
}
// 启动任务
var task = LongRunningOperation(token);
// 模拟外部触发取消
await Task.Delay(500);
cts.Cancel(); // 发起取消请求
try
{
await task;
}
catch (OperationCanceledException)
{
Console.WriteLine("任务已被取消");
}
在这个例子中,Task.Delay 接收 token 并在取消时抛出异常。手动调用 ThrowIfCancellationRequested 可确保及时响应取消信号。
最佳实践与注意事项
要正确使用取消机制,需注意以下几点:
始终传递 CancellationToken 到支持它的 API(如 HttpClient.GetAsync、StreamReader.ReadLineAsync) 在循环中定期检查 token 状态,避免长时间阻塞无法响应取消 捕获 OperationCanceledException 并区分正常取消和错误 使用 using 或 try-finally 确保 CancellationTokenSource 被释放 考虑设置超时:new CancellationTokenSource(TimeSpan.FromSeconds(30)) 基本上就这些。CancellationToken 的设计强调协作而非强制终止,这样能避免资源泄漏或状态不一致,是实现健壮异步程序的重要工具。