BackgroundWorker

[C#] BackgroundWorkerの終了したかどうかを監視する方法

C#のBackgroundWorkerでタスクの終了を監視するには、RunWorkerCompletedイベントを利用します。

このイベントは、BackgroundWorkerが非同期操作を完了したときに発生します。

RunWorkerCompletedEventArgsを使用して、操作が正常に完了したか、キャンセルされたか、または例外が発生したかを確認できます。

イベントハンドラーを設定することで、タスクの終了後に特定の処理を実行することが可能です。

BackgroundWorkerのIsBusyプロパティをチェックすることで、タスクがまだ実行中かどうかも確認できます。

目次から探す

BackgroundWorkerの終了を監視する方法
BackgroundWorkerのエラーハンドリング
BackgroundWorkerのキャンセル機能
応用例
まとめ

BackgroundWorkerの終了を監視する方法

RunWorkerCompletedイベントの設定

BackgroundWorkerを使用する際、非同期処理が完了したときに実行されるイベントがRunWorkerCompletedです。

このイベントを設定することで、処理が終了した後の動作を定義できます。

以下は、RunWorkerCompletedイベントを設定するサンプルコードです。

using System;
using System.ComponentModel;
using System.Windows.Forms;
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)
    {
        // 非同期処理をここに記述
        System.Threading.Thread.Sleep(2000); // 2秒待機
    }
    private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
        // 処理が完了した後の動作をここに記述
        MessageBox.Show("処理が完了しました！");
    }
}

このコードでは、BackgroundWorkerのRunWorkerCompletedイベントに対して、処理が完了した際にメッセージボックスを表示するように設定しています。

非同期処理が完了すると、RunWorkerCompletedイベントが発生し、指定した処理が実行されます。

RunWorkerCompletedEventArgsの活用

RunWorkerCompletedEventArgsは、RunWorkerCompletedイベントの引数として渡されるオブジェクトです。

このオブジェクトを使用することで、非同期処理の結果やエラー情報を取得できます。

以下は、RunWorkerCompletedEventArgsを活用したサンプルコードです。

private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Error != null)
    {
        // エラーが発生した場合の処理
        MessageBox.Show("エラーが発生しました: " + e.Error.Message);
    }
    else
    {
        // 正常に完了した場合の処理
        MessageBox.Show("処理が完了しました！結果: " + e.Result.ToString());
    }
}

このコードでは、RunWorkerCompletedEventArgsのErrorプロパティを使用して、エラーが発生したかどうかを確認しています。

エラーがあった場合は、そのメッセージを表示し、正常に完了した場合は結果を表示します。

IsBusyプロパティの確認

BackgroundWorkerにはIsBusyプロパティがあり、現在非同期処理が実行中かどうかを確認できます。

このプロパティを使用することで、ユーザーインターフェースの状態を適切に管理できます。

以下は、IsBusyプロパティを確認するサンプルコードです。

private void buttonStart_Click(object sender, EventArgs e)
{
    if (!backgroundWorker.IsBusy)
    {
        // 非同期処理を開始
        backgroundWorker.RunWorkerAsync();
    }
    else
    {
        MessageBox.Show("処理が既に実行中です。");
    }
}

このコードでは、ボタンがクリックされたときにIsBusyプロパティを確認し、非同期処理が実行中でない場合にのみ新たに処理を開始します。

処理が実行中の場合は、警告メッセージを表示します。

BackgroundWorkerのエラーハンドリング

例外処理の実装

BackgroundWorkerを使用する際、非同期処理中に発生する可能性のある例外を適切に処理することが重要です。

例外が発生した場合、RunWorkerCompletedイベントでその情報を取得し、適切な対応を行うことができます。

以下は、例外処理を実装したサンプルコードです。

private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    try
    {
        // 非同期処理をここに記述
        // 例: ゼロ除算を意図的に発生させる
        int result = 10 / int.Parse("0"); // ここで例外が発生
    }
    catch (Exception ex)
    {
        // 例外をRunWorkerCompletedイベントに渡す
        e.Result = ex; // エラー情報を結果として設定
    }
}

このコードでは、DoWorkメソッド内で例外が発生した場合、その例外をRunWorkerCompletedイベントに渡すために、e.Resultに設定しています。

これにより、後でエラー情報を取得できます。

エラー発生時のRunWorkerCompletedイベントの動作

RunWorkerCompletedイベントでは、非同期処理中に発生した例外を確認し、適切な処理を行うことができます。

以下は、エラー発生時の動作を実装したサンプルコードです。

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

このコードでは、RunWorkerCompletedイベント内でe.Errorとe.Resultを確認し、エラーや例外が発生した場合に適切なメッセージを表示します。

これにより、ユーザーにエラーの内容を伝えることができます。

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

エラーハンドリングの一環として、ユーザーに対してエラーメッセージを表示することは重要です。

エラーメッセージは、問題の内容を明確に伝えるために、具体的でわかりやすいものであるべきです。

以下は、ユーザーへのエラーメッセージを表示するサンプルコードです。

private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Error != null || e.Result is Exception)
    {
        string errorMessage = e.Error != null ? e.Error.Message : ((Exception)e.Result).Message;
        MessageBox.Show("エラーが発生しました: " + errorMessage, "エラー", MessageBoxButtons.OK, MessageBoxIcon.Error);
    }
    else
    {
        MessageBox.Show("処理が完了しました！", "完了", MessageBoxButtons.OK, MessageBoxIcon.Information);
    }
}

このコードでは、エラーが発生した場合に、エラーメッセージを含むメッセージボックスを表示します。

