1. 介紹
當你啟動非同步(或耗時)操作時,使用者(或其他程式碼)可能會突然決定:「等等!不需要了!停下來!」。例如使用者決定取消一個超大檔案的下載、關閉程式視窗,或是改變主意不再搜尋大型資料庫。沒有取消支援你的程式可能會繼續跑下去、白白吃資源 — 這可不是對使用者或系統的友善行為。
典型的取消情境:
- 取消檔案下載或取消資料傳送。
- 依使用者要求快速退出複雜資料處理的流程。
- 在長時間任務忽然變得不再重要時暫停/停止該任務。
取消是讓應用程式友善、回應迅速且節省資源的一個重要技巧。
在 .NET 裡怎麼取消非同步操作?
在 .NET 裡用來取消長時間任務的概念是「取消代幣」(CancellationToken)。這是一個會被傳遞到任務各個元件的特殊物件。如果有人請求取消操作 — 代幣會立刻通知程式中所有關心這個訊號的部分。實際上有點像紅旗:誰先看到就先停下來。
在 .NET 中這個機制由兩個主要類別實作:
- CancellationTokenSource — 建立並管理取消代幣。
- CancellationToken — 傳入非同步方法以便它們能被取消。
重點:取消代幣本身不會強制中斷程式碼執行,它只是發出訊號 — 怎麼回應該訊號由你的程式決定。
2. 建立取消代幣並取消任務
我們用一個簡單範例(以教學用的 console 應用程式為例)來看看實作。
範例:支援取消的簡單非同步操作
using System;
using System.Threading;
using System.Threading.Tasks;
namespace DemoApp
{
class Program
{
static async Task Main()
{
// 創建取消代幣來源
CancellationTokenSource cts = new CancellationTokenSource();
// 啟動非同步任務
Task longRunningTask = DoWorkAsync(cts.Token);
Console.WriteLine("請按任意鍵以取消操作...");
Console.ReadKey();
// 請求取消
cts.Cancel();
try
{
await longRunningTask;
}
catch (OperationCanceledException)
{
Console.WriteLine("操作已被取消!");
}
}
// 支援取消的非同步方法
static async Task DoWorkAsync(CancellationToken cancellationToken)
{
for (int i = 0; i < 10; i++)
{
// 檢查取消訊號
cancellationToken.ThrowIfCancellationRequested();
Console.WriteLine($"執行步驟 {i + 1}/10...");
await Task.Delay(1000); // 延遲 1 秒
}
Console.WriteLine("操作已成功完成!");
}
}
}
這是怎麼運作的?
- 我們建立一個 CancellationTokenSource(變數名為 cts),從那裡取得代幣(cts.Token)。
- 把代幣傳給非同步操作。
- 在 DoWorkAsync() 裡定期用 ThrowIfCancellationRequested() 檢查代幣。如果使用者要求取消 — 這個方法會丟出 OperationCanceledException,任務就會中斷。
- 在 Main() 等待按鍵,然後呼叫 cts.Cancel() 來「發出停止訊號」。
如果你不檢查 cancellationToken.IsCancellationRequested 或不呼叫 ThrowIfCancellationRequested(),任務會照常執行 — 代幣只是個資訊性的旗標。
3. CancellationToken:內部如何運作?以及一些小技巧
取消代幣是一個可以在方法與任務之間輕易傳遞的物件。這提供了很大的彈性:
- 同一個代幣可以用在好幾個非同步或同步操作上。
- 如果多個操作使用同一個 CancellationTokenSource 的代幣,就可以實現「群組取消」,一次中止所有任務。
- 取消代幣是不強制的:即便忽略它,程式碼仍會如常運行。
在哪裡、怎麼檢查代幣?
在語意上應該檢查取消訊號的地方去做檢查:迴圈每次迭代、耗時處理的每個步驟、階段切換處等。
// 在任何需要的時候檢查
if (cancellationToken.IsCancellationRequested)
{
Console.WriteLine("操作已取消!退出...");
return;
}
// 或者這樣(簡潔且會丟出例外)
cancellationToken.ThrowIfCancellationRequested();
通常會用 ThrowIfCancellationRequested() — 它會丟出一個特殊例外,呼叫端可以捕捉處理。
4. 標準函式庫的非同步方法
很多 .NET 的類別與非同步方法(特別是 I/O 類型)都原生支援 CancellationToken。應該利用這些支援來「正確」地停止操作。
下面是使用非同步讀檔的範例:
using System.IO;
using System.Threading;
using System.Threading.Tasks;
class FileDemo
{
public static async Task ReadFileWithCancelAsync(string filePath, CancellationToken cancellationToken)
{
using FileStream stream = File.OpenRead(filePath);
byte[] buffer = new byte[4096];
int bytesRead;
while ((bytesRead = await stream.ReadAsync(buffer, 0, buffer.Length, cancellationToken)) > 0)
{
// 處理資料...
// 如果取消代幣已被請求,ReadAsync 會自行拋出 OperationCanceledException
}
}
}
欲了解更多關於 FileStream.ReadAsync 與 CancellationToken 的內容,請參考官方文件。
5. 有用的小細節
逾時也是一種取消!
你可以在超過某段時間後自動取消操作。可以這樣設定取消代幣:
// 建立帶有逾時的 CancellationTokenSource(例如 5 秒)
CancellationTokenSource cts = new CancellationTokenSource(TimeSpan.FromSeconds(5));
過了 5 秒代幣會自動被標記為「已取消」,所有使用該代幣的操作在下一次檢查就會停止。這在你不想無限等待時非常好用。
取消時會發生什麼?
當你對來源呼叫 Cancel() 時,所有使用該代幣並檢查其狀態的方法都會得知這個變化。但如果你的程式碼沒在檢查代幣 — 取消就不會生效。
常見錯誤:忘了把代幣傳給所有支援取消的非同步或耗時呼叫。結果可能是部分工作被取消、部分工作仍然繼續執行,整體行為會很混亂。
視覺化:取消流程如何進行
sequenceDiagram
participant Main as 主執行緒
participant CTS as CancellationTokenSource
participant Task as 非同步任務
Main->>CTS: 建立 CTS,取得代幣
Main->>Task: 傳遞代幣到非同步任務
Note over Task: 任務週期性檢查代幣
Main->>CTS: 呼叫 Cancel()
CTS-->>Task: 代幣狀態變為 "已取消"
Task-->>Main: 拋出 OperationCanceledException
Main->>Main: 捕捉例外並結束工作
取消在哪裡會用到?
- 非同步下載與對伺服器的請求:在網路差或使用者不耐時可以取消。
- 大規模計算:可以依逾時或使用者指示停止計算。
- 網路操作、檔案操作、在背景處理大型集合等情境。
到此為止對取消非同步操作的介紹就結束了 — 現在你的應用程式不只會更快,也會更貼心!
6. 建議與常見錯誤
別忘了 把取消代幣傳給所有支援 cancellation 的方法與呼叫。如果哪裡沒傳到代幣 — 那部分可能會「卡住」而無法停止。
定期檢查代幣 — 特別是在長時間的迴圈、檔案處理或大容量下載時。使用 IsCancellationRequested 或 ThrowIfCancellationRequested()。
不要試圖 從外部去「強制」終止執行緒或任務:取消代幣是個請求,要協作式地停止,而不是用暴力方式終止執行緒。
標準函式庫裡的函式(像是 ReadAsync, Delay, HttpClient.SendAsync)許多都已經透過代幣支援取消,記得善加利用!
處理取消時要捕捉的就是 OperationCanceledException — 這是告知「依請求已正確取消」的專用例外。
GO TO FULL VERSION