在c#中使用CancellationToken取消任务

2023-09-17 23:15:14

目录

🚀介绍:

🐤简单举例

🚀IsCancellationRequested

🚀ThrowIfCancellationRequested

🐤在控制器中使用

 🚀通过异步方法的参数使用cancellationToken

🚀api结合ThrowIfCancellationRequested()


🚀介绍:

CancellationToken是.NET中用于协调取消操作的结构。它通常用于多线程操作,例如任务和线程等。当你启动一个新的任务或线程时,你可以传递一个CancellationToken给它,然后在其他线程中,你可以使用这个token来请求取消操作。

  • 属性:IsCancellationRequested,它的返回值是bool类型,即表示当前任务是否被取消,当调用CancellationTokenSource的Cancel方法时,与之关联的所有CancellationToken的IsCancellationRequested属性将返回true。
  • 方法:ThrowIfCancellationRequested,如果IsCancellationRequested为true,那么它将抛出一个OperationCanceledException异常。这是一种在任务中响应取消请求的常见方式。

🐳例如,你可能有一个长时间运行的任务,你希望用户能够取消。你可以传递一个CancellationToken给这个任务,然后在任务的代码中定期检查IsCancellationRequested属性,或者调用ThrowIfCancellationRequested方法。如果用户请求取消操作,那么你的任务代码将能够响应这个请求。

🐤简单举例

下面用几个简单的例子来使用IsCancellationRequested属性与ThrowIfCancellationRequested方法,更直观的展示他们的用法,在CancellationToken中我们可以直接使用Cancel()方法来取消操作,但是为了演示方便,我们下面的例子使用的都是CancelAfter()来进行延迟关闭

🚀IsCancellationRequested

我们创建一个CancellationTokenSource对象,然后通过CancelAfter(5000)设置一个5秒的取消延迟。然后写一个无限循环,在循环中打印"任务执行中!"(👻假装在执行任务)!5秒钟后,CancelAfter方法会触发取消请求,这时cts.IsCancellationRequested属性会变为true。然后就会打印"任务被取消!",并跳出循环。如下图所示👇

    public static void Main(string[] args)
    {
        CancellationTokenSource cts = new CancellationTokenSource();
        cts.CancelAfter(5000);
        while (true)
        {
            Console.WriteLine("任务执行中!");
            if (cts.IsCancellationRequested)
            {
                Console.WriteLine("任务被取消!");
                break;
            }
        }
    }

🚀ThrowIfCancellationRequested

将刚刚的代码修改一下,换成使用ThrowIfCancellationRequested(),方法执行后,还是会在控制台打印"任务执行中!",5秒钟后,CancelAfter方法触发取消请求,于是执行到ThrowIfCancellationRequested()的时候抛出了一个异常,操作被取消了!

    public static void Main(string[] args)
    {
        CancellationTokenSource cts = new CancellationTokenSource();
        cts.CancelAfter(5000);
        while (true)
        {
            Console.WriteLine("任务执行中!");
            cts.Token.ThrowIfCancellationRequested();
        }
    }

🐤在控制器中使用

在ASP.NET Core中,CancellationToken是一个可选参数,可以被添加到控制器的动作方法中。当客户端请求被关闭或取消时,ASP.NET Core会自动取消关联的CancellationToken。

这是因为ASP.NET Core的内部机制。当客户端发送一个请求到服务器,服务器会为这个请求创建一个CancellationToken,并且当客户端关闭连接时,服务器会自动调用CancellationToken的Cancel方法,以便通知应用程序请求已经被取消。

因此,我们可以直接在Controller中加入CancellationToken参数,如下图👇,这是我的一个ai识别项目,他会将收到的图片作为请求体,调用我部署在服务器上的ai识别api,如果用户通过网页,上传了一张图片进行ai识别,但是因为识别时间太长了,他不想等待并且把网页关了,此时我的后台还在傻傻的进行图片识别,势必会造成资源的浪费,下面我们就来改造一下他!

在上面我们调用PutPhoto的时候参数中添加了controller中拿到的cancellationToken,因此这边方法中的参数也加上CancellationToken cancellationToken来接,如下图👇,上面的代码都是对请求体进行组装,我们重点看最下面这一行。

var response = await client.ExecuteAsync<PhotoRes>(request);

 🚀通过异步方法的参数使用cancellationToken

Ctrl + 左键 点击 ExecuteAsync

我们查看一下RestClient的ExecuteAsync方法,可以看见他是有一个可选参数cancellationToken,这意味这我们又可以直接把在controller中拿到的cancellationToken继续丢进去。

因此,我们把最后一句代码改成,然后我在执行这一行代码之前,打一个断点。

var response = await client.ExecuteAsync<PhotoRes>(request,cancellationToken);

 在执行这行代码之前,我将浏览器关闭了,然后再继续下一步

 我们在返回结果中看到,错误信息中提示:A task was canceled,一个任务被取消,其实哪怕是我的请求在进行中,只要一关闭浏览器,任务就会立马结束,但是因为我服务器的响应速度太快了,不好实现这个演示!

🚀api结合ThrowIfCancellationRequested()

假设你现在的场景中异步方法并没有cancellationToken参数,那么你可以结合我们上面演示中使用的ThrowIfCancellationRequested()来取消操作。请求取消时,它会抛出一个异常OperationCanceledException,这样你就可以在你的代码中捕获这个异常并进行相应的处理。

