.NET中如何使用CancellationToken取消异步操作_异步操作取消机制详解

CancellationToken是.NET中用于协作式取消异步操作的核心机制,由CancellationTokenSource创建并管理。它通过传递令牌使任务主动检查取消请求,避免强制终止线程导致的问题。关键点包括:取消为协作式、令牌只能取消一次、不能强制中断执行。常见用法有传入支持取消的异步方法(如HttpClient.GetAsync),设置超时或手动调用ThrowIfCancellationRequested()检查状态。还可通过CreateLinkedTokenSource组合多个取消条件,实现超时与用户取消等复合控制,提升应用响应性和资源利用率。

在 .NET 中,CancellationToken 是用于协作式取消异步操作的核心机制。它允许你请求取消长时间运行或可中断的任务,而任务本身决定是否以及何时响应取消请求。这种设计避免了强制终止线程带来的资源泄漏或状态不一致问题。

什么是 CancellationToken?

CancellationToken 是一个轻量级结构,表示可能发生的取消通知。它通常由 CancellationTokenSource 创建和管理。当调用 CancellationTokenSource.Cancel() 方法时,所有关联的 token 会进入“已取消”状态,并触发注册的回调函数(如果有)。

关键点:

  • 取消是协作式的 —— 异步方法必须主动检查 token 状态。
  • 一个 token 只能被取消一次,之后状态永久为“已取消”。
  • 不能强制终止正在执行的操作,只能通知其尝试停止。

如何在异步方法中使用 CancellationToken

大多数内置的异步方法(如 HttpClient.GetAsyncStreamReader.ReadLineAsync)都接受一个 CancellationToken 参数。你只需将 token 传入即可启用取消支持。

示例:使用 HttpClient 发起可取消的请求

using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(5)); // 5秒后自动取消
try
{
    using var client = new HttpClient();
    var response = await client.GetAsync("https://httpbin.org/delay/10", cts.Token);
    Console.WriteLine(await response.Content.ReadAsStringAsync());
}
catch (OperationCanceledException ex)
{
    Console.WriteLine("请求被取消:" + ex.Message);
}

说明:

  • CancellationTokenSource 控制生命周期。
  • 设置超时时间后,超过该时间自动触发取消。
  • 捕获 OperationCanceledException 处理取消情形。

手动检查取消令牌

如果你编写自定义异步逻辑(如循环处理数据),需要定期检查 token 是否已被请求取消。

示例:模拟长时间任务并监听取消

public async Task LongRunningProcessAsync(CancellationToken token)
{
    for (int i = 0; i < 100; i++)
    {
        // 模拟工作
        await Task.Delay(100, token); // Delay 支持 token

        // 手动检查(可选)
        token.ThrowIfCancellationRequested();

        Console.WriteLine($"处理进度: {i + 1}%");
    }
}

建议做法:

  • 在每个循环迭代中检查 token。
  • 调用 ThrowIfCancellationRequested() 抛出标准异常。
  • 或将 token 传递给支持它的 API(如 Task.Delay、EF Core 查询等)。

组合多个取消条件

你可以通过 CancellationTokenSource.CreateLinkedTokenSource 合并多个 token,实现更复杂的取消策略。

例如:同时监听用户取消和超时

var cts1 = new CancellationTokenSource();
var cts2 = new CancellationTokenSource(TimeSpan.FromSeconds(3));

using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(cts1.Token, cts2.Token);

try
{
    await LongRunningProcessAsync(linkedCts.Token);
}
catch (OperationCanceledException)
{
    if (cts2.IsCancellationRequested)
        Console.WriteLine("操作因超时被取消");
    else
        Console.WriteLine("操作被用户取消");
}

这在 Web API 中很常见:客户端断开连接 + 请求超时双重控制。

基本上就这些。合理使用 CancellationToken 能显著提升应用的响应性和资源利用率,尤其是在高并发或长时间任务场景中。