【入門編】【中級者・実務】VB.NETとWPFによる非同期処理のキャンセル制御:CancellationTokenSourceを用いた安全なタスク中断実装 – Visual Basic (VB / VB.NET)解析バイブル

スポンサーリンク
スポンサーリンク

「止まらない処理」から「制御できる処理」へ。VB.NET/WPFで学ぶ、プロのキャンセル実装術

こんにちは。技術の荒波を共に渡る仲間として、今日は一歩上のステージへ進むための「知恵」を共有したいと思います。

皆さんは、Excelマクロ(VBA)からステップアップして、VB.NETとWPFを使ったデスクトップアプリ開発に挑戦している最中かもしれません。「重いデータを読み込むボタン」を作ったとき、処理が終わるまで画面が真っ白になって固まってしまった……。そんな経験はありませんか?

ユーザーからすれば、それは「フリーズ(故障)」に見えます。もし、途中で「やっぱり止めたい」と思っても、強制終了するしか方法がないとしたら、それは「道具」としての信頼を失ってしまいます。

今日は、モダンなWindowsアプリ開発において必須となる「非同期処理のキャンセル制御」をマスターしましょう。これをクリアすれば、あなたの作るアプリは「ただ動くもの」から「プロが認める信頼できるツール」へと進化します。

1. なぜ「強制終了」はタブーなのか?

まず、アーキテクトとしての重要な視点をお伝えします。
「処理が止まらないなら、スレッドを強制的に殺せばいいじゃないか」と思うかもしれません。しかし、これは絶対にやってはいけない禁じ手です。

想像してみてください。巨大なデータベースの更新中に、いきなり電源を切られたらどうなるでしょうか? データは中途半端な状態で壊れ、整合性が失われます。プログラムの世界でも同じです。スレッドを強制終了(Thread.Abort)すると、メモリの解放が行われず、ファイルがロックされたままになり、最悪の場合、アプリケーション全体がクラッシュします。

私たちが目指すべきは、「協調的キャンセル(Cooperative Cancellation)」です。

> 協調的キャンセルとは:
> 「止まれ!」と命令するのではなく、「止まっていいですよ」という合図(信号)を送り、受け取った処理側が「了解、安全な場所で停止します」と自律的に判断して終了する仕組みのことです。

2. 登場人物:CancellationTokenSource と CancellationToken

この「合図」を送るために、.NETの世界では2つの非常に重要なクラスを使います。

1. `CancellationTokenSource` (CTS)

  • 役割: 「信号の発信機」です。キャンセルボタンが押されたときに、「キャンセルせよ!」という信号を発生させる役割を持ちます。

2. `CancellationToken` (CT)

  • 役割: 「信号の受信機」です。重い処理(ループ処理など)の中で、「今、キャンセル信号は届いているかな?」と常に確認するためのチケットのようなものです。

この2つをセットで使うことで、安全な中断が実現します。

3. 実践:モダンなキャンセル実装のコード例

それでは、WPFを使った具体的な実装を見ていきましょう。
「ボタンを押すと重い処理が始まり、進捗が表示される。途中でキャンセルボタンを押すと、安全に中断される」というモデルです。

XAML (UIのデザイン)

まずは、見た目を作ります。`ProgressBar`(進捗バー)と、実行・キャンセル用のボタンを配置します。

<!-- MainWindow.xaml -->
<Window x:Class="MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="Modern Async Task" Height="250" Width="400">
    <StackPanel Margin="20" VerticalAlignment="Center">
        <TextBlock x:Name="StatusText" Text="準備完了" Margin="0,0,0,10" HorizontalAlignment="Center"/>
        
        <!-- 進捗を表示するバー -->
        <ProgressBar x:Name="WorkProgressBar" Height="20" Minimum="0" Maximum="100" Margin="0,0,0,20"/>

        <StackPanel Orientation="Horizontal" HorizontalAlignment="Center">
            <!-- 実行ボタン -->
            <Button x:Name="StartButton" Content="処理開始" Width="80" Margin="5" Click="StartButton_Click"/>
            <!-- キャンセルボタン -->
            <Button x:Name="CancelButton" Content="キャンセル" Width="80" Margin="5" Click="CancelButton_Click" IsEnabled="False"/>
        </StackPanel>
    </StackPanel>
</Window>

VB.NET (ロジックの実装)

ここが心臓部です。`Async/Await` と `CancellationTokenSource` を組み合わせていきます。

' MainWindow.xaml.vb
Imports System.Threading

