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}");
                }
            }
        }
    }
}

輸出效果：