BackgroundWorker

[C#] BackgroundWorkerでのキャンセル処理の実装方法

2025-01-18更新日: 2025-01-18

C#のBackgroundWorkerでキャンセル処理を実装するには、いくつかのステップが必要です。

まず、BackgroundWorkerのWorkerSupportsCancellationプロパティをtrueに設定します。

次に、キャンセルを要求するためにCancelAsyncメソッドを呼び出します。

バックグラウンドで実行される作業内で、CancellationPendingプロパティを定期的にチェックし、trueの場合は作業を中断してDoWorkイベントハンドラーを終了します。

これにより、キャンセルが適切に処理されます。

キャンセルが完了したことを確認するために、RunWorkerCompletedイベントでe.Cancelledプロパティをチェックすることも重要です。

目次から探す

キャンセル処理の準備
- WorkerSupportsCancellationプロパティの設定
- CancelAsyncメソッドの使用
キャンセル処理の実装
キャンセル処理の確認
- RunWorkerCompletedイベントの活用
- e.Cancelledプロパティの確認
完成したプログラム
- プログラムの解説
応用例
まとめ

キャンセル処理の準備

WorkerSupportsCancellationプロパティの設定

BackgroundWorkerを使用する際、キャンセル処理を行うためには、まずWorkerSupportsCancellationプロパティをtrueに設定する必要があります。

このプロパティを設定することで、BackgroundWorkerがキャンセルをサポートすることを示します。

以下のように、MyFormクラスのコンストラクタ内で設定します。

public partial class MyForm : Form
{
    private BackgroundWorker backgroundWorker;
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        backgroundWorker = new BackgroundWorker();
        backgroundWorker.WorkerSupportsCancellation = true; // キャンセルをサポートする設定
    }
}

この設定を行うことで、CancelAsyncメソッドを使用して、バックグラウンド処理をキャンセルできるようになります。

CancelAsyncメソッドの使用

CancelAsyncメソッドは、バックグラウンド処理をキャンセルするために使用されます。

このメソッドを呼び出すと、BackgroundWorkerはキャンセルを要求し、DoWorkイベント内でキャンセルの状態を確認することができます。

以下のコードは、ボタンをクリックした際にキャンセルを実行する例です。

private void cancelButton_Click(object sender, EventArgs e)
{
    if (backgroundWorker.IsBusy) // バックグラウンド処理が実行中か確認
    {
        backgroundWorker.CancelAsync(); // キャンセルを要求
    }
}

このように、ユーザーがボタンをクリックすることで、バックグラウンド処理をキャンセルすることができます。

CancelAsyncメソッドを使用することで、ユーザーの操作に応じた柔軟なキャンセル処理が可能になります。

キャンセル処理の実装

DoWorkイベントでのキャンセルチェック

BackgroundWorkerのDoWorkイベント内で、キャンセルが要求されたかどうかを確認することが重要です。

キャンセルが要求された場合、処理を中断し、適切な処理を行う必要があります。

以下のコードは、DoWorkイベントでキャンセルをチェックする方法を示しています。

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(100); // 100ミリ秒待機
    }
}

このように、ループ内でCancellationPendingプロパティを確認することで、ユーザーがキャンセルを要求した場合に処理を中断できます。

CancellationPendingプロパティの確認

CancellationPendingプロパティは、キャンセルが要求されたかどうかを示すブール値を返します。

このプロパティを使用して、バックグラウンド処理の進行中にキャンセルの状態を確認することができます。

上記の例でも使用されていますが、他の場所でも確認することが可能です。

if (backgroundWorker.CancellationPending)
{
    // キャンセルが要求された場合の処理
}

このプロパティを適切に使用することで、バックグラウンド処理の中断をスムーズに行うことができます。

キャンセル時のリソース解放

キャンセル処理を行う際には、リソースの解放も重要です。

特に、ファイルやネットワーク接続などのリソースを使用している場合、キャンセル時に適切に解放する必要があります。

以下のコードは、キャンセル時にリソースを解放する方法を示しています。

private void backgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    try
    {
        for (int i = 0; i < 100; i++)
        {
            if (backgroundWorker.CancellationPending)
            {
                e.Cancel = true; // キャンセルフラグを設定
                break; // ループを中断
            }
            // 長時間処理のシミュレーション
            System.Threading.Thread.Sleep(100); // 100ミリ秒待機
        }
    }
    finally
    {
        // リソースの解放処理
        ReleaseResources(); // リソース解放メソッドを呼び出し
    }
}
private void ReleaseResources()
{
    // リソース解放の具体的な処理を記述
}

このように、finallyブロックを使用することで、キャンセルが発生した場合でも必ずリソースを解放することができます。

これにより、メモリリークやリソースの枯渇を防ぐことができます。

キャンセル処理の確認

RunWorkerCompletedイベントの活用

BackgroundWorkerのRunWorkerCompletedイベントは、バックグラウンド処理が完了した後に発生します。

このイベントを利用することで、処理が正常に完了したか、キャンセルされたかを確認することができます。

以下のコードは、RunWorkerCompletedイベントを使用して、処理の結果を確認する方法を示しています。

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("処理が正常に完了しました。"); // 正常に完了した場合のメッセージ
    }
}

このように、RunWorkerCompletedイベントを活用することで、処理の結果に応じた適切なフィードバックをユーザーに提供することができます。

e.Cancelledプロパティの確認

RunWorkerCompletedEventArgsクラスのCancelledプロパティは、バックグラウンド処理がキャンセルされたかどうかを示すブール値を返します。

このプロパティを使用することで、キャンセルされた場合の処理を簡単に実装できます。

