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

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

手动取消任务

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

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), 通过它我们可以在等待一段时间后，自动取消任务。

 CancellationTokenSource cts = new CancellationTokenSource(1000); 

_ = Execute(cts.Token); 

Console.ReadKey();

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

cts.CancelAfter(1000);

CancellationToken 注册回调

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

 CancellationTokenSource cts = new CancellationTokenSource(1000);

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

// 开始异步任务
_ = Execute(cts.Token);  

Console.ReadKey();

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

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

在 HttpClient 中使用

同样，你可以在 HttpClient 中使用传入 CancellationToken （或者使用HttpClient的Timeout属性），超时后，它会抛出一个 TaskCanceledException 的异常：

 CancellationTokenSource cts = new CancellationTokenSource(10); 

_ = await new HttpClient().GetAsync("https://www.youtube.com/",cts.Token);

Console.ReadKey();

在 WebAPI中使用

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

 [HttpGet]
public async Task<IActionResult> Index()
{
 await Task.Delay(5000);
 Console.WriteLine("Executed");
 return Ok();
}

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

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

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

[HttpGet]
public async Task<IActionResult> Index(CancellationToken token)
{
 await Task.Delay(5000,token);
 Console.WriteLine("Executed");
 return Ok();
}

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

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

以上就是如何在C#中使用 CancellationToken 处理异步任务的详细内容，更多关于C# 用CancellationToken 处理异步任务的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • c# 异步编程基础讲解

    现代应用程序广泛使用文件和网络 I/O.I/O 相关 API 传统上默认是阻塞的,导致用户体验和硬件利用率不佳,此类问题的学习和编码的难度也较大.而今基于 Task 的异步 API 和语言级异步编程模式颠覆了传统模式,使得异步编程非常简单,几乎没有新的概念需要学习. 异步代码有如下特点: 在等待 I/O 请求返回的过程中,通过让出线程来处理更多的服务器请求. 通过在等待 I/O 请求时让出线程进行 UI 交互,并将长期运行的工作过渡到其他 CPU,使用户界面的响应性更强. 许多较新的 .NET

  • c# 异步编程入门

    一.什么算异步?   广义来讲,两个工作流能同时进行就算异步,例如,CPU与外设之间的工作流就是异步的.在面向服务的系统中,各个子系统之间通信一般都是异步的,例如,订单系统与支付系统之间的通信是异步的,又如,在现实生活中,你去馆子吃饭,工作流是这样的,点菜->下单->做你的事->上菜->吃饭,这个也是异步的,具体来讲你和厨师之间是异步的,异步是如此重要,因外它代表者高效率(两者或两者以上的工作可以同时进行),但复杂,同步的世界简单,但效率极极低. 二.在编程中的异步   在编程中,

  • c# 几个常见的TAP异步操作

    在本系列上一篇文章 [15:异步编程基础] 中,我们讲到,现代应用程序广泛使用的是基于任务的异步编程模式(TAP),历史的 EAP 和 AMP 模式已经过时不推荐使用.今天继续总结一下 TAP 的异步操作,比如取消任务.报告进度.Task.Yield().ConfigureAwait() 和并行操作等. 虽然实际 TAP 编程中很少使用到任务的状态,但它是很多 TAP 操作机理的基础,所以下面先从任务状态讲起. 1 任务状态 Task 类为异步操作提供了一个生命周期,这个周期由 TaskStat

  • c# 基于任务的异步编程模式（TAP）

    异步编程是C#5.0的一个重要改进,提供两个关键字:async和await.使用异步编程,方法的调用是在后台运行(通常在线程或任务的帮助下),但不会阻塞调用线程.异步模式分为3种:异步模式.基于事件的异步模式和基于任务的异步模式(TAP).TAP是利用关键字async和await实现的,本文将讲解TAP模式.async和await关键字只是编译器的功能.编译器最终会用Task类创建代码. 1.创建任务 建立一个同步方法Greeting,该方法在等待一段时间后,返回一个字符串. private s

  • C#用委托BeginInvoke做异步线程

    一个应用场景,浏览器上传一个文件,此文件后台调用文件转换,需要耗费相当长的时间,这样,如果是一个线程同步式的做下去,那么用户在浏览器上感觉就是卡住了,卡卡卡卡,这里我们利用委托的BeginInvoke和EndInvoke方法操作线程,BeginInvoke方法可以使用线程异步地执行委托所指向的方法.然后通过EndInvoke方法获得方法的返回值(EndInvoke方法的返回值就是被调用方法的返回值),或是确定方法已经被成功调用,说白了就是相当于开个多线程,你用户文件保存了之后,响应返回,这个Be

  • C#异步编程几点需要注意的地方

    尽量不要编写返回值类型为void的异步方法 在通常情况下,建议大家不要编写那种返回值类型为void的异步方法,因为这样做会破坏该方法的启动者与方法本身之间的约定,这套约定本来可以确保主调方能够捕获到异步方法所发生的异常. 正常的异步方法是通过它返回的Task对象来汇报异常的.如果执行过程中发生了异常,那么Task对象就进入了faulted(故障)状态.主调方在对异步方法所返回的Task对象做await操作时,该对象若已处在faulted状态,系统则会将执行异步方法的过程中所发生的异常抛出,反之,

  • 基于c# Task自己动手写个异步IO函数

    基于c# Task自己动手写个异步IO函数

    前言 对于服务端,达到高性能.高扩展离不开异步.对于客户端,函数执行时间是1毫秒还是100毫秒差别不大,没必要为这一点点时间煞费苦心.对于异步,好多人还有误解,如: 异步就是多线程:异步就是如何利用好线程池.异步不是这么简单,否则微软没必要在异步上花费这么多心思.本文就介绍异步最新的实现方式:Task,并自己动手写一个异步IO函数.只有了解了异步函数内部实现方式,才能更好的利用它. 对于c#,异步处理经过了多个阶段,但是对于现阶段异步就是Task,微软用Task来抽象异步操作.以后的异步函数,处

  • C#异步方法返回void与Task的区别详解

    C#异步方法返回void和Task的区别 如果异步(async关键字)方法有返回值,返回类型为T时,返回类型必然是 Task<T>. 但是如果没有返回值,异步方法的返回类型有2种,一个是返回 Task, 一个是返回 void: public async Task CountDownAsync(int count) { for (int i = count; i >= 0; i--) { await Task.Delay(1000); } } public async void Count

  • 深入分析C#中的异步和多线程

    许多开发人员对异步代码和多线程以及它们的工作原理和使用方法都有错误的认识.在这里,你将了解这两个概念之间的区别,并使用c#实现它们. 我:"服务员,这是我第一次来这家餐厅.通常需要4个小时才能拿到食物吗?" 服务员:"哦,是的,先生.这家餐厅的厨房里只有一个厨师." 我:"--只有一个厨师吗?" 服务员:"是的,先生,我们有好几个厨师,但每次只有一个在厨房工作." 我:"所以其他10个穿着厨师服站在厨房里的人--什么

  • c# 在Emit代码中如何await一个异步方法

    0. 前言 首先立马解释一波为啥会有这样一篇伪标题的Demo随笔呢? 不是本人有知识误区,或者要误人子弟 因为大家都知道emit写出来的都是同步方法,不可能await,至少现在这么多年来没有提供对应的功能 这是之前某天在微信群看见讨论怎么emit一个异步方法并包装异步结构,简单几句文字也未能清晰的表达 所以趁着元旦节放假有点时间, 简单列举三种我知道方式去达到这样的效果 三种方法都是绕过emit直接书写emit代码,而是将对应逻辑转到其他方法中,最后emit调用方法达到效果 Demo 说明 原始

  • c# 编写一个轻量级的异步写日志的实用工具类（LogAsyncWriter）

    c# 编写一个轻量级的异步写日志的实用工具类（LogAsyncWriter）

    一说到写日志,大家可能推荐一堆的开源日志框架,如:Log4Net.NLog,这些日志框架确实也不错,比较强大也比较灵活,但也正因为又强大又灵活,导致我们使用他们时需要引用一些DLL,同时还要学习各种用法及配置文件,这对于有些小工具.小程序.小网站来说,有点"杀鸡焉俺用牛刀"的感觉,而且如果对这些日志框架不了解,可能输出来的日志性能或效果未毕是与自己所想的,鉴于这几个原因,我自己重复造轮子,编写了一个轻量级的异步写日志的实用工具类(LogAsyncWriter),这个类还是比较简单的,实

  • c# 基于任务的异步编程模式（TAP）的异常处理

    在前面讲到了<基于任务的异步编程模式(TAP)>,但是如果调用异步方法,没有等待,那么调用异步方法的线程中使用传统的try/catch块是不能捕获到异步方法中的异常.因为在异步方法执行出现异常之前,已经执行完毕. 1.没有等待的调用异步方法 ThrowAfter方法是在一定延迟后抛出一个异常: private async Task ThrowAfter(int ms,string message) { await Task.Delay(ms); Console.WriteLine("

  • 一篇文章说通C#中的异步迭代器

    今天来写写C#中的异步迭代器 - 机制.概念和一些好用的特性 迭代器的概念 迭代器的概念在C#中出现的比较早,很多人可能已经比较熟悉了. 通常迭代器会用在一些特定的场景中. 举个例子:有一个foreach循环: foreach (var item in Sources) { Console.WriteLine(item); } 这个循环实现了一个简单的功能:把Sources中的每一项在控制台中打印出来. 有时候,Sources可能会是一组完全缓存的数据,例如:List<string>: IEn

随机推荐