服务器之家:专注于VPS、云服务器配置技术及软件下载分享
分类导航

PHP教程|ASP.NET教程|Java教程|ASP教程|编程技术|正则表达式|C/C++|IOS|C#|Swift|Android|VB|R语言|JavaScript|易语言|vb.net|

服务器之家 - 编程语言 - C# - 如何在C#中使用 CancellationToken 处理异步任务

如何在C#中使用 CancellationToken 处理异步任务

2022-11-08 12:05SpringLeee C#

这篇文章主要介绍了如何在C#中使用 CancellationToken 处理异步任务,帮助大家更好的理解和学习使用c#,感兴趣的朋友可以了解下

在 .NET Core 中使用异步编程已经很普遍了, 你在项目中随处可见 async 和 await,它简化了异步操作,允许开发人员,使用同步的方式编写异步代码,你会发现在大部分的异步方法中,都提供了CancellationToken参数,本文主要介绍下 CancellationTokenSource 和 CancellationToken在异步任务中的使用。

手动取消任务

创建一个 CancellationTokenSource,然后调用异步方法时,传入 CancellationToken,它是一个轻量级对象,可以通知请求是否已取消,我们可以手动调用 cts.Cancel() 来取消任务,为了方面演示,这里我有用到局部方法。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
static async Task Main(string[] args)
{
  async Task Execute(CancellationToken token)
  {
  await Task.Delay(3000, token);
  Console.WriteLine("Executed");
  }
 
  CancellationTokenSource cts = new CancellationTokenSource();
 
  _ = Execute(cts.Token);
 
  // 手动取消任务
  cts.Cancel();
 
  Console.ReadKey();

定时取消任务

创建 CancellationTokenSource 的时候,可以传入时间(毫秒或者Timespan), 通过它我们可以在等待一段时间后,自动取消任务。

?
1
2
3
4
5
CancellationTokenSource cts = new CancellationTokenSource(1000);
 
_ = Execute(cts.Token);
 
Console.ReadKey();

我们也可以调用 cts.CancelAfter(1000), 它会在1s后取消任务。

cts.CancelAfter(1000);

CancellationToken 注册回调

我们可以调用 Register()方法,注册Token取消的回调,参数需要传入 Action 委托。

?
1
2
3
4
5
6
7
8
CancellationTokenSource cts = new CancellationTokenSource(1000);
 
cts.Token.Register(() => Console.WriteLine("任务已取消!"));
 
// 开始异步任务
_ = Execute(cts.Token); 
 
Console.ReadKey();

Register() 注册回调后,返回一个 CancellationTokenRegistration 对象,同样的,你可以在回调函数执行前,移除注册回调,就像这样:

?
1
cts.Token.Register(() => Console.WriteLine("任务已取消!")).Unregister();

在 HttpClient 中使用

同样,你可以在 HttpClient 中使用传入 CancellationToken (或者使用HttpClient的Timeout属性),超时后,它会抛出一个 TaskCanceledException 的异常:

?
1
2
3
4
5
CancellationTokenSource cts = new CancellationTokenSource(10);
 
_ = await new HttpClient().GetAsync("https://www.youtube.com/",cts.Token);
 
Console.ReadKey();

在 WebAPI中使用

我创建了一个 WebAPI 项目,其中的控制器代码如下,等待了5s,然后进行输出信息。

?
1
2
3
4
5
6
7
[HttpGet]
public async Task<IActionResult> Index()
{
 await Task.Delay(5000);
 Console.WriteLine("Executed");
 return Ok();
}

启动项目后,我们在浏览器页面上访问接口,在第一次访问接口等待响应时,我刷新一次了页面,现在程序的输出信息如下:

如何在C#中使用 CancellationToken 处理异步任务

说明前台页面刷新后,后台并没有做取消操作,执行了两次!

我们可以把程序改成这样,传入 CancellationToken

?
1
2
3
4
5
6
7
[HttpGet]
public async Task<IActionResult> Index(CancellationToken token)
{
 await Task.Delay(5000,token);
 Console.WriteLine("Executed");
 return Ok();
}

现在在浏览器访问页面,同样的,第一次还未返回是,我们刷新一次页面,程序输出如下:

如何在C#中使用 CancellationToken 处理异步任务

只有一次输出,第一次请求抛出了一次 TaskCanceledException 异常,没有继续执行后边的逻辑,当然你可以捕获这个异常,返回更友好的提示!

以上就是如何在C#中使用 CancellationToken 处理异步任务的详细内容,更多关于C# 用CancellationToken 处理异步任务的资料请关注服务器之家其它相关文章!

原文链接:https://www.cnblogs.com/myshowtime/p/14545360.html

延伸 · 阅读

精彩推荐
  • C#WPF实现图片合成或加水印的方法【2种方法】

    WPF实现图片合成或加水印的方法【2种方法】

    这篇文章主要介绍了WPF实现图片合成或加水印的方法,结合实例形式分析了2种比较实用的WPF图片操作相关技巧,需要的朋友可以参考下...

    Rising_Sun4252021-12-29
  • C#C#使用String和StringBuilder运行速度测试及各自常用方法简介

    C#使用String和StringBuilder运行速度测试及各自常用方法简介

    今天小编就为大家分享一篇关于C#使用String和StringBuilder运行速度测试及各自常用方法简介,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值...

    Czhenya8662022-03-03
  • C#C#是什么

    C#是什么

    C#是什么?C#是微软公司发布的一种由C和C++衍生出来的面向对象的编程语言、运行于.NET Framework和.NET Core(完全开源,跨平台)之上的高级程序设计语言。...

    百度百科4152020-12-12
  • C#Unity3D实现射线使物体移动

    Unity3D实现射线使物体移动

    这篇文章主要为大家详细介绍了Unity3D实现射线使物体移动,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...

    leonardo_Davinci9242022-08-15
  • C#C#异步下载文件

    C#异步下载文件

    这篇文章主要介绍了C#异步下载文件的相关资料,需要的朋友可以参考下...

    guwei40378352021-11-08
  • C#C#使用yield关键字构建迭代器详解

    C#使用yield关键字构建迭代器详解

    这篇文章主要为大家详细介绍了C#使用yield关键字构建迭代器的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...

    绛河7402022-01-24
  • C#C#使用JavaScriptSerializer序列化时的时间类型处理

    C#使用JavaScriptSerializer序列化时的时间类型处理

    这篇文章主要为大家详细介绍了C#使用JavaScriptSerializer序列化时的时间类型处理,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...

    车伊洛10622022-01-20
  • C#C#中类成员的定义的修饰关键词知识点总结

    C#中类成员的定义的修饰关键词知识点总结

    在本篇文章里小编给大家整理了关于C#中类成员的定义的修饰关键词知识点内容,有需要的朋友们可以参考下。...

    Hercules_Chung8522022-08-24