CancellationToken通过协作方式取消异步操作,由CancellationTokenSource创建并调用Cancel()触发取消,需在代码中主动检查token.IsCancellationRequested或传递token给支持的API,最终抛出OperationCanceledException以响应取消。

CancellationToken 是 C# 中用于协作式取消异步或长时间运行操作的机制。它本身不强制终止任务,而是提供一种通知方式,让被调用方可以监听取消请求,并在合适时机优雅地退出操作。
理解 CancellationToken
CancellationToken 通常由 CancellationTokenSource 创建。调用 CancellationTokenSource 的 Cancel() 方法后,所有关联的 token 会进入“已取消”状态,并触发注册的回调函数(如果有的话)。
关键点是:取消是协作式的——你必须在代码中定期检查 token 是否被取消,并自行处理清理逻辑。
如何实现可取消的异步操作
以下是在异步方法中使用 CancellationToken 的常见模式:
1. 在方法签名中接收 CancellationToken 参数
约定俗成地将 CancellationToken 设为最后一个可选参数:
public async Task DoWorkAsync(CancellationToken token = default)
2. 在 await 调用中传递 token
很多异步 API(如 HttpClient、StreamReader 等)都支持接收 CancellationToken:
例如:
var client = new HttpClient();
var content = await client.GetStringAsync(“https://example.com”, token);
3. 手动检查取消状态
在循环或长时间计算中,主动轮询 token.IsCancellationRequested:
for (int i = 0; i
{
token.ThrowIfCancellationRequested(); // 如果已取消,抛出 OperationCanceledException
// 或者手动判断
if (token.IsCancellationRequested)
{
return; // 或抛出异常
}
await Task.Delay(100, token); // 带 token 的等待
}
4. 使用 CancellationToken.Register 注册取消回调
可在 token 上注册一个动作,当取消发生时自动执行,比如释放资源:
using var registration = token.Register(() => Console.WriteLine(“取消了!”));
完整示例
static async Task Main(string[] args)
{
var cts = new CancellationTokenSource();
_ = Task.Run(async () =>
{
await Task.Delay(2000);
cts.Cancel(); // 2秒后触发取消
});
try
{
await LongRunningOperationAsync(cts.Token);
Console.WriteLine(“操作完成”);
}
catch (OperationCanceledException)
{
Console.WriteLine(“操作被取消”);
}
}
static async Task LongRunningOperationAsync(CancellationToken token)
{
for (int i = 0; i
{
token.ThrowIfCancellationRequested();
Console.WriteLine($”第 {i} 次工作…”);
await Task.Delay(500, token);
}
}
基本上就这些。CancellationToken 让异步操作具备响应取消的能力,关键是调用方传 token,被调方监听并响应。配合 using 和 try-catch 可以做到资源安全和异常可控。
以上就是C#的CancellationToken是什么?如何实现可取消的异步操作?的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1441735.html
微信扫一扫
支付宝扫一扫