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

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

制御の真髄:VB.NET/WPFにおける協調的キャンセル実装の極意

エンタープライズ領域のシステム開発において、我々が直面する最大の敵は「不確実性」である。

巨大なDBクエリ、数ギガバイトに及ぶファイルI/O、あるいは外部APIとの不安定な通信。これら「重い処理」をユーザーの待機時間(UIスレッド)に委ねることは、設計上の怠慢であり、プロフェッショナルとしての敗北を意味する。しかし、単に `Task.Run` で別スレッドに逃がせば解決するわけではない。

真に優れたアーキテクトが設計すべきは、「ユーザーがいつでも安全に、かつ確実に処理を中断できる仕組み」である。

本稿では、VB.NETとWPFを用いたモダンな非同期実装において、`CancellationTokenSource` を用いた「協調的キャンセル(Cooperative Cancellation)」の極限的な実装手法を解説する。これは単なる実装テクニックではない。オブジェクトのライフサイクルと、スレッド間の秩序を維持するための、エンジニアリングの規律である。

1. 「強制終了」という禁忌:なぜ協調的キャンセルが必要か

多くの未熟なエンジニアは、処理を中断するために「スレッドを強制的にKillする」という発想を持つ。しかし、これは極めて危険な行為だ。

スレッドを強制終了させれば、メモリ上のリソースは解放されず、ファイルハンドルは開きっぱなしになり、DBトランザクションは中途半端な状態で残留する。これはシステム全体のデッドロックやデータ破損を招く「禁忌」である。

我々が採用すべきは、「スレッドに対して『中断してください』という信号を送り、スレッド自身が安全な地点で自ら停止する」という、協調的なアプローチである。そのための鍵となるのが `CancellationToken` である。

2. CancellationTokenSource の設計思想

`CancellationTokenSource` (CTS) と `CancellationToken` の関係を、正しく理解せよ。

  • CancellationTokenSource (信号機): キャンセルを「命令」する主体。
  • CancellationToken (信号): キャンセルされた状態を「観測」する受容体。

アーキテクチャ上の鉄則は、「命令側(CTS)と観測側(Token)を明確に分離すること」である。メソッドの引数として渡すべきは、常に `CancellationToken` であり、`CancellationTokenSource` そのものであってはならない。

3. 実践的実装:WPFにおける非同期キャンセル制御

以下に、WPFのViewModel層を想定した、堅牢な実装パターンを示す。ここでは、重い計算処理をシミュレートしつつ、UIをフリーズさせずにキャンセルを制御する。

Imports System.Threading
Imports System.Threading.Tasks

''' <summary>
''' 業務ロジックを司るサービス層のシミュレーション
''' </summary>
Public Class HeavyDutyService
    ''' <summary>
    ''' 重いデータ処理を実行する。
    ''' </summary>
    ''' <param name="ct">キャンセル要求を監視するためのトークン</param>
    Public Async Function ExecuteComplexProcessAsync(ct As CancellationToken) As Task
        ' 処理のフェーズを分割し、各フェーズの境界でキャンセルをチェックする
        For i As Integer = 1 To 10
            ' 【極意1】ThrowIfCancellationRequested を使用せよ。
            ' 単なる If 文による return ではなく、例外を投げることで
            ' Task の状態を「Canceled」として正しく伝播させる。
            ct.ThrowIfCancellationRequested()

            ' 重い処理のシミュレーション (I/O待ちや計算)
            ' Task.Delay にもトークンを渡すことで、待機中であっても即座に反応できる
            Await Task.Delay(1000, ct)

            Debug.WriteLine($"Phase {i} completed.")
        Next
    End Function
End Class

''' <summary>
''' WPFのViewModel層を想定した制御ロジック
''' </summary>
Public Class MainViewModel Implements INotifyPropertyChanged
    Private ReadOnly _service As New HeavyDutyService()
    Private _cts As CancellationTokenSource
    
    ' UIバインディング用のプロパティ(簡略化)
    Public Property IsProcessing As Boolean = False
    Public Property StatusMessage As String = "Ready"

    ''' <summary>
    ''' 処理開始コマンド
    ''' </summary>
    Public Async Function StartCommandAsync() As Task
        ' 【極意2】二重起動の防止と、古いCTSの破棄
        If IsProcessing Then Return
        
        ' 前回のキャンセル要求が残っている場合に備え、古いリソースを確実に解放する
        _cts?.Dispose()
        _cts = New CancellationTokenSource()

        Try
            IsProcessing = True
            StatusMessage = "Processing..."

            ' 非同期タスクの実行
            Await _service.ExecuteComplexProcessAsync(_cts.Token)

            StatusMessage = "Completed Successfully."
        Catch ex As OperationCanceledException
            ' 【極意3】キャンセルは「エラー」ではなく「意図された中断」として扱う
            StatusMessage = "Operation was canceled by user."
            Debug.WriteLine("Task was canceled gracefully.")
        Catch ex As Exception
            ' 真の異常系のみをここで捕捉する
            StatusMessage = $"Error: {ex.Message}"
            Debug.WriteLine($"Critical Error: {ex.ToString()}")
        Finally
            ' 【極意4】リソースのクリーンアップは必ず Finally で行う
            IsProcessing = False
            ' CTS 自体の破棄は、次の開始時か、ViewModel の破棄時に行う
        End Try
    End Function

    ''' <summary>
    ''' キャンセルコマンド
    ''' </summary>
    Public Sub CancelCommand()
        ' キャンセル信号を発火させる
        _cts?.Cancel()
    End Sub

    ' INotifyPropertyChanged の実装は省略
    Public Event PropertyChanged As System.ComponentModel.PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged
