BackgroundWorker

[C#] BackgroundWorkerでの例外処理の方法

C#のBackgroundWorkerを使用する際、例外処理はDoWorkイベント内で行います。

DoWorkメソッド内で例外が発生した場合、通常のtry-catchブロックを使用して例外をキャッチし、BackgroundWorkerのRunWorkerCompletedイベントで例外を確認できます。

RunWorkerCompletedEventArgsのErrorプロパティをチェックすることで、例外が発生したかどうかを判断できます。

例外が発生している場合は、Errorプロパティに例外オブジェクトが格納されているため、それを利用してエラーメッセージを表示したり、ログを記録したりすることが可能です。

目次から探す

BackgroundWorkerでの例外処理
例外処理の実装手順
応用例
まとめ

BackgroundWorkerでの例外処理

C#のBackgroundWorkerは、非同期処理を簡単に実装できる便利なクラスですが、例外処理を適切に行うことが重要です。

ここでは、BackgroundWorkerを使用した際の例外処理の方法について解説します。

DoWorkイベントでの例外処理

DoWorkイベントは、バックグラウンドスレッドで実行される処理を定義する場所です。

このイベント内で発生した例外は、RunWorkerCompletedイベントで捕捉されます。

以下は、DoWorkイベントでの例外処理のサンプルコードです。

public partial class MyForm : Form
{
    private BackgroundWorker backgroundWorker;
    public MyForm()
    {
        InitializeComponent();
        backgroundWorker = new BackgroundWorker();
        backgroundWorker.DoWork += BackgroundWorker_DoWork;
        backgroundWorker.RunWorkerCompleted += BackgroundWorker_RunWorkerCompleted;
    }
    private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
    {
        try
        {
            // ここで重い処理を実行
            // 例：データベースからのデータ取得
            throw new Exception("サンプル例外"); // 例外を発生させる
        }
        catch (Exception ex)
        {
            // 例外をRunWorkerCompletedに渡す
            e.Result = ex;
        }
    }
}

このコードでは、DoWorkイベント内で例外が発生した場合、e.Resultに例外情報を格納しています。

これにより、後でRunWorkerCompletedイベントで例外を確認できます。

RunWorkerCompletedイベントでの例外確認

RunWorkerCompletedイベントは、バックグラウンド処理が完了した後に呼び出されます。

このイベント内で、DoWorkイベントで発生した例外を確認することができます。

以下はそのサンプルコードです。

private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Error != null)
    {
        // 例外が発生した場合の処理
        MessageBox.Show($"エラーが発生しました: {e.Error.Message}");
    }
    else if (e.Result is Exception ex)
    {
        // e.Resultに格納された例外を処理
        MessageBox.Show($"例外が発生しました: {ex.Message}");
    }
    else
    {
        // 正常終了の処理
        MessageBox.Show("処理が正常に完了しました。");
    }
}

このコードでは、e.Errorがnullでない場合、DoWork内で発生した例外を表示します。

また、e.Resultに格納された例外も確認し、適切なメッセージを表示します。

Errorプロパティの活用方法

RunWorkerCompletedEventArgsクラスのErrorプロパティは、DoWorkイベント内で発生した例外を取得するために使用します。

このプロパティを利用することで、例外処理をより簡潔に行うことができます。

以下はその例です。

private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Error != null)
    {
        // Errorプロパティを使用して例外を表示
        MessageBox.Show($"エラーが発生しました: {e.Error.Message}");
    }
    else
    {
        // 正常終了の処理
        MessageBox.Show("処理が正常に完了しました。");
    }
}

このように、Errorプロパティを使用することで、例外処理を簡潔に行うことができます。

BackgroundWorkerを使用する際は、これらの例外処理の方法を理解し、適切に実装することが重要です。

例外処理の実装手順

BackgroundWorkerを使用する際の例外処理は、適切に行うことでアプリケーションの安定性を向上させることができます。

ここでは、例外処理の実装手順について詳しく解説します。

try-catchブロックの使用

例外処理の基本は、try-catchブロックを使用することです。

tryブロック内に例外が発生する可能性のあるコードを記述し、catchブロックでその例外を捕捉します。

以下は、DoWorkイベント内でのtry-catchブロックの使用例です。

private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    try
    {
        // ここで重い処理を実行
        // 例：ファイルの読み込み
        throw new FileNotFoundException("指定されたファイルが見つかりません。"); // 例外を発生させる
    }
    catch (Exception ex)
    {
        // 例外をRunWorkerCompletedに渡す
        e.Result = ex;
    }
}

このコードでは、ファイルの読み込み処理中に例外が発生した場合、その例外をcatchブロックで捕捉し、e.Resultに格納しています。

これにより、後でRunWorkerCompletedイベントで例外を確認できます。

例外情報の取得とログ出力

例外が発生した場合、その詳細情報を取得し、ログに出力することが重要です。

これにより、後で問題の原因を特定しやすくなります。

以下は、例外情報を取得してログに出力するサンプルコードです。

private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    try
    {
        // ここで重い処理を実行
        throw new Exception("サンプル例外"); // 例外を発生させる
    }
    catch (Exception ex)
    {
        // 例外情報をログに出力
        LogError(ex);
        e.Result = ex;
    }
}
private void LogError(Exception ex)
{
    // ログファイルに例外情報を出力
    using (StreamWriter writer = new StreamWriter("error.log", true))
    {
        writer.WriteLine($"{DateTime.Now}: {ex.Message}");
        writer.WriteLine(ex.StackTrace);
    }
}

