在 C# 中，CancellationToken 是用于實(shí)現(xiàn) 協(xié)作式取消（Cooperative Cancellation） 的核心類型，主要應(yīng)用于異步操作、多線程任務(wù)或長(zhǎng)時(shí)間運(yùn)行的任務(wù)。以下是詳細(xì)的講解：

1. 核心概念

• 作用：允許一個(gè)任務(wù)/操作在外部被請(qǐng)求取消，任務(wù)自身會(huì)定期檢查是否被取消請(qǐng)求，實(shí)現(xiàn)優(yōu)雅終止。
• 協(xié)作式：任務(wù)需要主動(dòng)配合檢查取消請(qǐng)求（不能強(qiáng)行終止線程）。
• 組成：
  • CancellationTokenSource：生成和管理 CancellationToken 的類。
  • CancellationToken：傳遞給任務(wù)的結(jié)構(gòu)體，用于傳遞“取消信號(hào)”。

2. 基本用法

步驟 1：創(chuàng)建 CancellationTokenSource 和 Token

var cts = new CancellationTokenSource();
CancellationToken token = cts.Token;

步驟 2：將 Token 傳遞給任務(wù)

Task.Run(() => 
{
    // 任務(wù)邏輯
}, token);

步驟 3：觸發(fā)取消

cts.Cancel(); // 請(qǐng)求取消所有關(guān)聯(lián) Token 的任務(wù)

3. 在任務(wù)中處理取消

輪詢檢查 Token

public void LongRunningOperation(CancellationToken token)
{
    while (!token.IsCancellationRequested)
    {
        // 持續(xù)工作...
        Thread.Sleep(1000);
    }

    // 清理資源，優(yōu)雅退出
    Console.WriteLine("操作被取消。");
}

拋出取消異常

當(dāng)需要直接終止操作時(shí)，可以通過(guò)拋出 OperationCanceledException 來(lái)快速響應(yīng)取消請(qǐng)求：

token.ThrowIfCancellationRequested(); // 如果取消已請(qǐng)求，拋出異常

4. 高級(jí)特性

注冊(cè)取消回調(diào)

當(dāng)取消被觸發(fā)時(shí)，執(zhí)行指定的回調(diào)函數(shù)（如釋放資源）：

token.Register(() => 
{
    Console.WriteLine("清理資源，取消已觸發(fā)！");
});

超時(shí)自動(dòng)取消

利用 CancellationTokenSource 設(shè)置超時(shí)時(shí)間，自動(dòng)觸發(fā)取消：

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(5)); // 5秒后自動(dòng)取消

組合 Token（鏈接）

將多個(gè) CancellationToken 組合成一個(gè)，任一觸發(fā)則全部取消：

var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(token1, token2);
var linkedToken = linkedCts.Token;

5. 異常處理

取消操作通常會(huì)引發(fā)兩種異常：

• OperationCanceledException
• TaskCanceledException（繼承自前者）

示例：

try
{
    await SomeAsyncMethod(token);
}
catch (OperationCanceledException)
{
    Console.WriteLine("操作已被取消。");
}

6. 最佳實(shí)踐

1. 及時(shí)傳遞 Token：將 CancellationToken 傳遞給所有需要支持取消的方法。
2. 避免阻塞操作：在非異步代碼中定期檢查 IsCancellationRequested。
3. 正確處理異常：不濫用 try-catch 忽略取消異常。
4. 釋放資源：確保在取消后清理打開(kāi)的資源（如文件句柄、網(wǎng)絡(luò)連接）。

7. 使用場(chǎng)景

• 用戶取消操作（如界面上的“取消”按鈕）。
• 服務(wù)限時(shí)處理（例如 API 請(qǐng)求超時(shí)）。
• 后臺(tái)任務(wù)管理（如 ASP.NET Core 中請(qǐng)求中止處理）。
• 并行任務(wù)控制（取消一組相關(guān)任務(wù)）。

8. 完整示例

var cts = new CancellationTokenSource();
var token = cts.Token;

// 啟動(dòng)任務(wù)
var task = Task.Run(() =>
{
    try
    {
        while (true)
        {
            token.ThrowIfCancellationRequested();
            Console.WriteLine("工作...");
            Thread.Sleep(1000);
        }
    }
    catch (OperationCanceledException)
    {
        Console.WriteLine("任務(wù)取消。");
    }
});

// 例如：用戶按下取消按鈕，或者超時(shí)自動(dòng)取消
Thread.Sleep(3000);
cts.Cancel();

9. 注意事項(xiàng)

• 線程安全：CancellationToken 是一個(gè)只讀結(jié)構(gòu)體，本身線程安全。
• 資源釋放：CancellationTokenSource 實(shí)現(xiàn)了 IDisposable，長(zhǎng)時(shí)間不使用時(shí)需釋放。
• 不可復(fù)用：一旦取消，Token 無(wú)法重新激活，需創(chuàng)建新的 CancellationTokenSource。

到此這篇關(guān)于C# CancellationToken的使用小結(jié)的文章就介紹到這了,更多相關(guān)C# CancellationToken使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！ 

最新評(píng)論