【実務・中級編】【中級者・実務】VB.NETとWPFでの例外ダイアログ一元管理:DispatcherUnhandledExceptionによる予期せぬクラッシュの防止 – Visual Basic (VB / VB.NET)解析バイブル

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

業務アプリを「沈黙のクラッシュ」から救え:WPFにおける極限のグローバル例外ハンドリング設計論

開発現場で、ユーザーからこんな報告を受けたことはないか?
「ボタンを押したら、何も言わずにアプリが消えました」

この「何も言わずに消える」という現象こそ、エンジニアとして最も恥ずべき、そして最も回避すべき事態だ。原因不明の強制終了は、ユーザーの信頼を失墜させるだけでなく、業務データの破損という致命的なリスクを孕んでいる。

多くの開発者は、あらゆるメソッドを `Try…Catch` で囲もうとする。だが、それは設計思想として間違っている。局所的な `Try…Catch` は「回復可能なエラー(例:入力不備)」に対処するためのものであり、「予期せぬシステムエラー」を捕捉するためのものではない。

本稿では、WPFアプリケーションにおいて、アプリケーションの死を食い止め、かつ事後検証を可能にするための「グローバル例外ハンドリングの一元管理」について、その設計思想と実装の極意を伝授する。

1. なぜ「局所的なTry-Catch」だけでは不十分なのか

まず、設計の前提を整理しよう。例外には大きく分けて二つの性質がある。

1. 制御フローとしての例外: 業務ロジック上、発生が予見できるもの(ファイルがない、数値変換に失敗した等)。これには `Try…Catch` を使い、適切なエラーメッセージを表示して処理を継続させる。
2. 致命的な例外: プログラムの整合性が失われた状態。NullReferenceExceptionや、予期せぬ通信断絶など。これらは、無理に `Catch` して処理を続行させると、汚染されたメモリ状態のまま動作し続け、さらに深刻なデータ破損を引き起こす可能性がある。

我々が構築すべきなのは、「制御可能なものは局所で、制御不能なものは最下層(Global)で」という二段構えの防御陣形だ。

2. WPFにおける「二つの防衛線」

WPFアプリケーションにおいて、例外を捕捉するための防衛線は二つ存在する。ここを混同している者が多すぎる。

第一の防衛線:`DispatcherUnhandledException`

これは UIスレッド(メインスレッド) で発生した例外を捕捉するためのものだ。WPFのメッセージループ内で発生したエラーをキャッチし、`e.Handled = True` とすることで、アプリケーションが即座に終了するのを防ぐことができる。

第二の防衛線:`AppDomain.CurrentDomain.UnhandledException`

これはUIスレッド以外の、バックグラウンドスレッドやTask内で発生した例外を捕捉するためのものだ。残念ながら、ここで例外をキャッチしても、アプリケーションのプロセス自体を生存させることは(原則として)できない。しかし、「なぜ死んだのか」という証拠(ログ)を残すことは可能だ。

3. 実装:プロダクション・グレードの例外管理エンジン

それでは、これらを統合した堅牢な実装例を示す。単なるコピペではなく、なぜこう書くのかという「意図」を読み取ってほしい。

App.xaml.vb の実装

`App.xaml.vb` は、アプリケーションの生命周期を司る司令塔だ。ここにすべての例外ハンドリングを集約させる。

''' <summary>
''' アプリケーションのライフサイクルを管理するメインクラス
''' </summary>
Class Application

    ''' <summary>
    ''' アプリケーション開始時の初期化
    ''' </summary>
    Protected Overrides Sub OnStartup(e As StartupEventArgs)
        ' 1. UIスレッドの例外ハンドラを登録
        AddHandler Me.DispatcherUnhandledException, AddressOf OnDispatcherUnhandledException

        ' 2. 全スレッド(AppDomain)の未処理例外ハンドラを登録
        ' ※これはアプリの強制終了を防ぐことはできないが、ログ記録のために必須
        AddHandler AppDomain.CurrentDomain.UnhandledException, AddressOf OnUnhandledException

        MyBase.OnStartup(e)
    End Sub

    ''' <summary>
    ''' UIスレッドで発生した未処理例外のハンドラ
    ''' </summary>
    ''' <param name="sender">ソース</param>
    ''' <param name="e">例外イベント引数</param>
    Private Sub OnDispatcherUnhandledException(sender As Object, e As System.Windows.Threading.DispatcherUnhandledExceptionEventArgs)
        ' 例外情報のログ出力
        ' ここでDB連携を直接行うのは危険。DB接続自体がエラーの原因である可能性があるため。
        ' まずはローカルのファイルへ書き出すのが鉄則。
        GlobalLogger.WriteError("Critical UI Exception", e.Exception)

        ' ユーザーへの通知
        MessageBox.Show("予期せぬエラーが発生しました。アプリケーションを安全に再起動してください。" & vbCrLf &
                        "エラー内容: " & e.Exception.Message, "システムエラー",
                        MessageBoxButton.OK, MessageBoxImage.Error)

        ' 重要:e.Handled を True にすることで、アプリの即時クラッシュを回避する
        ' ただし、アプリの状態が不安定であることを念頭に置くこと
        e.Handled = True
    End Sub

    ''' <summary>
    ''' 非UIスレッドを含む、アプリケーション全体の未処理例外ハンドラ
    ''' </summary>
    ''' <param name="sender">ソース</param>
    ''' <param name="e">例外イベント引数</param>
    Private Sub OnUnhandledException(sender As Object, e As UnhandledExceptionEventArgs)
        ' e.Exception は Object 型なので、適切にキャストする
        Dim ex As Exception = TryCast(e.Exception, Exception)
        
        ' ログ出力(この時点ではアプリは死ぬ運命にある)
        GlobalLogger.WriteError("Fatal AppDomain Exception (App will terminate)", ex)

        ' ユーザーへの通知(MessageBoxはスレッドセーフに注意が必要だが、
        ' 終了直前であれば表示できることが多い)
        MessageBox.Show("致命的なエラーが発生したため、アプリケーションを終了します。" & vbCrLf &
                        "エラー詳細: " & If(ex?.Message, "Unknown Error"), 
                        "致命的エラー", MessageBoxButton.OK, MessageBoxImage.Stop)
    End Sub