このコードでは、LogErrorメソッドを使用して、例外のメッセージとスタックトレースをログファイルに出力しています。

これにより、後で問題を分析する際に役立ちます。

ユーザーへのエラーメッセージ表示

例外が発生した場合、ユーザーに対して適切なエラーメッセージを表示することも重要です。

これにより、ユーザーは何が問題であったかを理解しやすくなります。

以下は、RunWorkerCompletedイベントでのエラーメッセージ表示の例です。

private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Error != null)
    {
        // エラーメッセージを表示
        MessageBox.Show($"エラーが発生しました: {e.Error.Message}");
    }
    else if (e.Result is Exception ex)
    {
        // e.Resultに格納された例外を表示
        MessageBox.Show($"例外が発生しました: {ex.Message}");
    }
    else
    {
        // 正常終了の処理
        MessageBox.Show("処理が正常に完了しました。");
    }
}

このコードでは、e.Errorやe.Resultを使用して、発生した例外のメッセージをユーザーに表示しています。

ユーザーに対して適切な情報を提供することで、アプリケーションの使いやすさが向上します。

応用例

BackgroundWorkerを使用する際には、さまざまなシナリオに応じた例外処理が求められます。

ここでは、複数のBackgroundWorkerを使用する場合や、非同期処理中のキャンセル、例外発生時のリトライ処理について解説します。

複数のBackgroundWorkerを使用する場合の例外処理

複数のBackgroundWorkerを使用する場合、それぞれのBackgroundWorkerで発生した例外を個別に処理する必要があります。

以下は、2つのBackgroundWorkerを使用した例外処理のサンプルコードです。

public partial class MyForm : Form
{
    private BackgroundWorker worker1;
    private BackgroundWorker worker2;
    public MyForm()
    {
        InitializeComponent();
        worker1 = new BackgroundWorker();
        worker2 = new BackgroundWorker();
        worker1.DoWork += Worker1_DoWork;
        worker1.RunWorkerCompleted += Worker1_RunWorkerCompleted;
        worker2.DoWork += Worker2_DoWork;
        worker2.RunWorkerCompleted += Worker2_RunWorkerCompleted;
    }
    private void Worker1_DoWork(object sender, DoWorkEventArgs e)
    {
        // 例外を発生させる処理
        throw new Exception("Worker1でエラーが発生しました。");
    }
    private void Worker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
        if (e.Error != null)
        {
            MessageBox.Show($"Worker1: {e.Error.Message}");
        }
    }
    private void Worker2_DoWork(object sender, DoWorkEventArgs e)
    {
        // 例外を発生させる処理
        throw new Exception("Worker2でエラーが発生しました。");
    }
    private void Worker2_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
        if (e.Error != null)
        {
            MessageBox.Show($"Worker2: {e.Error.Message}");
        }
    }
}

このコードでは、2つのBackgroundWorkerそれぞれで例外が発生した場合に、個別にエラーメッセージを表示しています。

これにより、どのBackgroundWorkerでエラーが発生したかを明確に把握できます。

非同期処理中のキャンセルと例外処理

BackgroundWorkerでは、非同期処理をキャンセルする機能も提供されています。

キャンセルが要求された場合に、適切に例外処理を行う方法を以下に示します。

private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    for (int i = 0; i < 10; i++)
    {
        // キャンセルが要求された場合
        if (backgroundWorker.CancellationPending)
        {
            e.Cancel = true; // 処理をキャンセル
            return;
        }
        // 重い処理を実行
        Thread.Sleep(1000); // 例：1秒待機
    }
}
private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Cancelled)
    {
        MessageBox.Show("処理がキャンセルされました。");
    }
    else if (e.Error != null)
    {
        MessageBox.Show($"エラーが発生しました: {e.Error.Message}");
    }
    else
    {
        MessageBox.Show("処理が正常に完了しました。");
    }
}

このコードでは、CancellationPendingプロパティを使用してキャンセルが要求されたかどうかを確認し、処理を中断しています。

キャンセルされた場合は、RunWorkerCompletedイベントでその旨をユーザーに通知します。

例外発生時のリトライ処理

例外が発生した場合に、処理をリトライする機能を実装することも可能です。

以下は、例外発生時にリトライを行うサンプルコードです。

private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    int retryCount = 0;
    const int maxRetries = 3; // 最大リトライ回数
    while (retryCount < maxRetries)
    {
        try
        {
            // ここで重い処理を実行
            throw new Exception("サンプル例外"); // 例外を発生させる
        }
        catch (Exception ex)
        {
            retryCount++;
            if (retryCount >= maxRetries)
            {
                e.Result = ex; // 最大リトライ回数に達した場合、例外を渡す
                return;
            }
        }
    }
}
private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Result is Exception ex)
    {
        MessageBox.Show($"例外が発生しました: {ex.Message}");
    }
    else
    {
        MessageBox.Show("処理が正常に完了しました。");
    }
}

このコードでは、whileループを使用して最大リトライ回数まで処理を試みます。

例外が発生した場合はリトライし、最大リトライ回数に達した場合は例外をRunWorkerCompletedイベントに渡します。

これにより、処理の安定性を向上させることができます。