Пошаговое руководство. Многопоточность
Обновлен: Июль 2008
Этот пример демонстрирует процедуру создания приложения многопоточной обработки, которое выполняет поиск вхождений определенного слова в текстовом файле. Демонстрируется следующее:
Определение класса с методом, который может вызываться компонентом BackgroundWorker.
Обработка событий, вызванных компонентом BackgroundWorker.
Запуск компонента BackgroundWorker для выполнения метода.
Реализация кнопки Cancel, которая останавливает компонент BackgroundWorker.
Создание примера кода для этого раздела
Откройте новый проект Windows-приложения Visual Basic и создайте форму с именем Form1.
Добавьте на Form1 две кнопки и четыре текстовых поля.
Присвойте объектам имена, как показано ниже в таблице.
Объект
Свойство
Параметр
Первая кнопка
Name, Text
Start, Начать
Вторая кнопка
Name, Text
Cancel, Отмена
Первое текстовое поле
Name, Text
SourceFile, ""
Второе текстовое поле
Name, Text
CompareString, ""
Третье текстовое поле
Name, Text
WordsCounted, "0"
Четвертое текстовое поле
Name, Text
LinesCounted, "0"
Добавьте надпись для каждого поля. Задайте свойство Text для каждой надписи, как показано в следующей таблице.
Объект
Свойство
Параметр
Первая надпись
Text
Исходный файл
Вторая надпись
Text
Строка для сравнения
Третья надпись
Text
Совпадающие слова
Четвертая надпись
Text
Посчитано строк
Добавьте на форму компонент BackgroundWorker из раздела Компонентыпанели элементов. Он появится в области компонентов формы.
Задайте следующие свойства для объекта BackgroundWorker1.
Свойство
Параметр
WorkerReportsProgress
True
WorkerSupportsCancellation
True
Определение метода, выполняемого в отдельном потоке
Чтобы добавить класс в проект, в меню Проект выберите пункт Добавить класс. Откроется диалоговое окно Добавление нового элемента.
Выберите в окне шаблонов пункт Класс и введите в поле имени Words.vb.
Нажмите кнопку Добавить. Отображается класс Words.
Добавьте оператор Option Compare в начало класса Words над оператором Class:
Option Compare Text ' Case insensitive search. ' Use Option Compare Binary for case sensitive search.
Добавьте в класс 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 myStream As System.IO.StreamReader = Nothing Dim line = "" Dim elapsedTime = 20 Dim lastReportDateTime = Now If CompareString Is Nothing Or _ CompareString = System.String.Empty Then Throw New Exception("CompareString not specified.") End If Try ' Open a new stream. myStream = My.Computer.FileSystem.OpenTextFileReader(SourceFile) ' Do while there are lines remaining in the file to be read. 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.AddMilliseconds(elapsedTime) End If End If Loop ' Report the final count values. state.LinesCounted = LinesCounted state.WordsMatched = WordCount worker.ReportProgress(0, state) Finally If myStream IsNot Nothing Then ' Close the file. myStream.Close() End If End Try 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 regex As New System.Text.RegularExpressions.Regex( _ System.Text.RegularExpressions.Regex.Escape(CompareString)) Dim matches As System.Text.RegularExpressions.MatchCollection matches = regex.Matches(SourceString) Return matches.Count End Function End Class
Обработка событий из потока
Добавьте в главную форму следующие обработчики событий:
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 MsgBox("Error: " & e.Error.Message) ElseIf e.Cancelled Then MsgBox("Word counting canceled.") Else MsgBox("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 event handler is called after the background thread ' reads a line from the source file. ' 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
Запуск и вызов нового потока, в котором выполняется метод WordCount
Добавьте в программу следующие процедуры:
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 Works 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
Вызовите метод StartThread кнопки Start на форме:
Private Sub Start_Click( _ ByVal sender As System.Object, _ ByVal e As System.EventArgs) _ Handles Start.Click StartThread() End Sub
Реализация кнопки отмены, которая останавливает поток
Вызовите процедуру StopThread из обработчика событий Click кнопки Cancel.
Private Sub Cancel_Click( _ ByVal sender As System.Object, _ ByVal e As System.EventArgs) _ Handles Cancel.Click ' Cancel the asynchronous operation. Me.BackgroundWorker1.CancelAsync() End Sub
Проверка
Теперь можно протестировать приложение, чтобы проверить его работоспособность.
Тестирование приложения
Нажмите клавишу F5 для запуска приложения.
Когда появится форма, в текстовом поле sourceFile ведите путь к файлу, который необходимо проверить. Например, если тестовый файл называется Test.txt, введите "C:\Test.txt".
Во втором текстовом поле введите слово или фразу, которые приложение будет искать в указанном файле.
Нажмите кнопку Start. Кнопка LinesCounted должна немедленно начать увеличение счета. По завершении работы приложения отображается сообщение об окончании подсчета.
Проверка работы кнопки отмены
Нажмите клавишу F5 для запуска приложения и введите слово и имя файла, как описано в предыдущей процедуре. Убедитесь, что указанный файл достаточно велик, чтобы можно было отменить процедуру до ее завершения.
Нажмите кнопку Start для запуска приложения.
Нажмите кнопку Cancel. Приложение должно немедленно прекратить подсчет.
Следующие действия
В этом приложении реализована начальная стадия обработки ошибок. На этой стадии обнаруживаются пустые строки поиска. Программу можно сделать более устойчивой, введя в нее обработку других ошибок, например превышения максимального количества слов или строк, которые могут быть подсчитаны.
См. также
Задачи
Пошаговое руководство. Разработка простого многопоточного компонента с использованием Visual Basic
Другие ресурсы
Многопотоковость в Visual Basic
Журнал изменений
Дата |
Журнал изменений |
Причина |
---|---|---|
Июль 2008 |
Устраненные ошибки метода WordCount в примере. |
Обратная связь от клиента. |