CancellationToken用于协作式取消异步操作,CancellationTokenSource负责触发取消;2. 将Token传递给异步方法,调用Cancel()发送取消信号;3. 异步方法需定期检查Token并抛出OperationCanceledException以响应取消。

在 .net 中,CancellationToken 是用于协作式取消异步操作的核心机制。它允许你在长时间运行的任务(如网络请求、文件读取或密集计算)中响应取消请求,从而提升应用的响应性和资源利用率。
理解 CancellationToken 和 CancellationTokenSource
CancellationToken 本身不触发取消,它只是一个信号令牌,用于监听是否收到取消请求。真正的取消控制由 CancellationTokenSource(简称 CTS)发出。
典型用法是创建一个 CancellationTokenSource,然后将它的 Token 传递给异步方法。当调用 CTS 的 Cancel() 方法时,所有监听该 Token 的操作都会收到通知。
示例:
var cts = new CancellationTokenSource(); CancellationToken token = cts.Token; // 启动异步操作并传入 token var task = LongRunningoperationasync(token); // 在某个条件下触发取消 cts.Cancel(); // 发送取消信号
在异步方法中处理取消请求
异步方法需要定期检查 token 是否被取消,并在适当时候抛出 OperationCanceledException。
.NET 中很多内置异步方法(如 HttpClient.GetAsync、streamReader.ReadLineAsync)都支持 CancellationToken 参数,直接传入即可。
自定义异步方法中使用方式如下:
public async Task LongRunningOperationAsync(CancellationToken token) { for (int i = 0; i < 100; i++) { // 模拟工作 await Task.Delay(100, token); // 支持取消的等待 // 手动检查取消(可选,更精细控制) token.ThrowIfCancellationRequested(); // 或者只检查 if (token.IsCancellationRequested) { // 清理资源 return; } } }
注意:使用 Task.Delay(100, token) 这类支持取消的方法,会在取消时自动抛出异常,无需手动处理。
安全地处理取消异常
当操作被取消时,通常会抛出 OperationCanceledException。你应该捕获这个异常并判断是否为预期的取消行为。
示例:
try { await LongRunningOperationAsync(cts.Token); } catch (OperationCanceledException ex) when (ex.CancellationToken == cts.Token) { Console.WriteLine("操作已被用户取消。"); } catch (Exception ex) { Console.WriteLine($"发生错误: {ex.Message}"); }
通过匹配 CancellationToken,可以区分是哪个取消源导致的异常,避免误判。
设置超时自动取消
除了手动取消,还可以设置超时时间让操作自动终止:
var cts = new CancellationTokenSource(); cts.CancelAfter(TimeSpan.FromSeconds(30)); // 30秒后自动取消 await LongRunningOperationAsync(cts.Token);
这在防止任务无限等待时非常有用,比如调用外部 API。
基本上就这些。关键是把 token 一路传下去,并在合适的地方响应它。只要调用方能控制取消时机,被调用的方法就能及时退出,不浪费资源。


