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

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

ゾンビ・タスクを根絶せよ:WPFにおける「協調的キャンセル」による堅牢な非同期制御

業務自動化ツールの開発において、もっとも恐ろしいバグは何だと思うか?
画面が固まること(フリーズ)か? いや、違う。

真の恐怖は、「ユーザーがキャンセルを押したはずなのに、裏側で重い処理が動き続け、データベースやファイルシステムを食いつぶし続ける『ゾンビ・タスク』の発生」だ。

多くの開発者は、`Async/Await` を使ってUIを固まらないようにすることには成功する。しかし、そのタスクを「いかにして、安全かつエレガントに中断させるか」という設計思想において、決定的な欠陥を抱えていることが多い。

今回は、VB.NETとWPFを用いたモダンなアプリケーション開発において、`CancellationTokenSource` を駆使した「協調的キャンセル(Cooperative Cancellation)」の実装手法を伝授する。これは、単なるテクニックではない。プロフェッショナルとしての「責務」だ。

1. なぜ「強制終了」は悪なのか?

まず、初心者が陥りがちな致命的なミスを指摘しておこう。
処理を止めたいがために、`Thread.Abort()` を使おうとしたり、あるいはスレッドを無理やり破棄しようとする設計だ。これは、設計者として「失格」と言わざるを得ない。

なぜなら、強制終了は「リソースの不整合」を招くからだ。

  • DBトランザクションの未完了: 書き込みの途中でスレッドを殺せば、ロールバックが正しく行われず、データが破損する可能性がある。
  • ファイルハンドルの開放漏れ: ファイルを書き込み中にプロセスを断絶すれば、ファイルがロックされたままになり、次回の実行を妨げる。
  • メモリリーク: 解放されるべきオブジェクトが、中途半端な状態でメモリに居座り続ける。

我々が目指すべきは、タスクに対して「もう止まってくれ」と「お願い」をし、タスク自身が「了解、安全な状態で止まるよ」と「応答」する仕組み。これこそが協調的キャンセルだ。

2. アーキテクチャの核心:CancellationTokenSource のライフサイクル

`CancellationTokenSource` (CTS) は、キャンセル信号を発行するための「司令塔」である。そして、その信号を受け取るための「受取票」が `CancellationToken` だ。

設計の鉄則は以下の通りだ:
1. CTSの生成: 非同期処理を開始する直前に生成する。
2. Tokenの伝播: 生成した `Token` を、呼び出すすべての非同期メソッドの引数として「バケツリレー」のように渡していく。
3. キャンセルの実行: ユーザーがボタンを押した瞬間、`cts.Cancel()` を呼び出す。
4. 例外のハンドリング: キャンセルが発生すると、タスクは `OperationCanceledException` を投げる。これを適切にキャッチして、クリーンアップを行う。

3. 実装例:プロダクションレベルの非同期キャンセル・パターン

以下に、WPFのMVVMパターンを意識した、そのまま実務に転用可能な実装例を示す。

ViewModel層の設計

Imports System.Threading
Imports System.Threading.Tasks
Imports System.ComponentModel