上記の例でも使用されていますが、以下のように単独で確認することも可能です。

if (e.Cancelled)
{
    // キャンセルされた場合の処理
}

このプロパティを確認することで、キャンセルされた場合に特定の処理を行うことができ、ユーザーに対して適切なメッセージを表示したり、アプリケーションの状態を更新したりすることができます。

これにより、ユーザーエクスペリエンスを向上させることができます。

完成したプログラム

以下に、BackgroundWorkerを使用してキャンセル処理を実装した完成プログラムの例を示します。

このプログラムは、ユーザーがボタンをクリックすることでバックグラウンド処理を開始し、別のボタンでその処理をキャンセルできるようになっています。

using System;
using System.ComponentModel;
using System.Threading;
using System.Windows.Forms;
public partial class MyForm : Form
{
    private BackgroundWorker backgroundWorker;
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        backgroundWorker = new BackgroundWorker();
        backgroundWorker.WorkerSupportsCancellation = true; // キャンセルをサポートする設定
        backgroundWorker.DoWork += backgroundWorker_DoWork; // DoWorkイベントのハンドラ
        backgroundWorker.RunWorkerCompleted += backgroundWorker_RunWorkerCompleted; // RunWorkerCompletedイベントのハンドラ
    }
    private void startButton_Click(object sender, EventArgs e)
    {
        if (!backgroundWorker.IsBusy) // バックグラウンド処理が実行中でないか確認
        {
            backgroundWorker.RunWorkerAsync(); // バックグラウンド処理を開始
        }
    }
    private void cancelButton_Click(object sender, EventArgs e)
    {
        if (backgroundWorker.IsBusy) // バックグラウンド処理が実行中か確認
        {
            backgroundWorker.CancelAsync(); // キャンセルを要求
        }
    }
    private void backgroundWorker_DoWork(object sender, DoWorkEventArgs e)
    {
        for (int i = 0; i < 100; i++)
        {
            if (backgroundWorker.CancellationPending) // キャンセルが要求されたか確認
            {
                e.Cancel = true; // キャンセルフラグを設定
                return; // 処理を中断
            }
            // 長時間処理のシミュレーション
            Thread.Sleep(100); // 100ミリ秒待機
        }
    }
    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("処理が正常に完了しました。"); // 正常に完了した場合のメッセージ
        }
    }
}

プログラムの解説

フォームの初期化: InitializeComponent()メソッドでフォームを初期化し、BackgroundWorkerのインスタンスを作成します。
キャンセルの設定: WorkerSupportsCancellationプロパティをtrueに設定し、キャンセルをサポートします。
イベントハンドラの登録: DoWorkとRunWorkerCompletedイベントのハンドラを登録します。
バックグラウンド処理の開始: startButtonがクリックされると、バックグラウンド処理が開始されます。
キャンセル処理: cancelButtonがクリックされると、バックグラウンド処理がキャンセルされます。
処理結果の確認: RunWorkerCompletedイベントで、処理がキャンセルされたか、正常に完了したかを確認し、メッセージを表示します。

このプログラムを実行することで、ユーザーはバックグラウンド処理を開始し、必要に応じてキャンセルすることができます。

キャンセル処理が適切に実装されているため、ユーザーエクスペリエンスが向上します。

応用例

長時間処理のキャンセル

BackgroundWorkerを使用することで、長時間かかる処理をバックグラウンドで実行し、ユーザーがその処理をキャンセルできるようにすることができます。

例えば、大量のデータを処理する場合や、外部APIからのデータ取得など、時間がかかる処理を行う際に非常に有効です。

以下は、長時間処理をキャンセルする例です。

private void backgroundWorker_DoWork(object sender, DoWorkEventArgs e)
{
    for (int i = 0; i < 100000; i++) // 大量のデータ処理をシミュレーション
    {
        if (backgroundWorker.CancellationPending)
        {
            e.Cancel = true; // キャンセルフラグを設定
            return; // 処理を中断
        }
        // データ処理のシミュレーション
        Thread.Sleep(1); // 1ミリ秒待機
    }
}

このように、長時間かかる処理をバックグラウンドで実行し、ユーザーがキャンセルできるようにすることで、アプリケーションの使い勝手が向上します。

ユーザーインターフェースの応答性向上

BackgroundWorkerを使用することで、メインスレッドをブロックせずに処理を行うことができるため、ユーザーインターフェースの応答性が向上します。

例えば、ユーザーがボタンをクリックしてデータを取得する際、バックグラウンドで処理を行い、UIはそのまま操作可能な状態を保つことができます。

以下は、UIの応答性を保ちながらデータを取得する例です。

private void startButton_Click(object sender, EventArgs e)
{
    if (!backgroundWorker.IsBusy) // バックグラウンド処理が実行中でないか確認
    {
        startButton.Enabled = false; // ボタンを無効化
        backgroundWorker.RunWorkerAsync(); // バックグラウンド処理を開始
    }
}
private void backgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    startButton.Enabled = 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;
}
private void startButton1_Click(object sender, EventArgs e)
{
    if (!worker1.IsBusy) // worker1が実行中でないか確認
    {
        worker1.RunWorkerAsync(); // worker1を開始
    }
}
private void startButton2_Click(object sender, EventArgs e)
{
    if (!worker2.IsBusy) // worker2が実行中でないか確認
    {
        worker2.RunWorkerAsync(); // worker2を開始
    }
}
private void worker1_DoWork(object sender, DoWorkEventArgs e)
{
    // worker1の処理
}
private void worker2_DoWork(object sender, DoWorkEventArgs e)
{
    // worker2の処理
}