WPFでバックグランドタスクの未処理の例外を捕捉する

この記事は2019年11月05日に投稿しました。

f:id:paveway:20190914064630j:plain

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回は業務で使用しているWPFでバックグランドタスクの未処理の例外を捕捉する方法についてです。

2. WPFでバックグランドタスクの未処理の例外を捕捉する

WPFでバックグランドタスクの未処理の例外があるとUnobservedTaskExceptionイベントが発生します。
そのためUnobservedTaskExceptionイベントハンドラで、バックグランドタスクで未処理の例外が発生していることを検知できます。
このイベントハンドラで例外を処理済みにすることができます。

.NET4.5以降の場合、デフォルトの設定ではバックグランドタスクで発生した未処理の例外は処理しない場合、失われます。
そのためバックグランドタスクで発生した未処理の例外を処理するように、App.ConfigでThrowUnobservedTaskExceptions enabledを"true"に設定しておきます。

実装例

App.config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    (...中略...)
    <!-- バックグラウンドタスクで未処理の例外を処理するように設定します。 -->
    <runtime>
        <ThrowUnobservedTaskExceptions enabled="true"/>
    </runtime>
</configuration>

App.xaml.cs

using System.Threading.Tasks;
using System.Windows;

namespace WPFUnobservedTaskException
{
    /// <summary>
    /// App.xaml の相互作用ロジック
    /// </summary>
    public partial class App : Application
    {
        /**
         * @brief コンストラクタ
         */
        public App()
        {
            // バックグランドタスクで発生した未処理の例外がある場合のイベントハンドラを設定します。
            TaskScheduler.UnobservedTaskException += TaskScheduler_UnobservedTaskException;
        }

        /**
         * @brief バックグラウンドタスクで未処理の例外がある場合に呼び出されます。
         */
        private void TaskScheduler_UnobservedTaskException(object sender, UnobservedTaskExceptionEventArgs e)
        {
            // エラーメッセージを表示し、アプリケーションの継続を確認します。
            var name = e.Exception.TargetSite.Name;
            var message = e.Exception.Message;
            var errMessage = $"例外が{name}で発生しました。\nエラーメッセージ：{message}\nアプリケーションを継続しますか？";
            var result = MessageBox.Show(errMessage, "エラー", MessageBoxButton.YesNo, MessageBoxImage.Error);
            if (result != MessageBoxResult.Yes) return;

            // 例外を処理済みに設定します。
            e.SetObserved();
        }
    }
}

API Reference

UnobservedTaskExceptionイベント

目次へ

3. おわりに

過去の

www.paveway.info

に引き続き、WPFの例外処理についてです。
前回のUIスレッドで発生した未処理の例外のイベントハンドラ同様、バックグランドタスクで発生した未処理の例外もイベントハンドラで処理済みにできるようです。

リンク

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ

プログラムを書こう！

実務や自作アプリ開発で習得した役に立つソフトウェア技術情報を発信するブログ