End Class

ログ出力エンジンの設計(GlobalLogger)

例外ハンドラ内で、さらに例外が発生して「二重死」を招くのは最悪のシナリオだ。ログ出力は極めてシンプル、かつ堅牢であるべきだ。

Imports System.IO
Imports System.Text

''' <summary>
''' 堅牢なログ出力クラス
''' </summary>
Public NotInheritable Class GlobalLogger
    Private Shared ReadOnly LogFilePath As String = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "error_log.txt")

    ''' <summary>
    ''' 例外をファイルに安全に書き出す
    ''' </summary>
    Public Shared Sub WriteError(context As String, ex As Exception)
        Try
            Dim sb As New StringBuilder()
            sb.AppendLine($"--- Error Report: {DateTime.Now:yyyy-MM-dd HH:mm:ss} ---")
            sb.AppendLine($"Context: {context}")
            sb.AppendLine($"Message: {ex?.Message}")
            sb.AppendLine($"StackTrace: {ex?.StackTrace}")
            sb.AppendLine(New String("-"c, 40))

            ' 排他制御を考慮し、AppendAllTextを使用
            ' ※大量のログが発生する場合、ファイルロックに注意が必要だが、
            '   クラッシュ時のログ出力においてはこれが最も確実な方法である。
            File.AppendAllText(LogFilePath, sb.ToString())
        Catch
            ' ログ出力自体が失敗した場合は、何もできない。
            ' ここでさらに例外を投げると、アプリケーションは制御不能な再帰的クラッシュに陥る。
        End Try
    End Sub
End Class

4. アーキテクトからの警告:実務における落とし穴

コードを書くだけでは不十分だ。以下の3点を設計思想として叩き込んでおけ。

① DB連携の罠

例外が発生したとき、ネットワークやデータベースの接続が切断されている可能性は極めて高い。その状態で「エラーログをDBに保存しよう」とするのは愚策だ。「エラーハンドラは、外部依存関係(DB、ネットワーク、API)を持たない」。これが鉄則だ。ログは常に、ローカルのファイルシステム、あるいは標準出力へ向けるべきである。

② 「e.Handled = True」の責任

`DispatcherUnhandledException` で `e.Handled = True` を設定すると、アプリは死なない。しかし、それは「正常に戻った」ことを意味しない。例えば、計算途中の変数が `Nothing` になっていたり、メモリ上のデータが矛盾している可能性がある。
業務アプリとして設計するなら、「エラー発生後は、ユーザーに一度アプリを再起動させるよう促す」のが、最も誠実で安全な設計である。

③ 非同期処理(Async/Await)の盲点

`Task.Run` 内で発生した例外は、`DispatcherUnhandledException` では捕捉できない。これが、多くの開発者が陥る罠だ。`AppDomain.CurrentDomain.UnhandledException` が最後の砦となるが、そこは「事後報告」の場である。
可能な限り、非同期処理の内部でも適切な `Try…Catch` を行い、エラーをメインスレッド(UIスレッド)へ伝播させる設計を心がけよ。

まとめ

堅牢なアプリケーションとは、「エラーが起きないアプリ」のことではない。「エラーが起きたときに、何が起きたかを正確に記録し、ユーザーを迷わせず、データの整合性を守れるアプリ」のことだ。

今回紹介した `DispatcherUnhandledException` と `AppDomain.CurrentDomain.UnhandledException` の二段構え、そして「外部依存のないログ出力」を実装に組み込み、プロフェッショナルとしての責務を果たせ。

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