c#: 使用CancellationTokenSource取消异步任务

环境：

• window 10
• vs2019 16.5.1
• .net core 3.1.1

参考：
任务Task系列之使用CancellationToken取消Task

注意： CancellationTokenSource只是一个标志，是否退出线程，什么时候退出线程需要自己在线程中监视并作出响应。

一、CancellationTokenSource的简单使用

第一步：创建一个CancellationTokenSource cts=...
第二步：将创建的cts传递给Task构造参数（可以在Task开启前取消这个Task）
第三步：Task中的方法要能访问到cts.Token，在需要的地方判断cts的信号
看如下代码：

using System;
using System.Collections;
using System.Data;
using System.IO;
using System.Net;
using System.Threading;
using System.Threading.Tasks;

namespace TestDI
{
    class Program
    {
        public static void Main(string[] args)
        {
            CancellationTokenSource cts = new CancellationTokenSource();
            var task = new Task(() => Run("xiaoming", cts.Token), cts.Token);
            task.Start();
            Thread.Sleep(5000);
            cts.Cancel();
            Console.WriteLine("ok!");
            Console.ReadLine();
        }

        public static void Run(object state, CancellationToken token)
        {
            while (true)
            {
                if (token.IsCancellationRequested)
                {
                    return;
                }
                else
                {
                    Thread.Sleep(1000);
                    Console.WriteLine($"state={state},任务线程:{Thread.CurrentThread.ManagedThreadId},是否是守护线程:{Thread.CurrentThread.IsBackground},是否是线程池:{Thread.CurrentThread.IsThreadPoolThread}");
                }
            }
        }
    }
}

输出效果：

可在创建Task时将一个CancellationToken传给构造器，从而将两者相关联，如果CancellationToken在Task调度前取消，那么Task就会被取消，永远都不执行。但如果Task已调度，那么Task的代码就只支持显示取消，其操作才能在执行期间取消，遗憾的是，虽然Task关联了一个CancellationToken，但却没有办法访问他。因此，必须在Task的代码中获得创建Task对象时的同一个CancellationToken。为此，最简单的办法就是使用一个Lamda表达式，将CancellationToken作为闭包变量传递。

二、使用同一个CancellationTokenSource取消多个任务

只需要多个task使用相同的CancellationTokenSource.Token即可，将上面的代码稍微改动下：

public static void Main(string[] args)
{
    CancellationTokenSource cts = new CancellationTokenSource();
    for (int i = 0; i < 5; i++)
    {
        var msg = "xiaoming" + (i + 1);
        var task = new Task(() => Run(msg, cts.Token), cts.Token);
        task.Start();
    }
    Thread.Sleep(5000);
    cts.Cancel();
    Console.WriteLine("ok!");
    Console.ReadLine();
}

输出如下：

三、多个 CancellationTokenSource 复合使用

这种应用的场景为：当有多个CancellationTokenSource用来作用于一个异步任务的时候，你想达到其中一个CancellationTokenSource取消就取消这个异步任务的效果。
看下面代码：

using System;
using System.Collections;
using System.Data;
using System.IO;
using System.Net;
using System.Threading;
using System.Threading.Tasks;

namespace TestDI
{
    class Program
    {
        public static void Main(string[] args)
        {
            CancellationTokenSource cts1 = new CancellationTokenSource();
            CancellationTokenSource cts2 = new CancellationTokenSource();
            CancellationTokenSource cts3 = new CancellationTokenSource();
            CancellationTokenSource compositeCts = CancellationTokenSource.CreateLinkedTokenSource(cts1.Token, cts2.Token, cts3.Token);
            var task = new Task(() => Run("xiaoming", compositeCts.Token), compositeCts.Token);
            task.Start();
            Thread.Sleep(5000);
            cts1.Cancel();
            Console.WriteLine("ok!");
            Console.ReadLine();
        }

        public static void Run(object state, CancellationToken token)
        {
            while (true)
            {
                if (token.IsCancellationRequested)
                {
                    return;
                }
                else
                {
                    Thread.Sleep(1000);
                    Console.WriteLine($"state={state},任务线程:{Thread.CurrentThread.ManagedThreadId},是否是守护线程:{Thread.CurrentThread.IsBackground},是否是线程池:{Thread.CurrentThread.IsThreadPoolThread}");
                }
            }
        }
    }
}

输出效果：