メッセージボックスには、エラーの内容を明確に伝えるためのタイトルやアイコンも設定しています。

これにより、ユーザーは問題の内容を理解しやすくなります。

BackgroundWorkerのキャンセル機能

キャンセルの必要性

非同期処理を行う際、ユーザーが処理を中止したい場合があります。

特に、長時間かかる処理や、ユーザーの操作によって結果が変わる場合には、キャンセル機能が重要です。

キャンセル機能を実装することで、ユーザーは不要な処理を中断し、アプリケーションの応答性を向上させることができます。

例えば、データのダウンロードや計算処理など、時間がかかる処理においてキャンセル機能は特に有用です。

CancelAsyncメソッドの使用

BackgroundWorkerには、非同期処理をキャンセルするためのCancelAsyncメソッドがあります。

このメソッドを呼び出すことで、BackgroundWorkerの処理を中断することができます。

以下は、CancelAsyncメソッドを使用したサンプルコードです。

private void buttonCancel_Click(object sender, EventArgs e)
{
    if (backgroundWorker.IsBusy)
    {
        // 非同期処理をキャンセル
        backgroundWorker.CancelAsync();
    }
}

このコードでは、キャンセルボタンがクリックされたときに、BackgroundWorkerが実行中であればCancelAsyncメソッドを呼び出して処理をキャンセルします。

これにより、ユーザーは非同期処理を中断することができます。

CancellationPendingプロパティの確認

BackgroundWorkerには、CancellationPendingプロパティがあり、処理がキャンセルされるかどうかを確認できます。

このプロパティを使用して、非同期処理内でキャンセルの要求を確認し、適切に処理を中断することができます。

以下は、CancellationPendingプロパティを確認するサンプルコードです。

private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    for (int i = 0; i < 100; i++)
    {
        // キャンセルが要求されているか確認
        if (backgroundWorker.CancellationPending)
        {
            e.Cancel = true; // 処理をキャンセルする
            return;
        }
        // 非同期処理をここに記述
        System.Threading.Thread.Sleep(50); // 50ミリ秒待機
    }
}

このコードでは、ループ内でCancellationPendingプロパティを確認し、キャンセルが要求されている場合はe.Cancelをtrueに設定して処理を中断します。

これにより、非同期処理が適切にキャンセルされ、ユーザーに対して処理が中止されたことを通知できます。

応用例

複数のBackgroundWorkerの管理

複数のBackgroundWorkerを同時に管理することで、異なる非同期処理を並行して実行することができます。

これにより、アプリケーションの応答性を向上させることが可能です。

以下は、複数のBackgroundWorkerを管理するサンプルコードです。

private BackgroundWorker worker1;
private BackgroundWorker worker2;
public MyForm()
{
    InitializeComponent();
    worker1 = new BackgroundWorker();
    worker2 = new BackgroundWorker();
    worker1.DoWork += Worker1_DoWork;
    worker2.DoWork += Worker2_DoWork;
    worker1.RunWorkerCompleted += Worker_RunWorkerCompleted;
    worker2.RunWorkerCompleted += Worker_RunWorkerCompleted;
}
private void Worker1_DoWork(object sender, DoWorkEventArgs e)
{
    // 非同期処理1
    System.Threading.Thread.Sleep(2000); // 2秒待機
}
private void Worker2_DoWork(object sender, DoWorkEventArgs e)
{
    // 非同期処理2
    System.Threading.Thread.Sleep(3000); // 3秒待機
}
private void Worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    MessageBox.Show("処理が完了しました！");
}

このコードでは、2つのBackgroundWorkerを作成し、それぞれ異なる非同期処理を実行しています。

RunWorkerCompletedイベントで、どちらの処理が完了してもメッセージボックスが表示されます。

プログレスバーとの連携

BackgroundWorkerを使用することで、プログレスバーを更新しながら非同期処理を実行することができます。

プログレスバーは、処理の進捗状況をユーザーに視覚的に示すために役立ちます。

以下は、プログレスバーとの連携を実装したサンプルコードです。

private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    for (int i = 0; i <= 100; i++)
    {
        // キャンセルが要求されているか確認
        if (backgroundWorker.CancellationPending)
        {
            e.Cancel = true;
            return;
        }
        // プログレスバーの進捗を報告
        backgroundWorker.ReportProgress(i);
        System.Threading.Thread.Sleep(50); // 50ミリ秒待機
    }
}
private void BackgroundWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
    progressBar.Value = e.ProgressPercentage; // プログレスバーを更新
}

このコードでは、DoWorkメソッド内でReportProgressメソッドを使用してプログレスバーの進捗を報告しています。

ProgressChangedイベントでプログレスバーの値を更新することで、ユーザーに進捗状況を示します。

データベース操作の非同期化

データベース操作は、通常時間がかかるため、非同期で実行することが望ましいです。

BackgroundWorkerを使用してデータベース操作を非同期化することで、アプリケーションの応答性を保ちながらデータの取得や更新を行うことができます。

以下は、データベース操作を非同期化したサンプルコードです。

private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    // データベース接続の設定
    using (var connection = new SqlConnection("接続文字列"))
    {
        connection.Open();
        var command = new SqlCommand("SELECT * FROM TableName", connection);
        var reader = command.ExecuteReader();
        while (reader.Read())
        {
            // データの処理
            // 例: Console.WriteLine(reader["ColumnName"].ToString());
        }
    }
}

このコードでは、BackgroundWorkerを使用してデータベースからデータを非同期で取得しています。

データベース操作が完了するまで、ユーザーインターフェースは応答し続けるため、ユーザーは他の操作を行うことができます。