C# 怎么使用 CancellationToken 取消异步任务_C# CancellationToken 异步任务取消教程

幻夢星雲
发布: 2025-11-03 18:43:02
原创
723人浏览过
CancellationToken用于协作取消异步任务,通过CancellationTokenSource触发取消信号,任务需主动检查并响应。典型场景包括用户取消、超时或应用关闭。传入token至支持的方法(如HttpClient.GetAsync)可实现自动取消;自定义方法则需轮询IsCancellationRequested或调用ThrowIfCancellationRequested。若取消,抛出OperationCanceledException。使用CancelAfter可设置超时自动取消,确保资源及时释放且不强制终止操作。

c# 怎么使用 cancellationtoken 取消异步任务_c# cancellationtoken 异步任务取消教程

在 C# 中,CancellationToken 是用来协作式取消异步任务的核心机制。它不能强制终止一个正在运行的操作,而是通过通知的方式让任务自行决定何时安全退出。下面详细介绍如何正确使用 CancellationToken 来取消异步操作。

什么是 CancellationToken?

CancellationToken 来自 CancellationTokenSource,它是取消请求的“信号”。当调用 CancellationTokenSource.Cancel() 时,所有关联的 token 都会进入“已取消”状态,监听该 token 的任务可以据此中断执行。

典型使用场景包括:用户点击取消按钮、超时控制、关闭应用时清理后台任务等。

基本用法:传递 CancellationToken 到异步方法

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

AppMall应用商店
AppMall应用商店

AI应用商店,提供即时交付、按需付费的人工智能应用服务

AppMall应用商店 56
查看详情 AppMall应用商店
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、及时检查、合理处理异常。只要任务配合响应,就能实现干净、可控的异步取消逻辑。

以上就是C# 怎么使用 CancellationToken 取消异步任务_C# CancellationToken 异步任务取消教程的详细内容,更多请关注php中文网其它相关文章!

相关标签:
最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号