【C#】46. 使用CancellationTokenSource 取消 Task

本篇的内容也很重要，因为涉及到了日常经常会碰到的取消任务操作。

从我个人了解到的情况，基本上大家都采用CancellationTokenSource方法来取消任务，因此这里就举几个简单的例子。例子依然是来自于《C#多线程编程实战》。

private static int TaskMethod(string name, int seconds, CancellationToken token)
{
Console.WriteLine("Task {0} 运行在线程 {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）的方式。首先先构建一个CancellationTokenSource实例，而后在需要调用的操作（函数）参数中添加一个CancellationToken参数，也就是说， 取消是要求增加函数参数的。以上TaskMethod方法中可以看出，函数使用循环检查的方式来检测在seconds秒内，外部是否下达取消指令。当IsCancellationRequested时，那么将会返回-1.

接下来，先看一下如果Task没有被运行就直接取消，会发生什么。

var cts = new CancellationTokenSource();
var longTask = new Task<int>(() => TaskMethod("Task 1", 10, cts.Token), cts.Token);
Console.WriteLine("取消前，第一个任务的状态：{0}", longTask.Status);
cts.Cancel(); //取消任务！
Console.WriteLine("取消后，第一个任务的状态：{0}",longTask.Status);
Console.WriteLine("第一个任务在被执行前就已经取消了！");

接下来，我们来看看start()后再cancel()的情况。示例中每隔半秒打印一下longTask的状态：

var cts = new CancellationTokenSource();
var longTask = new Task<int>(() => TaskMethod("Task 2", 10, cts.Token), cts.Token);
longTask.Start(); //启动任务
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);

特别需要说明的是，在cancel了以后，任务状态显示为RanToCompletion，这是因为从TPL的视角看，这个任务虽然取消了，但是它正常完成了工作并且返回了-1.