C# 使用 CancellationTokenSource 终止线程

转载

wx6156f59b48086 2021-12-30 16:54:42

我们在多线程中通常使用一个bool IsExit类似的代码来控制是否线程的运行与终止，其实使用CancellationTokenSource来进行控制更为好用，下面我们将介绍CancellationTokenSource相关用法。

C# 使用 CancellationTokenSource 终止线程

使用CancellationTokenSource对象需要与Task对象进行配合使用，Task会对当前运行的状态进行控制（这个不用我们关心是如何孔控制的）。而CancellationTokenSource则是外部对Task的控制，如取消、定时取消。

下面我们来看看示例代码

class Program
    {
        //声明CancellationTokenSource对象
        static CancellationTokenSource cancelTokenSource = new CancellationTokenSource();
 
        //程序入口
        static void Main(string[] args)
        {
            Task.Factory.StartNew(MyTask, cancelTokenSource.Token);
 
            Console.WriteLine("请按回车键(Enter)停止");
            Console.ReadLine();
 
            cancelTokenSource.Cancel();
            
            Console.WriteLine("已停止");
            Console.ReadLine();
        }
 
        //测试方法
        static void MyTask()
        {
            //判断是否取消任务
            while (!cancelTokenSource.IsCancellationRequested)
            {
                Console.WriteLine(DateTime.Now);
                Thread.Sleep(1000);
            }
        }
    }

Task.Factory.StartNew 创建并启动了 MyTask 方法，并传递了一个 CancellationTokenSource.Token 对象进去。我们可以通过在外部CancellationTokenSource对象进行控制是否取消任务的运行。

当在 MyTask 中的 cancelTokenSource.IsCancellationRequested 判断如果是取消了任务的话就跳出while循环执行。也就结束了任务

我们还可以使用计时取消任务，当一个任务超过了我们所设定的时间然后自动取消该任务的执行。如下代码所示

var cancelTokenSource = new CancellationTokenSource(3000);

除了构造函数，我们还可以使用另外一种方式实现定时取消，如下代码所示

cancelTokenSource.CancelAfter(3000);

运行起来效果是一样的，3秒钟定时取消。

多个 CancellationTokenSource 复合

在有多个CancellationTokenSource需要一起并行管理的时候，比如任意一个任务取消则取消所有任务。我们不必去一个一个的去关闭，只需要将需要一起并行关闭的CancellationTokenSource组合起来就行了。如下代码所示，执行结果是跟上面的图一样的。我就不再上图了。

class Program
    {
        //声明CancellationTokenSource对象
        static CancellationTokenSource c1 = new CancellationTokenSource();
        static CancellationTokenSource c2 = new CancellationTokenSource();
        static CancellationTokenSource c3 = new CancellationTokenSource();
 
        //使用多个CancellationTokenSource进行复合管理
        static CancellationTokenSource compositeCancel = CancellationTokenSource.CreateLinkedTokenSource(c1.Token, c2.Token, c3.Token);
 
        //程序入口
        static void Main(string[] args)
        {
            Task.Factory.StartNew(MyTask, compositeCancel.Token);
 
            Console.WriteLine("请按回车键(Enter)停止");
            Console.ReadLine();
 
            //任意一个 CancellationTokenSource 取消任务，那么所有任务都会被取消。
            c1.Cancel();
            
            Console.WriteLine("已停止");
            Console.ReadLine();
        }
 
        //测试方法
        static void MyTask()
        {
            //判断是否取消任务
            while (!compositeCancel.IsCancellationRequested)
            {
                Console.WriteLine(DateTime.Now);
                Thread.Sleep(1000);
            }
        }
    }