はじめに
大量のファイルを読み込んでいる途中で、ユーザーが「キャンセル」ボタンを押したとします。
もう必要のない処理なら、途中で止めたいですよね。
C#には、そのための仕組みとして CancellationToken が用意されています。
ところが、CancellationToken を渡して Cancel() を呼び出したのに、処理が最後まで続いてしまうことがあります。
なぜ、キャンセルを要求したのに止まらないのでしょうか?
今回は、実際に動くコードを比べながら、キャンセルの仕組みを整理していきます。
1. Cancel()したのに処理が止まらない
まずは、次のコードを見てください。
static async Task DoWorkAsync(CancellationToken token)
{
for (int i = 1; i <= 5; i++)
{
Console.WriteLine($"処理中: {i}");
await Task.Delay(1000);
}
Console.WriteLine("処理完了");
}
static async Task Main()
{
using var cts = new CancellationTokenSource();
Task task = DoWorkAsync(cts.Token);
await Task.Delay(2500);
cts.Cancel();
Console.WriteLine("キャンセルを要求しました");
await task;
}
2.5秒後に Cancel() を呼び出しています。ところが、出力は例えば次のようになります。
処理中: 1
処理中: 2
処理中: 3
キャンセルを要求しました
処理中: 4
処理中: 5
処理完了
※実行環境によって表示のタイミングは多少変わります。
CancellationToken を引数で受け取っているのに、最後まで処理が続いています。
原因は、受け取った token を処理の中で一度も使っていないことです。
2. キャンセルは「強制終了」ではなく「お願い」
CancellationToken は、実行中の処理を外から強制的に止める仕組みではありません。
「止めてください」という要求を伝え、処理側がそれを確認して終了する、協調的なキャンセルの仕組みです。
| 役割 | 何をする? |
|---|---|
CancellationTokenSource |
キャンセル要求を発行する |
CancellationToken |
キャンセル要求を処理側へ伝える |
| 処理を実行するメソッド | 要求を確認し、安全なタイミングで処理を終える |
流れを図にすると、次のようになります。
Cancel() を呼んだ瞬間に、どんな処理でも自動的に止まるわけではありません。
要求を出すことと、処理が実際に終了することは別なのです。
3. IsCancellationRequestedで要求を確認する
まずは、処理側でキャンセル要求を確認してみましょう。
static async Task DoWorkAsync(CancellationToken token)
{
for (int i = 1; i <= 5; i++)
{
if (token.IsCancellationRequested)
{
Console.WriteLine("キャンセル要求を確認しました");
return;
}
Console.WriteLine($"処理中: {i}");
await Task.Delay(1000);
}
Console.WriteLine("処理完了");
}
IsCancellationRequested は、キャンセルが要求されていれば true になります。
ここでは return しているため、次の処理へ進まずに終了できます。
ただし、一つ注意があります。
return で終了した場合、返された Task は通常、正常終了(RanToCompletion)として扱われます。
呼び出し元が Task の状態を確認しても、「最後まで処理した」のか「途中でキャンセル要求を見て終了した」のか区別できません。
では、呼び出し元にも「キャンセルされた」と伝えたい場合は、どうすればよいのでしょうか?
4. ThrowIfCancellationRequestedでキャンセルを伝える
その場合に使えるのが、ThrowIfCancellationRequested() です。
static async Task DoWorkAsync(CancellationToken token)
{
for (int i = 1; i <= 5; i++)
{
token.ThrowIfCancellationRequested();
Console.WriteLine($"処理中: {i}");
await Task.Delay(1000);
}
Console.WriteLine("処理完了");
}
キャンセルが要求されていなければ、そのまま進みます。
要求されていれば OperationCanceledException がスローされます。この例外が async Task メソッドから伝播すると、返された Task は Canceled 状態になります。
呼び出し元では、await したところでキャンセルを受け取れます。
static async Task Main()
{
using var cts = new CancellationTokenSource();
Task task = DoWorkAsync(cts.Token);
await Task.Delay(2500);
cts.Cancel();
try
{
await task;
}
catch (OperationCanceledException)
{
Console.WriteLine("処理がキャンセルされました");
}
}
前回の記事では、async Task の例外を呼び出し元で扱うには、await する位置が重要だと説明しました。
今回のキャンセルも同じように、await の位置で受け取れます。
二つの方法を比べると、次のようになります。
IsCancellationRequested |
ThrowIfCancellationRequested() |
|
|---|---|---|
| 動作 | 要求があるか調べる | 要求があれば例外をスローする |
| 終了方法 |
return などを自分で書く |
例外によって処理を中断する |
Task の状態 |
return なら通常は正常終了 |
async Task から例外が伝播すれば Canceled
|
| 使いどころ | 要求に応じて独自の処理をしたい | キャンセルを呼び出し元へ伝えたい |
単に途中で終了するのか、キャンセルされたことも呼び出し元へ伝えるのかを意識すると、使い分けやすくなります。
5. Task.Delayの待機中にもキャンセルしたい
ここまでのコードには、もう一つ気になる点があります。
token.ThrowIfCancellationRequested();
await Task.Delay(1000);
この書き方では、Task.Delay() の待機中にキャンセルを要求しても、待機自体は途中で終了しません。
次にキャンセルを確認するまで、最大でおおむね1秒待つことになります。
そこで、Task.Delay() にもトークンを渡します。
await Task.Delay(1000, token);
Task.Delay はキャンセルに対応したAPIです。トークンを渡しておけば、待機中のキャンセル要求にも反応できます。
ここまでを反映した処理側のコードがこちらです。
static async Task DoWorkAsync(CancellationToken token)
{
for (int i = 1; i <= 5; i++)
{
token.ThrowIfCancellationRequested();
Console.WriteLine($"処理中: {i}");
await Task.Delay(1000, token);
}
Console.WriteLine("処理完了");
}
このコードなら、待機中にキャンセルを要求された場合、Task.Delay() がキャンセルされ、await の位置で OperationCanceledException が発生します。
ただし、すべてのAPIがキャンセルに対応しているわけではありません。キャンセル対応APIにはトークンを渡し、対応していない長い処理では適切な場所で要求を確認する必要があります。
6. 実務で気をつけたい3つのポイント
① トークンは受け取るだけでなく、実際に使う
// トークンを受け取っているだけ
await Task.Delay(5000);
// 待機中のキャンセルにも対応
await Task.Delay(5000, token);
引数に CancellationToken があっても、処理の中で使用していなければ意味がありません。
② 長い処理では途中でも確認する
static void ProcessItems(
IEnumerable<string> items,
CancellationToken token)
{
foreach (string item in items)
{
token.ThrowIfCancellationRequested();
ProcessItem(item);
}
}
この例では、各項目の処理を始める前にキャンセルを確認しています。
ただし、ProcessItem() 自体に長い時間がかかる場合は、その途中で自動的に止まるわけではありません。必要なら、その内部にも確認ポイントを設けます。
③ キャンセルと予期しないエラーを分ける
try
{
await DoWorkAsync(cts.Token);
}
catch (OperationCanceledException)
when (cts.IsCancellationRequested)
{
Console.WriteLine("キャンセルされました");
}
catch (Exception ex)
{
Console.WriteLine($"エラー: {ex.Message}");
}
※このコードは cts が作成済みであることを前提とした例です。実際には、対象の処理に対応するトークンやキャンセル理由も確認しましょう。
ユーザーがキャンセルボタンを押した結果と、予期しないエラーは同じではありません。
また、ファイル保存やデータ更新の途中でキャンセルする場合は、途中までの結果をどう扱うか、後片付けをどうするかも設計する必要があります。
7. まとめ
| 仕組み | 役割 |
|---|---|
CancellationTokenSource |
キャンセル要求を発行する |
CancellationToken |
要求を処理側に伝える |
Cancel() |
キャンセルを要求する(強制終了ではない) |
IsCancellationRequested |
要求されているか確認する |
ThrowIfCancellationRequested() |
要求されていれば例外をスローする |
Task.Delay(時間, token) |
待機中のキャンセルにも対応する |
今回のポイントは、次の3つです。
Cancel()を呼んだだけでは、処理は自動的に止まらない。- 処理側がキャンセル要求を確認し、終了する必要がある。
- キャンセル対応APIには
CancellationTokenを渡す。
キャンセルは、呼び出し元と処理側が協力して実現する仕組みです。
Cancel() したのに処理が止まらないときは、まず処理側がトークンを実際に使っているかを確認してみてください。
それだけでも、原因を切り分ける大きな手がかりになります。
関連記事
C#の非同期処理について、こちらの記事でも解説しています。
awaitは待つのに、なぜ画面は止まらないの?
非同期処理の基本的な仕組みを知りたい方へ。
async voidはなぜ避けた方がいいの?
非同期処理での例外の扱いを知りたい方へ。
async Taskなのに例外を捕まえられない?
await と try-catch の関係を理解したい方へ。