Пошаговое руководство. Многопоточность с помощью компонента BackgroundWorker (C# и Visual Basic)

Этот пример демонстрирует процедуру создания приложения многопоточной обработки, которое выполняет поиск вхождений определенного слова в текстовом файле. Демонстрируется следующее:

• Определение класса с методом, который может вызываться компонентом BackgroundWorker.

• Обработка событий, вызванных компонентом BackgroundWorker.

• Запуск компонента BackgroundWorker для выполнения метода.

• Реализация кнопки Cancel, которая останавливает компонент BackgroundWorker.

Создание пользовательского интерфейса

1. Откройте новый проект приложения Windows на языке Visual Basic или C# и создайте форму с именем Form1.

2. Добавьте на Form1 две кнопки и четыре текстовых поля.

3. Присвойте объектам имена, как показано ниже в таблице.

   Объект	Свойство	Параметр
   Первая кнопка	Name, Text	Start, Начать
   Вторая кнопка	Name, Text	Cancel, Отмена
   Первое текстовое поле	Name, Text	SourceFile, ""
   Второе текстовое поле	Name, Text	CompareString, ""
   Третье текстовое поле	Name, Text	WordsCounted, "0"
   Четвертое текстовое поле	Name, Text	LinesCounted, "0"

4. Добавьте надпись для каждого поля. Задайте свойство Text для каждой надписи, как показано в следующей таблице.

   Объект	Свойство	Параметр
   Первая надпись	Text	Исходный файл
   Вторая надпись	Text	Строка для сравнения
   Третья надпись	Text	Совпадающие слова
   Четвертая надпись	Text	Посчитано строк

Создание компонента 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. Вызовите метод StartThread кнопки Start на форме:

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

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

Реализация кнопки отмены, которая останавливает поток

• Вызовите процедуру StopThread из обработчика событий Click кнопки Cancel.

  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. Во втором текстовом поле введите слово или фразу, которые приложение будет искать в указанном файле.

4. Нажмите кнопку Start. Кнопка LinesCounted должна немедленно начать увеличение счета. По завершении работы приложения отображается сообщение об окончании подсчета.

Проверка работы кнопки отмены

1. Нажмите клавишу F5 для запуска приложения и введите слово и имя файла, как описано в предыдущей процедуре. Убедитесь, что указанный файл достаточно велик, чтобы можно было отменить процедуру до ее завершения.

2. Нажмите кнопку Start для запуска приложения.

3. Нажмите кнопку Cancel. Приложение должно немедленно прекратить подсчет.

Следующие действия

В этом приложении реализована начальная стадия обработки ошибок. На этой стадии обнаруживаются пустые строки поиска. Программу можно сделать более устойчивой, введя в нее обработку других ошибок, например превышения максимального количества слов или строк, которые могут быть подсчитаны.

См. также

Задачи

Пошаговое руководство. Разработка простого многопоточного компонента с использованием Visual Basic

Практическое руководство. Подписка и отмена подписки на события (Руководство по программированию в C#)

Основные понятия

Работа с потоками (C# и Visual Basic)