End Class

4. アーキテクトが注視すべき「3つの落とし穴」

実装において、シニアエンジニアが絶対に陥ってはならない罠が3つある。

① リソースリーク:CancellationTokenSource の Dispose 漏れ

`CancellationTokenSource` は内部的に `WaitHandle` を生成する。これは OS レベルのリソースであり、適切に `Dispose()` しなければ、メモリリーク、ひいてはハンドルリークを引き起こす。
「使い終わったら捨てる」のではなく、「新しいインスタンスを作る前に、古いインスタンスを確実に Dispose する」というライフサイクル管理を徹底せよ。

② ゾンビ・タスク:トークンを無視する同期コード

`Task.Run` の中で、`CancellationToken` を受け取っていない古いレガシーな同期メソッド(例:`Thread.Sleep` や、引数にトークンを持たない `File.ReadAllBytes`)を呼び出している場合、`Cancel()` を実行してもその処理は止まらない。
これを「ゾンビ・タスク」と呼ぶ。非同期チェーンのどこかに「キャンセルを無視するブラックボックス」が存在すると、システム全体の制御権は失われる。

③ 例外処理の誤用:OperationCanceledException の無視

キャンセルが発生した際、`Task` は `OperationCanceledException` を投げる。これを一般的な `Exception` としてキャッチし、「エラーが発生しました」とユーザーに表示するのは、UX(ユーザーエクスペリエンス)の観点からも、システムログの健全性の観点からも極めて不適切である。
キャンセルは「正常な制御フローの一環」として、専用のハンドリングを行うべきだ。

5. レガシー環境との連携:Windows API との境界線

もし、あなたが呼び出しているのが、キャンセル機能を持たない Win32 API や古い COM コンポーネントである場合、どうすべきか?

直接その API を止めることは不可能だ。その場合の次善の策は、「タスクの監視(Watchdog)」である。

1. API 呼び出しを `Task.Run` でラップする。
2. `Task.WhenAny(apiTask, Task.Delay(-1, cancellationToken))` を使用する。
3. キャンセルが発生した場合、API タスク自体はバックグラウンドで動き続ける(ゾンビ化する)ことを許容しつつ、UI 側には「中断された」という制御を即座に返す。

ただし、この手法はあくまで「見た目上の制御」であり、バックグラウンドでリソースを消費し続けるリスクを伴う。真の解決策は、その API 自体を非同期・キャンセル対応のものへリプレイスすることにある。

結語

WPF と VB.NET における非同期制御の本質は、単に「画面を固めないこと」ではない。それは、「システムの状態を常に予測可能(Predictable)に保つこと」である。

`CancellationToken` を正しく使いこなし、オブジェクトのライフサイクルを厳格に管理する。その一見地味な規律の積み重ねこそが、大規模な業務システムにおける「堅牢性」という名の、揺るぎない信頼を築き上げるのである。

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