【例外】WPFアプリでエラーを報告してもらうための実装

こんにちは、働くC#プログラマーのさんさめです。

GUIのアプリケーションを使ってもらうなら、
必ず実装すべきなのが例外終了時の処理です。

なぜなら、ユーザーの手元で起きてしまった例外を
アプリ制作者が知ることは往々にして難しいからです。

アプリが例外になってしまい、それを特にケアしていない場合、
ユーザーの手元では次のようなダイアログが現れます。
（PCの設定などによってはダイアログが出ずにいきなり終了することもあります）

この時ユーザーにできることは非常に限られます。

見なかったことにする。もう一度アプリを起動する
制作者に報告しつつもう一度アプリを起動する。

このうち、2を行なってくれる人はほぼ皆無です。
なぜなら、たいていのユーザーの頭の中では

制作者の連絡先なんて知らないよ…
頑張って報告なんてしても本当に直してもらえるのか分からない
そもそも嫌な顔をされてしまうかも

…といった考えが先に浮かぶからです。

たとえば上記画像のようにExcelが異常終了やフリーズしてしまったとして、
Microsoftのサポートに報告をするでしょうか。

なかなかそこまでする人は少ないでしょう。
せいぜいその場でちょっと文句を言ってみて、
再度Excelを起動するだけです。

「ユーザーは異常終了を逐一報告してはくれない」ということを、
私のような業務アプリケーションを作る立場や、
個人でアプリを作る立場でも当然考慮する必要があります。

そのため、
「いかにユーザーの手元で起きてしまったバグを知ることができるか？」
というフローを作る必要があります。

幸いC#では、try~catch構文でキャッチしていない（＝未処理の）例外が
発生してしまったときにイベントが発火されます。

本記事では未処理例外発生時のイベントを購読して、
ユーザーに例外をお知らせするウィンドウを実装する例を紹介します。

忙しい人のための全イベント実装例
未処理の例外が発生したときに起きるイベント
例外終了時にユーザーに何を見せるべきか？
例外情報を取得して不具合修正に活かす
まとめ

忙しい人のための全イベント実装例

詳しく中身を知らなくてもいいから、とにかく全部例外は捕捉したい！
という人は以下のコードをどうぞ。

できるだけエントリポイント直後で行うのが理想です。
WPFでいうとApp.xaml.csですね。

public partial class App : Application
{
    protected override void OnStartup(StartupEventArgs e)
    {
        base.OnStartup(e);

        // UIスレッドの未処理例外で発生
        DispatcherUnhandledException += OnDispatcherUnhandledException;
        // UIスレッド以外の未処理例外で発生
        TaskScheduler.UnobservedTaskException += OnUnobservedTaskException;
        // それでも処理されない例外で発生
        AppDomain.CurrentDomain.UnhandledException += OnUnhandledException;
    }

    private void OnDispatcherUnhandledException(object sender, System.Windows.Threading.DispatcherUnhandledExceptionEventArgs e)
    {
        var exception = e.Exception;
        HandleException(exception);
    }

    private void OnUnobservedTaskException(object sender, UnobservedTaskExceptionEventArgs e)
    {
        var exception = e.Exception.InnerException as Exception;
        HandleException(exception);
    }

    private void OnUnhandledException(object sender, UnhandledExceptionEventArgs e)
    {
        var exception = e.ExceptionObject as Exception;
        HandleException(exception);
    }

    private void HandleException(Exception e)
    {
        // ログを送ったり、ユーザーにお知らせしたりする
        MessageBox.Show($"エラーが発生しました\n{e?.ToString()}");
        Environment.Exit(1);
    }
}