聊一聊 .NET 中的 CancellationTokenSource在异步编程的世界里我们经常需要处理一些长时间运行的任务比如下载大文件、处理批量数据或等待网络响应。这些任务如果中途被用户取消或者超时未完成如何优雅地终止它们.NET 提供了一套强大的取消机制核心就是CancellationTokenSource和CancellationToken。今天我们就用通俗的语言拆解这个工具让你彻底搞懂它。## 什么是 CancellationTokenSource想象一下你正在厨房里煮一锅汤。你设定了一个计时器CancellationTokenSource然后让汤在火上煮异步任务。如果中途你发现汤快煮干了或者突然不想喝了你按下计时器上的“取消”按钮。这个按钮会发出一个信号CancellationToken通知煮汤的任务停止工作。在 .NET 中CancellationTokenSource就是那个计时器它负责管理“取消”信号。而CancellationToken是信号本身传递给需要被取消的任务。任务通过检查CancellationToken的状态来决定是否停止执行。## 为什么需要它没有取消机制时我们可能会用Thread.Abort()粗暴地终止线程但这可能导致资源未释放、数据损坏等问题。CancellationTokenSource提供了一种协作式取消任务本身决定如何响应取消而不是被外部强制杀死。这更安全也更可控。常见场景包括- 用户点击“取消”按钮- 任务超时自动取消- 多个任务同时取消例如一个失败则取消所有## 基础用法创建和触发取消首先看看最简单的用法。csharpusing System;using System.Threading;using System.Threading.Tasks;class Program{ static async Task Main(string[] args) { // 创建一个 CancellationTokenSource它管理取消信号 using var cts new CancellationTokenSource(); CancellationToken token cts.Token; // 启动一个异步任务传入 token var task DoWorkAsync(token); // 模拟用户 2 秒后决定取消 await Task.Delay(2000); Console.WriteLine(用户决定取消任务...); cts.Cancel(); // 触发取消信号 // 等待任务完成或取消 try { await task; } catch (OperationCanceledException) { Console.WriteLine(任务已被取消。); } } static async Task DoWorkAsync(CancellationToken cancellationToken) { Console.WriteLine(任务开始执行...); for (int i 0; i 10; i) { // 每次循环检查是否被取消 cancellationToken.ThrowIfCancellationRequested(); Console.WriteLine($正在处理第 {i 1} 步...); await Task.Delay(1000); // 模拟耗时操作 // 另一种方式检查 IsCancellationRequested // if (cancellationToken.IsCancellationRequested) // { // Console.WriteLine(检测到取消正在清理...); // return; // 或者抛出异常 // } } Console.WriteLine(任务正常完成。); }}注释说明-ThrowIfCancellationRequested()是常用方法如果取消信号已触发立即抛出OperationCanceledException。-IsCancellationRequested属性允许你手动处理取消比如执行清理逻辑后再返回。运行这段代码你会看到任务在第 2 秒左右被取消并打印“任务已被取消”。## 超时取消自动触发很多时候我们需要给任务设定一个超时时间。CancellationTokenSource提供了一个构造函数可以自动在指定时间后触发取消。csharpusing System;using System.Threading;using System.Threading.Tasks;class Program{ static async Task Main(string[] args) { // 设定超时时间为 3 秒 using var cts new CancellationTokenSource(TimeSpan.FromSeconds(3)); CancellationToken token cts.Token; Console.WriteLine(开始执行超时任务...); try { await SimulateLongRunningTask(token); Console.WriteLine(任务正常完成。); } catch (OperationCanceledException) { Console.WriteLine(任务因为超时被取消。); } } static async Task SimulateLongRunningTask(CancellationToken cancellationToken) { // 模拟一个需要 5 秒的任务 for (int i 0; i 5; i) { cancellationToken.ThrowIfCancellationRequested(); Console.WriteLine($正在执行第 {i 1} 秒...); await Task.Delay(1000); } }}注释说明-CancellationTokenSource(TimeSpan.FromSeconds(3))表示 3 秒后自动调用Cancel()。- 任务只执行了 3 秒就被取消了尽管它本来需要 5 秒。## 高级用法组合取消信号有时候一个任务可能需要响应多个取消源。例如用户点击取消按钮同时还有一个全局超时。.NET 提供了CancellationTokenSource.CreateLinkedTokenSource来组合多个 token。csharpusing System;using System.Threading;using System.Threading.Tasks;class Program{ static async Task Main(string[] args) { // 创建两个取消源一个用于用户取消一个用于超时 using var userCts new CancellationTokenSource(); using var timeoutCts new CancellationTokenSource(TimeSpan.FromSeconds(4)); // 组合它们任何一个触发取消组合后的 token 都会取消 using var linkedCts CancellationTokenSource.CreateLinkedTokenSource( userCts.Token, timeoutCts.Token); CancellationToken linkedToken linkedCts.Token; Console.WriteLine(按任意键取消任务或等待 4 秒自动取消...); var keyPressTask Task.Run(() Console.ReadKey(true)); var workTask PerformWorkAsync(linkedToken); // 等待用户按键或任务完成 var completedTask await Task.WhenAny(keyPressTask, workTask); if (completedTask keyPressTask) { Console.WriteLine(用户取消了任务。); userCts.Cancel(); // 通过用户取消源触发 } try { await workTask; // 等待任务最终结束 } catch (OperationCanceledException) { Console.WriteLine(任务已被取消原因可能是用户或超时。); } } static async Task PerformWorkAsync(CancellationToken cancellationToken) { for (int i 0; i 10; i) { cancellationToken.ThrowIfCancellationRequested(); Console.WriteLine($工作中... 第 {i 1} 步); await Task.Delay(1000); } }}注释说明-CreateLinkedTokenSource接受多个 token只要其中一个被取消生成的 token 也会取消。- 用户按键会触发userCts.Cancel()而 4 秒后timeoutCts自动取消。- 这个模式在 UI 应用中非常实用比如用户点击“取消”按钮同时设置一个最大等待时间。## 注意事项和最佳实践1.避免重复使用CancellationTokenSource是一次性对象。一旦调用Cancel()就不能再重置。如果需要多次取消请创建新的实例。2.资源释放CancellationTokenSource实现了IDisposable建议用using语句包裹以释放底层资源。3.不要直接操作 CancellationTokenCancellationToken是结构体只读不要手动设置它的状态。4.在异步方法中传递 token尽量在异步方法中传递CancellationToken让任务有机会响应取消而不是依赖外部强制中断。5.处理 OperationCanceledException捕获这个异常后通常意味着任务被取消可以执行清理逻辑。## 总结CancellationTokenSource是 .NET 异步编程中的“遥控器”它让我们能够安全、优雅地控制任务的取消。从简单的用户触发取消到超时自动取消再到组合多个取消源它提供了灵活且强大的机制。记住三个关键点- 用CancellationTokenSource管理取消信号- 用CancellationToken传递给任务- 在任务内部定期检查IsCancellationRequested或调用ThrowIfCancellationRequested掌握了它你的异步代码将变得更加健壮、更易维护。下次当你写异步方法时别忘了加上那个小小的CancellationToken参数它可能在未来为你省去很多麻烦。