''' <summary>
''' 業務処理を制御するViewModel
''' </summary>
Public Class MainViewModel
    Implements INotifyPropertyChanged

    ' キャンセル制御のためのソース
    Private _cts As CancellationTokenSource
    
    ' プロパティ(UIバインディング用)
    Private _isProcessing As Boolean = False
    Public Property IsProcessing As Boolean
        Get
            Return _isProcessing
        End Get
        Set(value As Boolean)
            _isProcessing = value
            OnPropertyChanged(NameOf(IsProcessing))
        End Set
    End Property

    Private _statusMessage As String = "待機中..."
    Public Property StatusMessage As String
        Get
            Return _statusMessage
        End Get
        Set(value As String)
            _statusMessage = value
            OnPropertyChanged(NameOf(StatusMessage))
        End Set
    End Property

    ''' <summary>
    ''' 重い業務処理を開始する
    ''' </summary>
    Public Async Function StartProcessAsync() As Task
        ' 二重起動防止
        If IsProcessing Then Return

        ' 1. CTSの初期化
        _cts = New CancellationTokenSource()
        IsProcessing = True
        StatusMessage = "処理実行中..."

        Try
            ' 2. 非同期メソッドにTokenを渡して実行
            ' Task.Runを使用してバックグラウンドスレッドにオフロードする
            Await Task.Run(Function() DoHeavyWorkAsync(_cts.Token), _cts.Token)

            StatusMessage = "処理が正常に完了しました。"
        Catch ex As OperationCanceledException
            ' 3. キャンセル時のハンドリング
            StatusMessage = "ユーザーによって処理が中断されました。"
        Catch ex As Exception
            ' 4. その他のエラーハンドリング
            StatusMessage = $"エラー発生: {ex.Message}"
        Finally
            ' 5. 後始末(重要!)
            IsProcessing = False
            _cts.Dispose()
            _cts = Nothing
        End Try
    End Function

    ''' <summary>
    ''' キャンセル命令を発行する
    ''' </summary>
    Public Sub CancelProcess()
        ' CTSが有効な場合のみキャンセルを発行
        If _cts IsNot Nothing Then
            _cts.Cancel()
        End If
    End Sub

    ''' <summary>
    ''' 擬似的な重い業務ロジック(DB更新やファイル処理を想定)
    ''' </summary>
    Private Async Function DoHeavyWorkAsync(token As CancellationToken) As Task
        ' ループ処理の中で、こまめにキャンセルを確認するのがプロの技
        For i As Integer = 1 To 10
            ' 【極めて重要】ここでキャンセルが要求されていないか確認する
            ' もし要求されていれば、ここで OperationCanceledException が投げられる
            token.ThrowIfCancellationRequested()

            ' 擬似的な重い処理(DBクエリやファイルI/Oの代わり)
            ' 外部ライブラリのメソッド(例: ExecuteNonQueryAsync)にもTokenを渡すのが理想
            Await Task.Delay(1000, token) 

            ' 進捗状況の更新(UIスレッドへのアクセスは注意が必要だが、
            ' ここでは簡略化のためプロパティ更新の概念のみ示す)
            Debug.WriteLine($"ステップ {i} 完了")
        Next
    End Function

    #Region "INotifyPropertyChanged"
    Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged
    Protected Sub OnPropertyChanged(propertyName As String)
        RaiseEvent PropertyChanged(propertyName, New PropertyChangedEventArgs(propertyName))
    End Sub
    #End Region
End Class

4. 現場で差がつく、3つの鉄則

コードを書くだけでは不十分だ。以下の「設計思想」を脳に刻んでおけ。

① `ThrowIfCancellationRequested` をループ内に配置せよ

どれほど長い非同期処理であっても、その中に「チェックポイント」がなければ、キャンセルは無視される。`For` ループや `While` ループの先頭では、必ず `token.ThrowIfCancellationRequested()` を呼び出すこと。これが「協調」の核心だ。

② 外部ライブラリのメソッドには必ず `Token` を渡せ

もし君が `Entity Framework` や `HttpClient` を使っているなら、それらのメソッドには必ず `CancellationToken` を受け取るオーバーロードが存在する。

  • `ExecuteNonQueryAsync(command, token)`
  • `GetAsync(url, token)`

これらを無視して、自前でループを回してキャンセルを待つのは、エンジンを積まずに車を動かそうとするのと同じくらい愚かな行為だ。

③ `Finally` ブロックでのリソース解放を徹底せよ

キャンセルが発生したとき、コードの実行フローは即座に `Catch (OperationCanceledException)` または `Finally` へ飛ぶ。
データベース接続、ファイルストリーム、あるいは今回使用した `CancellationTokenSource` 自体。これらは必ず `Finally` もしくは `Using` ステートメントによって、確実に解放(Dispose)されるように設計しなければならない。

結論

モダンなUIアプリケーションにおいて、非同期処理は「あって当たり前」だ。しかし、「止まる権利」をユーザーに与える設計ができなければ、それは未完成なツールに過ぎない。

`CancellationTokenSource` を正しく使いこなすことは、アプリケーションの堅牢性を担保し、データの整合性を守り、ユーザーの信頼を勝ち取るための、エンジニアとしての最低限の作法である。

次に君が重い処理を書くとき、自分に問いかけてほしい。
「このタスクは、美しく、安全に、立ち去ることができるか?」と。

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