チュートリアル: BackgroundWorker コンポーネントでのマルチスレッド (C# および Visual Basic)

このチュートリアルでは、テキスト ファイルで語句を検索する、マルチスレッド アプリケーションの作成方法を説明します。 次の方法を学ぶことができます。

• BackgroundWorker コンポーネントから呼び出し可能なメソッドを含むクラスの定義。

• BackgroundWorker コンポーネントで発生したイベントの処理。

• メソッドを実行するための BackgroundWorker コンポーネントの開始。

• BackgroundWorker コンポーネントを停止する Cancel ボタンの実装。

ユーザー インターフェイスを作成するには

1. Visual Basic または C# の新しい Windows アプリケーション プロジェクトを開き、Form1 という名前のフォームを作成します。

2. Form1 に 2 つのボタンと 4 つのテキスト ボックスを追加します。

3. 次の表のとおりにオブジェクトに名前を付けます。

   オブジェクト	プロパティ	設定
   1 番目のボタン	Name, Text	Start、Start
   2 番目のボタン	Name, Text	Cancel、Cancel
   1 番目のテキスト ボックス	Name, Text	SourceFile、""
   2 番目のテキスト ボックス	Name, Text	CompareString、""
   3 番目のテキスト ボックス	Name, Text	WordsCounted、"0"
   4 番目のテキスト ボックス	Name, Text	LinesCounted、"0"

4. 各テキスト ボックスの横にラベルを追加します。 次の表に示すように、各ラベルの Text プロパティを設定します。

   オブジェクト	プロパティ	設定
   1 番目のラベル	Text	Source File
   2 番目のラベル	Text	Compare String
   3 番目のラベル	Text	Matching Words
   4 番目のラベル	Text	Lines Counted

BackgroundWorker コンポーネントを作成してそのイベントをサブスクライブするには

1. [ツールボックス] の [コンポーネント] にある BackgroundWorker コンポーネントをフォームに追加します。 追加したコンポーネントがフォームのコンポーネント トレイに表示されます。

2. BackgroundWorker1 オブジェクト (Visual Basic) または backgroundWorker1 オブジェクト (C#) の次のプロパティを設定します。

   プロパティ	設定
   WorkerReportsProgress	True
   WorkerSupportsCancellation	True

3. C# でのみ、backgroundWorker1 オブジェクトのイベントをサブスクライブします。 プロパティ ウィンドウの上部にある [イベント] アイコンをクリックします。 RunWorkerCompleted イベントをダブルクリックして、イベント ハンドラー メソッドを作成します。 ProgressChanged イベントと DoWork イベントについても同じ操作を行います。

個別のスレッドで動作するメソッドを定義するには

1. [プロジェクト] メニューの [クラスの追加] を選択し、プロジェクトにクラスを追加します。 [新しい項目の追加] ダイアログ ボックスが表示されます。

2. テンプレート ウィンドウの [クラス] を選択し、名前フィールドに「Words.vb」または「Words.cs」と入力します。

3. [追加] をクリックします。 Words クラスが表示されます。

4. Words クラスに次のコードを追加します。

   Public Class Words
       ' Object to store the current state, for passing to the caller.
       Public Class CurrentState
           Public LinesCounted As Integer
           Public WordsMatched As Integer
       End Class
   
       Public SourceFile As String
       Public CompareString As String
       Private WordCount As Integer = 0
       Private LinesCounted As Integer = 0
   
       Public Sub CountWords(
           ByVal worker As System.ComponentModel.BackgroundWorker,
           ByVal e As System.ComponentModel.DoWorkEventArgs
       )
           ' Initialize the variables.
           Dim state As New CurrentState
           Dim line = ""
           Dim elapsedTime = 20
           Dim lastReportDateTime = Now
   
           If CompareString Is Nothing OrElse
              CompareString = System.String.Empty Then
   
              Throw New Exception("CompareString not specified.")
           End If
   
           Using myStream As New System.IO.StreamReader(SourceFile)
   
               ' Process lines while there are lines remaining in the file.
               Do While Not myStream.EndOfStream
                   If worker.CancellationPending Then
                       e.Cancel = True
                       Exit Do
                   Else
                       line = myStream.ReadLine
                       WordCount += CountInString(line, CompareString)
                       LinesCounted += 1
   
                       ' Raise an event so the form can monitor progress.
                       If Now > lastReportDateTime.AddMilliseconds(elapsedTime) Then
                           state.LinesCounted = LinesCounted
                           state.WordsMatched = WordCount
                           worker.ReportProgress(0, state)
                           lastReportDateTime = Now
                       End If
   
                       ' Uncomment for testing.
                       'System.Threading.Thread.Sleep(5)
                   End If
               Loop
   
               ' Report the final count values.
               state.LinesCounted = LinesCounted
               state.WordsMatched = WordCount
               worker.ReportProgress(0, state)
           End Using
       End Sub
   
       Private Function CountInString(
           ByVal SourceString As String,
           ByVal CompareString As String
       ) As Integer
           ' This function counts the number of times
           ' a word is found in a line.
           If SourceString Is Nothing Then
               Return 0
           End If
   
           Dim EscapedCompareString =
               System.Text.RegularExpressions.Regex.Escape(CompareString)
   
           Dim regex As New System.Text.RegularExpressions.Regex(
               EscapedCompareString,
               System.Text.RegularExpressions.RegexOptions.IgnoreCase)
   
           Dim matches As System.Text.RegularExpressions.MatchCollection
           matches = regex.Matches(SourceString)
           Return matches.Count
       End Function
   End Class
   

   public class Words
   {
       // Object to store the current state, for passing to the caller.
       public class CurrentState
       {
           public int LinesCounted;
           public int WordsMatched;
       }
   
       public string SourceFile;
       public string CompareString;
       private int WordCount;
       private int LinesCounted;
   
       public void CountWords(
           System.ComponentModel.BackgroundWorker worker,
           System.ComponentModel.DoWorkEventArgs e)
       {
           // Initialize the variables.
           CurrentState state = new CurrentState();
           string line = "";
           int elapsedTime = 20;
           DateTime lastReportDateTime = DateTime.Now;
   
           if (CompareString == null ||
               CompareString == System.String.Empty)
           {
               throw new Exception("CompareString not specified.");
           }
   
           // Open a new stream.
           using (System.IO.StreamReader myStream = new System.IO.StreamReader(SourceFile))
           {
               // Process lines while there are lines remaining in the file.
               while (!myStream.EndOfStream)
               {
                   if (worker.CancellationPending)
                   {
                       e.Cancel = true;
                       break;
                   }
                   else
                   {
                       line = myStream.ReadLine();
                       WordCount += CountInString(line, CompareString);
                       LinesCounted += 1;
   
                       // Raise an event so the form can monitor progress.
                       int compare = DateTime.Compare(
                           DateTime.Now, lastReportDateTime.AddMilliseconds(elapsedTime));
                       if (compare > 0)
                       {
                           state.LinesCounted = LinesCounted;
                           state.WordsMatched = WordCount;
                           worker.ReportProgress(0, state);
                           lastReportDateTime = DateTime.Now;
                       }
                   }
                   // Uncomment for testing.
                   //System.Threading.Thread.Sleep(5);
               }
   
               // Report the final count values.
               state.LinesCounted = LinesCounted;
               state.WordsMatched = WordCount;
               worker.ReportProgress(0, state);
           }
       }
   
   
       private int CountInString(
           string SourceString,
           string CompareString)
       {
           // This function counts the number of times
           // a word is found in a line.
           if (SourceString == null)
           {
               return 0;
           }
   
           string EscapedCompareString =
               System.Text.RegularExpressions.Regex.Escape(CompareString);
   
           System.Text.RegularExpressions.Regex regex;
           regex = new System.Text.RegularExpressions.Regex( 
               EscapedCompareString,
               System.Text.RegularExpressions.RegexOptions.IgnoreCase);
   
           System.Text.RegularExpressions.MatchCollection matches;
           matches = regex.Matches(SourceString);
           return matches.Count;
       }
   
   }
   

スレッドからイベントを処理するには

• メイン フォームに次のイベント ハンドラーを追加します。

  Private Sub BackgroundWorker1_RunWorkerCompleted( 
      ByVal sender As Object, 
      ByVal e As System.ComponentModel.RunWorkerCompletedEventArgs
    ) Handles BackgroundWorker1.RunWorkerCompleted
  
      ' This event handler is called when the background thread finishes.
      ' This method runs on the main thread.
      If e.Error IsNot Nothing Then
          MessageBox.Show("Error: " & e.Error.Message)
      ElseIf e.Cancelled Then
          MessageBox.Show("Word counting canceled.")
      Else
          MessageBox.Show("Finished counting words.")
      End If
  End Sub
  
  Private Sub BackgroundWorker1_ProgressChanged( 
      ByVal sender As Object, 
      ByVal e As System.ComponentModel.ProgressChangedEventArgs
    ) Handles BackgroundWorker1.ProgressChanged
  
      ' This method runs on the main thread.
      Dim state As Words.CurrentState = 
          CType(e.UserState, Words.CurrentState)
      Me.LinesCounted.Text = state.LinesCounted.ToString
      Me.WordsCounted.Text = state.WordsMatched.ToString
  End Sub
  

  private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
  {
  // This event handler is called when the background thread finishes.
  // This method runs on the main thread.
  if (e.Error != null)
      MessageBox.Show("Error: " + e.Error.Message);
  else if (e.Cancelled)
      MessageBox.Show("Word counting canceled.");
  else
      MessageBox.Show("Finished counting words.");
  }
  
  private void backgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
  {
      // This method runs on the main thread.
      Words.CurrentState state =
          (Words.CurrentState)e.UserState;
      this.LinesCounted.Text = state.LinesCounted.ToString();
      this.WordsCounted.Text = state.WordsMatched.ToString();
  }
  

WordCount メソッドを実行する新しいスレッドを開始して呼び出すには

1. プログラムに次のプロシージャを追加します。

   Private Sub BackgroundWorker1_DoWork( 
       ByVal sender As Object, 
       ByVal e As System.ComponentModel.DoWorkEventArgs
     ) Handles BackgroundWorker1.DoWork
   
       ' This event handler is where the actual work is done.
       ' This method runs on the background thread.
   
       ' Get the BackgroundWorker object that raised this event.
       Dim worker As System.ComponentModel.BackgroundWorker
       worker = CType(sender, System.ComponentModel.BackgroundWorker)
   
       ' Get the Words object and call the main method.
       Dim WC As Words = CType(e.Argument, Words)
       WC.CountWords(worker, e)
   End Sub
   
   Sub StartThread()
       ' This method runs on the main thread.
       Me.WordsCounted.Text = "0"
   
       ' Initialize the object that the background worker calls.
       Dim WC As New Words
       WC.CompareString = Me.CompareString.Text
       WC.SourceFile = Me.SourceFile.Text
   
       ' Start the asynchronous operation.
       BackgroundWorker1.RunWorkerAsync(WC)
   End Sub
   

   private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
   {
       // This event handler is where the actual work is done.
       // This method runs on the background thread.
   
       // Get the BackgroundWorker object that raised this event.
       System.ComponentModel.BackgroundWorker worker;
       worker = (System.ComponentModel.BackgroundWorker)sender;
   
       // Get the Words object and call the main method.
       Words WC = (Words)e.Argument;
       WC.CountWords(worker, e);
   }
   
   private void StartThread()
   {
       // This method runs on the main thread.
       this.WordsCounted.Text = "0";
   
       // Initialize the object that the background worker calls.
       Words WC = new Words();
       WC.CompareString = this.CompareString.Text;
       WC.SourceFile = this.SourceFile.Text;
   
       // Start the asynchronous operation.
       backgroundWorker1.RunWorkerAsync(WC);
   }
   

2. フォームの Start ボタンから StartThread メソッドを呼び出します。

   Private Sub Start_Click() Handles Start.Click
       StartThread()
   End Sub
   

   private void Start_Click(object sender, EventArgs e)
   {
       StartThread();
   }
   

スレッドを停止する Cancel ボタンを実装するには

• Cancel ボタンの Click イベント ハンドラーから StopThread プロシージャを呼び出します。

  Private Sub Cancel_Click() Handles Cancel.Click
      ' Cancel the asynchronous operation.
      Me.BackgroundWorker1.CancelAsync()
  End Sub
  

  private void Cancel_Click(object sender, EventArgs e)
  {
      // Cancel the asynchronous operation.
      this.backgroundWorker1.CancelAsync();
  }
  

テスト

アプリケーションをテストして、正常に動作することを確認します。

アプリケーションをテストするには

1. F5 キーを押してアプリケーションを実行します。

2. フォームが表示されたら、テストするファイルのファイル パスを sourceFile ボックスに入力します。 たとえば、テスト ファイルの名前が Test.txt の場合は、「C:\Test.txt」と入力します。

3. 2 番目のテキスト ボックスに、アプリケーションがテキスト ファイル内を検索する語句またはフレーズを入力します。

4. [Start] をクリックします。 LinesCounted ボックスで、直ちにインクリメントが開始されます。 完了すると、アプリケーションは "Finished Counting" というメッセージを表示します。

Cancel ボタンをテストするには

1. F5 キーを押して、アプリケーションを開始します。前の手順で説明したように、ファイル名と検索語句を入力します。 動作が完了する前にプロシージャをキャンセルするだけの時間があるように、サイズの大きいファイルを選択します。

2. Start をクリックして、アプリケーションを起動します。

3. [Cancel] をクリックします。 アプリケーションは直ちにカウントを中止します。

次の手順

このアプリケーションには、基本的なエラー処理が含まれています。 空白の検索文字列が検出されます。 語句の数やカウントする行数が最大値を超えた場合など、その他のエラーを処理することで、このプログラムの信頼性をより高くできます。

参照

処理手順

チュートリアル : Visual Basic による簡単なマルチスレッド コンポーネントの作成

方法 : イベント サブスクリプションとサブスクリプションの解除 (C# プログラミング ガイド)

参照

スレッド処理 (C# および Visual Basic)