在 C# 中,CancellationToken 是用来协作式取消异步任务的核心机制。它不能强制终止一个正在运行的操作,而是通过通知的方式让任务自行决定何时安全退出。下面详细介绍如何正确使用 CancellationToken 来取消异步操作。
什么是 CancellationToken?
CancellationToken 来自 CancellationTokenSource,它是取消请求的“信号”。当调用 CancellationTokenSource.Cancel()
时,所有关联的 token 都会进入“已取消”状态,监听该 token 的任务可以据此中断执行。
典型使用场景包括:用户点击取消按钮、超时控制、关闭应用时清理后台任务等。
基本用法:传递 CancellationToken 到异步方法
大多数内置的异步方法(如
HttpClient.GetAsync、
StreamReader.ReadLineAsync)都接受一个
CancellationToken参数。你只需将 token 传入即可支持取消。
var cts = new CancellationTokenSource();
<p>// 模拟 2 秒后自动取消
// cts.CancelAfter(2000);</p><p>try
{
using var client = new HttpClient();
var response = await client.GetAsync("<a href="https://www.php.cn/link/85c19375f0c12c6793bf66b4e2666dc4">https://www.php.cn/link/85c19375f0c12c6793bf66b4e2666dc4</a>", cts.Token);
Console.WriteLine(response.StatusCode);
}
catch (OperationCanceledException)
{
Console.WriteLine("请求已被取消");
}
catch (HttpRequestException ex)
{
Console.WriteLine($"请求异常: {ex.Message}");
}</p>如果在请求完成前调用了
cts.Cancel()或设置了
CancelAfter,就会抛出 OperationCanceledException。
在自定义异步方法中响应取消
如果你自己编写长时间运行的异步方法,需要定期检查 token 状态并主动退出。
public async Task DoWorkAsync(CancellationToken token)
{
for (int i = 0; i < 100; i++)
{
// 模拟工作
await Task.Delay(100, token); // Delay 支持 token
<pre class='brush:php;toolbar:false;'> // 手动检查是否取消
if (token.IsCancellationRequested)
{
Console.WriteLine("任务收到取消请求");
return; // 或抛出 OperationCanceledException
}
Console.WriteLine($"处理进度: {i + 1}%");
}}
也可以调用
token.ThrowIfCancellationRequested()主动抛出异常:
token.ThrowIfCancellationRequested();
组合多个 CancellationToken
有时你需要同时监听多个取消条件,比如用户取消 + 超时。可以用 CancellationTokenSource.CreateLinkedTokenSource 合并多个 token。
var userCts = new CancellationTokenSource();
var timeoutCts = new CancellationTokenSource(TimeSpan.FromSeconds(5));
<p>using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(
userCts.Token,
timeoutCts.Token);</p><p>try
{
await DoWorkAsync(linkedCts.Token);
}
catch (OperationCanceledException)
{
if (timeoutCts.IsCancellationRequested)
Console.WriteLine("超时导致取消");
else if (userCts.IsCancellationRequested)
Console.WriteLine("用户手动取消");
}</p>只要任意一个源触发取消,链接的 token 就会变为取消状态。
基本上就这些。掌握 CancellationToken 的关键是:传递 token、及时检查、合理处理异常。只要任务配合响应,就能实现干净、可控的异步取消逻辑。