Class MainWindow
    ' キャンセル信号を送るための「発信機」を保持する変数
    Private _cts As CancellationTokenSource

    ''' <summary>
    ''' 開始ボタンがクリックされた時の処理
    ''' </summary>
    Private Async Sub StartButton_Click(sender As Object, e As RoutedEventArgs)
        ' 1. UIの初期化(ボタンの有効/無効を切り替える)
        StartButton.IsEnabled = False
        CancelButton.IsEnabled = True
        WorkProgressBar.Value = 0
        StatusText.Text = "処理を実行中..."

        ' 2. 新しい「発信機」を作成
        _cts = New CancellationTokenSource()

        Try
            ' 3. 非同期処理を実行(Tokenを渡すのがポイント!)
            ' Awaitを使うことで、UIスレッドを固めずに完了を待機できる
            Await DoHeavyWorkAsync(_cts.Token)

            StatusText.Text = "完了しました!"
        Catch ex As OperationCanceledException
            ' 4. キャンセルされた場合はここに来る
            StatusText.Text = "キャンセルされました。"
        Catch ex As Exception
            ' 5. それ以外の予期せぬエラー
            StatusText.Text = $"エラーが発生しました: {ex.Message}"
        Finally
            ' 6. 後片付け
            ' ボタンの状態を元に戻し、発信機を破棄する
            StartButton.IsEnabled = True
            CancelButton.IsEnabled = False
            _cts.Dispose()
            _cts = Nothing
        End Try
    End Sub

    ''' <summary>
    ''' キャンセルボタンがクリックされた時の処理
    ''' </summary>
    Private Sub CancelButton_Click(sender As Object, e As RoutedEventArgs)
        ' 発信機に対して「キャンセル信号を送れ!」と命じる
        _cts?.Cancel()
    End Sub

    ''' <summary>
    ''' 重い処理のシミュレーション(非同期メソッド)
    ''' </summary>
    ''' <param name="token">キャンセルを確認するためのチケット</param>
    Private Async Function DoHeavyWorkAsync(token As CancellationToken) As Task
        ' 100回のループで重い処理を模倣
        For i As Integer = 1 To 100
            ' 【最重要】ここで「キャンセル信号」が届いていないか確認する!
            ' 信号が届いていれば、ここで OperationCanceledException を投げて自ら終了する
            token.ThrowIfCancellationRequested()

            ' 擬似的な重い処理(100ms待機)
            ' Task.Delayにもtokenを渡すことで、待機中にキャンセルされた場合も即座に反応できる
            Await Task.Delay(100, token)

            ' UIの更新(Progressはメインスレッドで行う必要があるため、Await後のコンテキストで実行)
            WorkProgressBar.Value = i
        Next
    End Function
End Class

4. 陥りやすい「3つの罠」:ここをクリアすればプロ

コードを書き終えたとき、以下の3点に注意してください。これを知っているかどうかが、エンジニアとしての格の違いを生みます。

罠①:`token.ThrowIfCancellationRequested()` を忘れる

重い処理がループ(`For` や `While`)で構成されている場合、ループの中で定期的に「キャンセルされてない?」と確認しなければなりません。これを忘れると、いくらキャンセルボタンを押しても、処理は最後まで走り続けてしまいます。

罠②:`CancellationTokenSource` の破棄(Dispose)を忘れる

`CancellationTokenSource` は、内部でタイマーなどのリソースを使用することがあります。使い終わったら必ず `Dispose()` を呼び出し、後片付けをしましょう。`Try…Finally` ブロックを使って、エラーが起きても必ず破棄されるようにするのが鉄則です。

罠③:`Async/Await` を使わずにスレッドを立てる

`Task.Run` や `Async/Await` を使わずに、古いスタイルの `Thread` クラスを直接操作しようとすると、UIの更新(ProgressBarの操作など)が非常に困難になります。現代のWPF開発では、原則として `Async/Await` による非同期パターンを採用してください。

まとめ:制御できる力こそが、信頼を生む

「動けばいい」という段階から、「どう止めるか」「どう安全に終わらせるか」を考える段階へ。
今回学んだ `CancellationTokenSource` の仕組みは、大規模なシステムや、ネットワーク通信を伴う高度なアプリケーションでも全く同じ考え方で使われます。

1. `CancellationTokenSource` で信号を作り、
2. `CancellationToken` を処理に渡し、
3. `ThrowIfCancellationRequested()` で自律的に止まる。

この3ステップを、ぜひあなたの武器にしてください。
ここをマスターすれば、あなたの作るアプリの信頼性は、格段に向上しているはずですよ。

さあ、次はもっと複雑な、リアルタイムなデータ処理にも挑戦してみましょう。応援しています!

タイトルとURLをコピーしました