C#使用CancellationTokenSource 取消 Task的方法

更新時(shí)間：2022年02月14日 10:55:10 作者：White_Hacker

因?yàn)樯婕暗搅巳粘＝?jīng)常會(huì)碰到的取消任務(wù)操作，本文主要介紹了C#使用CancellationTokenSource 取消 Task，文中通過(guò)代碼介紹的非常詳細(xì)，感興趣的可以了解一下

本篇的內(nèi)容也很重要，因?yàn)樯婕暗搅巳粘＝?jīng)常會(huì)碰到的取消任務(wù)操作。

從我個(gè)人了解到的情況，基本上大家都采用CancellationTokenSource方法來(lái)取消任務(wù)，因此這里就舉幾個(gè)簡(jiǎn)單的例子。例子依然是來(lái)自于《C#多線程編程實(shí)戰(zhàn)》。

private static int TaskMethod(string name, int seconds, CancellationToken token)
{
Console.WriteLine("Task {0} 運(yùn)行在線程 {1} 上。是否是線程池線程: {2}",
name, Thread.CurrentThread.ManagedThreadId, Thread.CurrentThread.IsThreadPoolThread);
for (int i = 0; i < seconds; i ++)
{
Thread.Sleep(1000);
if (token.IsCancellationRequested) return -1;
}
return 42*seconds;
}

Task的取消采用一種形如令牌（Token）的方式。首先先構(gòu)建一個(gè)CancellationTokenSource實(shí)例，而后在需要調(diào)用的操作（函數(shù)）參數(shù)中添加一個(gè)CancellationToken參數(shù)，也就是說(shuō)，取消是要求增加函數(shù)參數(shù)的。以上TaskMethod方法中可以看出，函數(shù)使用循環(huán)檢查的方式來(lái)檢測(cè)在seconds秒內(nèi)，外部是否下達(dá)取消指令。當(dāng)IsCancellationRequested時(shí)，那么將會(huì)返回-1.

接下來(lái)，先看一下如果Task沒(méi)有被運(yùn)行就直接取消，會(huì)發(fā)生什么。

var cts = new CancellationTokenSource();
var longTask = new Task<int>(() => TaskMethod("Task 1", 10, cts.Token), cts.Token);
Console.WriteLine("取消前，第一個(gè)任務(wù)的狀態(tài)：{0}", longTask.Status);
cts.Cancel(); //取消任務(wù)！
Console.WriteLine("取消后，第一個(gè)任務(wù)的狀態(tài)：{0}",longTask.Status);
Console.WriteLine("第一個(gè)任務(wù)在被執(zhí)行前就已經(jīng)取消了！");

接下來(lái)，我們來(lái)看看start()后再cancel()的情況。示例中每隔半秒打印一下longTask的狀態(tài)：

var cts = new CancellationTokenSource();
var longTask = new Task<int>(() => TaskMethod("Task 2", 10, cts.Token), cts.Token);
longTask.Start(); //啟動(dòng)任務(wù)
for (int i = 0; i < 5; i++)
{
Thread.Sleep(TimeSpan.FromSeconds(0.5));
Console.WriteLine(longTask.Status);
}
cts.Cancel();
for (int i = 0; i < 5; i++)
{
Thread.Sleep(TimeSpan.FromSeconds(0.5));
Console.WriteLine(longTask.Status);
}
 
Console.WriteLine("A task has been completed with result {0}.", longTask.Result);