C# CancellationToken和CancellationTokenSource的用法詳解
CancellationToken
CancellationToken有一個構(gòu)造函數(shù)，可以傳入一個bool類型表示當前的CancellationToken是否是取消狀態(tài)。另外，因為CancellationToken是一個結(jié)構(gòu)體，所以它還有一個空參數(shù)的構(gòu)造函數(shù)。
public CancellationToken();//因為是結(jié)構(gòu)體，才有空構(gòu)造函數(shù)，不過沒什么作用
public CancellationToken(bool canceled);
屬性如下：
//靜態(tài)屬性，獲取一個空的CancellationToken，這個CancellationToken注冊的回調(diào)方法不會被觸發(fā)，作用類似于使用空構(gòu)造函數(shù)得到的CancellationToken
public static CancellationToken None { get; }
//表示當前CancellationToken是否可以被取消
public bool CanBeCanceled { get; }
//表示當前CancellationToken是否已經(jīng)是取消狀態(tài)
public bool IsCancellationRequested { get; }
//和CancellationToken關(guān)聯(lián)的WaitHandle對象，CancellationToken注冊的回調(diào)方法執(zhí)行時通過這個WaitHandle實現(xiàn)的
public WaitHandle WaitHandle { get; }
常用方法：
//往CancellationToken中注冊回調(diào)
public CancellationTokenRegistration Register(Action callback);
public CancellationTokenRegistration Register(Action callback, bool useSynchronizationContext);
public CancellationTokenRegistration Register([NullableAttribute(new[] { 1, 2 })] Action<object?> callback, object? state);
public CancellationTokenRegistration Register([NullableAttribute(new[] { 1, 2 })] Action<object?> callback, object? state, bool useSynchronizationContext);
//當CancellationToken處于取消狀態(tài)是，拋出System.OperationCanceledException異常
public void ThrowIfCancellationRequested();
常用的注冊回調(diào)的方法是上面4個Register方法，其中callback是回調(diào)執(zhí)行的委托，useSynchronizationContext表示是否使用同步上下文，state是往回調(diào)委托中傳的參數(shù)值
另外，Register方法會返回一個CancellationTokenRegistration結(jié)構(gòu)體，當注冊回調(diào)之后，可以調(diào)用CancellationTokenRegistration的Unregister方法來取消注冊，這個Unregister方法會返回一個bool值，當成功取消時返回true，當取消失?。ū热缁卣{(diào)已執(zhí)行）將返回false:
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
var cancellationTokenRegistration = cancellationTokenSource.Token.Register(() =>
{
Console.WriteLine("Canceled");//這里將不會執(zhí)行輸出
});
//cancellationTokenSource.Cancel();
//var result = cancellationTokenRegistration.Unregister();//result = false
var result = cancellationTokenRegistration.Unregister();//result = true
cancellationTokenSource.Cancel();
上面提到，CancellationToken可以使用構(gòu)造函數(shù)直接構(gòu)造，同時可以傳入一個參數(shù)，表示當前的狀態(tài)，需要注意的是，CancellationToken的狀態(tài)最多可以改變一次，也就是從未取消變成已取消。
如果構(gòu)造時傳入true，也就是說CancellationToken是已取消狀態(tài)，這個時候注冊的回調(diào)都會立即執(zhí)行：
CancellationToken cancellationToken = new CancellationToken(true);
cancellationToken.Register(() =>
{
Console.WriteLine("Canceled");//這里會立即執(zhí)行輸出Canceled
});
但如果構(gòu)造時傳入的是false，說明CancellationToken處于未取消狀態(tài)，這時候注冊的回到都會處于一個待觸發(fā)狀態(tài)：
CancellationToken cancellationToken = new CancellationToken(false);
cancellationToken.Register(() =>
{
Console.WriteLine("Canceled");//這里不會立即執(zhí)行輸出
});
通過Register方法注冊的服務(wù)只會執(zhí)行一次！
但一般的，如果傳入false構(gòu)造出來的CancellationToken，可以認為是不會觸發(fā)的，因為它沒有觸發(fā)的方法！所以一般的，我們都不會直接使用構(gòu)造函數(shù)創(chuàng)建CancellationToken，而是使用CancellationTokenSource對象來獲取一個CancellationToken
CancellationTokenSource
CancellationTokenSource可以理解為CancellationToken的控制器，控制它什么時候變成取消狀態(tài)的一個對象，它有一個CancellationToken類型的屬性Token，只要CancellationTokenSource創(chuàng)建，這個Token也會被創(chuàng)建，同時Token會和這個CancellationTokenSource綁定
//表示Token是否已處于取消狀態(tài)
public bool IsCancellationRequested { get; }
//CancellationToken 對象
public CancellationToken Token { get; }
可以直接創(chuàng)建一個CancellationTokenSource對象，同時指定一個時間段，當過了這段時間后，CancellationTokenSource就會自動取消了。
CancellationTokenSource的取消有4個方法：
//立刻取消
public void Cancel();
//立刻取消
public void Cancel(bool throwOnFirstException);
//延遲指定時間后取消
public void CancelAfter(int millisecondsDelay);
//延遲指定時間后取消
public void CancelAfter(TimeSpan delay);
Cancel和兩個CancelAfter方法沒什么特別的，主要就是有一個延遲的效果，需要注意的是Cancel的兩個重載之間的區(qū)別。
首先，上面說道，CancellationToken狀態(tài)只能改變一次（從未取消變成已取消），當CancellationToken時已取消狀態(tài)時，每次往其中注冊的回調(diào)都會立刻執(zhí)行！當處于未取消狀態(tài)時，注冊進去的回調(diào)都會等待執(zhí)行。
需要注意的是，當在未取消狀態(tài)下注冊多個回調(diào)時，它們在執(zhí)行時是一個類似棧的結(jié)構(gòu)順序，先注冊后執(zhí)行。
而CancellationToken的Register可以注冊多個回調(diào)，那他們可能都會拋出異常，throwOnFirstException參數(shù)表示在第一次報錯時的處理行為.
throwOnFirstException = true 表示立即拋出當前發(fā)生的異常，后續(xù)的回調(diào)將會取消執(zhí)行
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
try
{
cancellationTokenSource.Token.Register(() =>
{
throw new Exception("1");
});
cancellationTokenSource.Token.Register(() =>
{
throw new Exception("2");//不會執(zhí)行
});
cancellationTokenSource.Cancel(true);
}
catch (Exception ex)
{
//ex is System.Exception("1")
}
throwOnFirstException = false 表示跳過當前回調(diào)的異常，繼續(xù)執(zhí)行生效的回調(diào)，等所有的回調(diào)執(zhí)行完成之后，再將所有的異常打包成一個System.AggregateException異常拋出來！
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
try
{
cancellationTokenSource.Token.Register(() =>
{
throw new Exception("1");
});
cancellationTokenSource.Token.Register(() =>
{
throw new Exception("2");
});
cancellationTokenSource.Cancel(false);//相當于cancellationTokenSource.Cancel()
}
catch (Exception ex)
{
//ex is System.AggregateException:[Exception("2"),Exception("1")]
}
CancellationTokenSource還可以與其它CancellationToken關(guān)聯(lián)起來，生成一個新的CancellationToken，當其他CancellationToken取消時，會自動觸發(fā)當前的CancellationTokenSource執(zhí)行取消動作！
使用場景一
當我們創(chuàng)建異步操作時，可以傳入一個CancellationToken，當異步操作處于等待執(zhí)行狀態(tài)時，可以通過設(shè)置CancellationToken為取消狀態(tài)將異步操作取消執(zhí)行：
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
var task = new Task(() =>
{
Thread.Sleep(1500);//執(zhí)行了2秒中代碼
Console.WriteLine("Execute Some Code");
}, cancellationTokenSource.Token);
task.Start();//啟動，等待調(diào)度執(zhí)行
//發(fā)現(xiàn)不對，可以取消task執(zhí)行
cancellationTokenSource.Cancel();
Thread.Sleep(1000);//等待1秒
Console.WriteLine("Task狀態(tài)：" + task.Status);//Canceled
但是經(jīng)常的，我們的取消動作可能不會那么及時，如果異步已經(jīng)執(zhí)行了，再執(zhí)行取消時無效的，這是就需要我們自己在異步委托中檢測了：
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
var task = new Task(() =>
{
Thread.Sleep(1500);//執(zhí)行了2秒中代碼
cancellationTokenSource.Token.ThrowIfCancellationRequested();
Console.WriteLine("Execute Some Code");
}, cancellationTokenSource.Token);
task.Start();//啟動，等待調(diào)度執(zhí)行
Thread.Sleep(1000);////一段時間后發(fā)現(xiàn)不對，可以取消task執(zhí)行
cancellationTokenSource.Cancel();
Thread.Sleep(1000);//等待1秒
Console.WriteLine("Task狀態(tài)：" + task.Status);//Canceled
使用場景二
有時，我們希望在觸發(fā)某個時間后，可以執(zhí)行某些代碼功能，但是在異步環(huán)境下，我們不能保證那些要執(zhí)行的代碼是否已準備好了，比如我們有一個Close方法，當調(diào)用Close后表示是關(guān)閉狀態(tài)，如果我們相當程序處于關(guān)閉狀態(tài)時執(zhí)行一些通知，一般的，我們可能是想到采用事件模型，或者在Close方法傳入事件委托，或者采用一些諸如模板設(shè)計這樣的模型去實現(xiàn)：
class Demo
{
public void Close(Action callback)
{
//關(guān)閉
Thread.Sleep(3000);
callback?.Invoke();//執(zhí)行通知
}
}
或者
class Demo
{
public event Action Callback;
public void Close()
{
//關(guān)閉
Thread.Sleep(3000);
Callback?.Invoke();//執(zhí)行通知
}
}
但是這就有問題了，如果是傳入?yún)?shù)或者采用事件模型，因為前面說過了，如果在異步環(huán)境下，我們不能保證那些要執(zhí)行的代碼是否已準備好了，也許在執(zhí)行Close方法時，程序還未注冊回調(diào)。
這個時候就可以使用CancellationToken來解決這個問題：
主需要往Token屬性中注冊回調(diào)而無需關(guān)注Close什么時候執(zhí)行了
使用場景三
有時候，我們寫一個異步無限循環(huán)的方法去處理一些問題，而我們希望可以在方法外來停止它這個時候，我們就可以通過返回CancellationTokenSource來實現(xiàn)了：
public CancellationTokenSource Listen()
{
CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
//循環(huán)調(diào)度執(zhí)行
Task.Run(() =>
{
while (true)
{
cancellationTokenSource.Token.ThrowIfCancellationRequested();
//循環(huán)執(zhí)行一些操作
Thread.Sleep(1000);
Console.WriteLine("Run");
}
});
return cancellationTokenSource;
}
以上就是C# CancellationToken和CancellationTokenSource的用法詳解的詳細內(nèi)容，更多關(guān)于C# CancellationToken和CancellationTokenSource的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Unity UGUI的InputField輸入框組件使用詳解
這篇文章主要為大家介紹了Unity UGUI的InputField輸入框組件使用詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-07-07
這篇文章主要為大家詳細介紹了C#使用Npoi導(dǎo)出Excel并合并行列，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-02-02
c#使用ManagedWifi查看當前Wifi信號并選擇wifi的示例
這篇文章主要介紹了c#使用ManagedWifi查看當前Wifi信號并選擇wifi的示例,需要的朋友可以參考下2014-04-04
這篇文章主要介紹了利用C#修改Windows操作系統(tǒng)時間，幫助大家更好的利用c#操作系統(tǒng)，感興趣的朋友可以了解下2020-10-10
C#中BitConverter.ToUInt16()和BitConverter.ToString()的簡單使用
這篇文章主要介紹了C#中BitConverter.ToUInt16()和BitConverter.ToString()的簡單使用,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-02-02
WinForm DataGridView控件隔行變色的小例子
WinForm的DataGridView控件設(shè)置行的顏色2013-03-03
C#讀取xml節(jié)點數(shù)據(jù)方法小結(jié)
這篇文章主要介紹了C#讀取xml節(jié)點數(shù)據(jù)的方法,實例總結(jié)了C#針對XML文件節(jié)點操作的相關(guān)技巧,需要的朋友可以參考下2015-06-06
c#生成縮略圖的實現(xiàn)方法，需要的朋友可以參考一下2013-04-04
在我們?nèi)粘９ぷ髦谐Ｓ玫腃#跳轉(zhuǎn)語句有break、continue、return,但是還有一個C#跳轉(zhuǎn)語句很多同學(xué)可能都比較的陌生就是goto,下面我們就來看看goto跳轉(zhuǎn)語句的用法吧2024-03-03
這篇文章主要為大家詳細介紹了使用C#操作ftp服務(wù)器的相關(guān)知識,文中的示例代碼講解詳細,具有一定的借鑒價值,有需要的小伙伴可以參考下2024-02-02