C# 中取消任務（Task）的正確方式
作者：lyl
CancellationToken? 是一個結構，用于傳遞取消操作的通知，如用戶請求取消或超時。CancellationTokenSource? 是用于生成 CancellationToken 的類，并提供了取消該令牌的方法。
在C#中，異步編程是處理耗時操作，如I/O請求、數據庫調用或網絡請求等，而不阻塞主線程的一種有效方法。Task 類是這種異步操作的核心，它允許我們啟動異步操作并等待其完成。然而，有時我們可能需要在任務完成之前取消它，特別是當任務依賴于某些外部條件或用戶交互時。在C#中，取消任務通常通過使用 CancellationToken 來實現。
CancellationToken 和 CancellationTokenSource
CancellationToken 是一個結構，用于傳遞取消操作的通知，如用戶請求取消或超時。CancellationTokenSource 是用于生成 CancellationToken 的類，并提供了取消該令牌的方法。
下面是一個簡單的示例，展示了如何使用 CancellationToken 和 CancellationTokenSource 來取消一個任務：
using System;
using System.Threading;
using System.Threading.Tasks;
class Program
{
static async Task Main(string[] args)
{
using CancellationTokenSource cts = new CancellationTokenSource();
CancellationToken cancellationToken = cts.Token;
// 啟動一個可以被取消的任務
Task myTask = Task.Run(() => DoWork(cancellationToken), cancellationToken);
// 假設一段時間后，我們決定取消任務
await Task.Delay(2000); // 等待2秒
Console.WriteLine("Cancelling the task...");
cts.Cancel(); // 發送取消信號
try
{
await myTask; // 等待任務完成或捕獲到OperationCanceledException異常
}
catch (OperationCanceledException)
{
Console.WriteLine("Task was cancelled");
}
}
static void DoWork(CancellationToken cancellationToken)
{
for (int i = 0; i < 10; i++)
{
if (cancellationToken.IsCancellationRequested)
{
Console.WriteLine("Cancellation requested.");
// 檢查取消標記，如果已請求取消，則退出循環或執行其他清理操作
break; // 或者返回，拋出OperationCanceledException等。
}
// 模擬工作正在進行中...
Thread.Sleep(500); // 不要在生產代碼中使用Thread.Sleep! 這里只是為了示例。
Console.WriteLine("Working...");
}
}
}在這個示例中，我們創建了一個 CancellationTokenSource 實例，并使用其 Token 屬性生成了一個 CancellationToken。然后，我們將這個令牌傳遞給了一個在后臺運行的任務（通過 Task.Run）。稍后，我們決定取消這個任務，于是調用了 CancellationTokenSource.Cancel 方法來提供取消信號。在任務代碼中，我們定期檢查取消標記，如果已請求取消，則退出循環。
注意事項和最佳實踐：
- 定期檢查取消標記：在你的任務代碼中，你應該定期檢查 CancellationToken.IsCancellationRequested 屬性，以便在收到取消請求時能夠迅速響應。
- 處理取消請求：當檢測到取消請求時，你的代碼應該盡快停止當前的操作并退出。你可以通過拋出 OperationCanceledException 異常、返回或執行其他適當的清理操作來實現這一點。
- 使用正確的等待方式：在等待可能被取消的任務時，最好使用 await 關鍵字而不是 Task.Wait() 或 Task.Result，因為后者在任務被取消時會拋出 AggregateException 而不是 OperationCanceledException，這可能會使異常處理更加復雜。
- 資源清理：確保在取消操作后妥善處理和清理所有已分配的資源，以避免內存泄漏或其他潛在問題。這包括關閉文件句柄、釋放數據庫連接等。
- 文檔和測試：如果你的方法接受一個 CancellationToken 參數，確保在方法的文檔中明確說明這一點，并編寫針對取消操作的單元測試，以確保你的代碼在收到取消信號時能夠正確響應。
責任編輯：武曉燕
來源：
程序員編程日記