try
{
    var response = await client.ExecuteAsync<PhotoRes>(request);
    // 在这里检查取消标记
    cancellationToken.ThrowIfCancellationRequested();
}
catch (OperationCanceledException)
{
    // 这里处理取消操作的逻辑
}

要注意的是,这种方式只能取消还没有开始的操作。如果ExecuteAsync方法已经开始执行,那么这个取消请求就无法停止它,因此如果异步方法可以支持传参cancellationToken的话,我们还是首选使用传参的方法!

更多推荐

半导体产品使用高温老化测试技术

主要功能:为了达到满意的合格率,几乎所有产品在出厂前都必须经过老化处理。制造商如何在不缩短老化时间的情况下提高效率?本文介绍了一种在老化过程中进行功能测试的新方法,以减少和缩短与老化过程相关的成本和时间问题。在半导体行业,关于器件老化存在着各种争论。与其他产品一样,半导体随时可能因各种原因而失效。老化是通过使半导体超载

spring ioc

1.什么是SpringSpring框架是一个分层的、面向切面的Java应用程序的一站式轻量级解决方案,它是Spring技术栈的核心和基础,是为了解决企业级应用开发的复杂性而创建的。>简单来说,Spring是一个轻量级的控制反转(IoC)和面向切面(AOP)的容器框架。介于SpringMVC与Mybatis之间的中间层框

【java】【SpringBoot】【四】原理篇 bean、starter、核心原理

目录一、自动配置1、bean加载方式(复习)1.1加载方式-xml方式生命bean1.2加载方式-xml+注解方式声明bean1.3注解方式声明配置类1.4FactoryBean1.5proxyBeanMethod属性1.6使用@Import注解导入1.7使用上下文对象在容器初始化完毕后注入bean1.8导入实现了Im

Django Web开发入门基础

官方有很详细的文档,但是看过几遍之后如果要翻找还是有点麻烦,本文算作是学习笔记,提取一些关键点记录下来,另附上官方教程WritingyourfirstDjangoapp注:文中的指令使用py,是在Windows上,macOS要使用python31.安装DjangoDjango是一个基于Python的Web开发框架,安装

git使用说明

配置hosts配置C:\Windows\System32\drivers\etc\hosts192.168.**.**git.wl.com本地git账号配置(xxx在gitlab个人profile中)打开gitbashgitconfig--globaluser.namexxxxgitconfig--globaluser

使用springcloud-seata解决分布式事务问题-2PC模式

目录一、建立undo_log表二、安装事务协调器:seata-server三、整合可以查看官网:快速启动|Seata一、建立undo_log表--注意此处0.3.0+增加唯一索引ux_undo_logCREATETABLE`undo_log`(`id`bigint(20)NOTNULLAUTO_INCREMENT,`b

华为OD机试 - 滑动窗口最大和 - 滑动窗口(Java 2023 B卷 100分)

目录专栏导读一、题目描述二、输入描述三、输出描述四、解题思路五、Java算法源码六、效果展示1、输入2、输出3、说明华为OD机试2023B卷题库疯狂收录中,刷题点这里专栏导读本专栏收录于《华为OD机试(JAVA)真题(A卷+B卷)》。刷的越多,抽中的概率越大,每一题都有详细的答题思路、详细的代码注释、样例测试,发现新题

【技术分享】NetLogon于域内提权漏洞(CVE-2020-1472)

一、漏洞介绍CVE-2020-1472是一个Windows域控中严重的远程权限提升漏洞。攻击者在通过NetLogon(MS-NRPC)协议与AD域控建立安全通道时,可利用该漏洞将AD域控的计算机账号密码置为空,从而控制域控服务器。该漏洞适用于Win2008及后的所有版本。二、漏洞原理Netlogon使用的AES认证算法

区块链(3):区块链去中心化

1点对点同步区块链的流程流程图如下:流程讲解:(1)连接节点(2)向该节点请求最新区块(3)请求到区块以后,根据返回的最新区块前置hash是否和我本身的区块hash相等,分为两种情况:第一种情况:最新区块前置hash和我本身的区块hash相等并合法有效,则最新区块是新区块,同时添加到我的链中。然后广播到我这个节点连接的

期权交易保证金比例一般是多少?

期权交易是一种非常受欢迎的投资方式之一,它为期权市场带来了更为多样化和灵活化的交易形式。而其中的期权卖方保证金比例是期权交易中的一个重要指标,直接关系到投资者的风险与收益,下文介绍期权交易保证金比例一般是多少?本文来自:期权酱一、期权的交易保证金如何计算?期权交易保证金分为开仓保证金和维持保证金。采用非线性保证金的方式

Spring Authorization Server入门 (十七) Vue项目使用授权码模式对接认证服务

Vue单页面项目使用授权码模式对接流程说明以下流程摘抄自官网在本例中为授权代码流程。授权码流程的步骤如下:客户端通过重定向到授权端点来发起OAuth2请求。如果用户未通过身份验证,授权服务器将重定向到登录页面。身份验证后,用户将再次重定向回授权端点。如果用户未同意所请求的范围并且需要同意,则会显示同意页面。一旦用户同意

热文推荐