Exemplarische Vorgehensweise: Multithreading

Aktualisiert: Juli 2008

In dieser exemplarischen Vorgehensweise wird die Erstellung einer Multithreadanwendung beschrieben, die eine Textdatei nach Vorkommen eines Wortes durchsucht. Folgende Vorgänge werden veranschaulicht:

• Definieren einer Klasse mit einer Methode, die von der BackgroundWorker-Komponente aufgerufen werden kann.

• Das Behandeln von Ereignissen, die von der BackgroundWorker-Komponente ausgelöst werden.

• Das Starten einer BackgroundWorker-Komponente zum Ausführen einer Methode.

• Das Implementieren einer Cancel-Schaltfläche, mit der die Ausführung der BackgroundWorker-Komponente angehalten wird.

So erstellen Sie das Codebeispiel für dieses Thema

1. Öffnen Sie ein neues Visual Basic-Windows-Anwendungsprojekt, und erstellen Sie ein Formular mit dem Namen Form1.

2. Fügen Sie Form1 zwei Schaltflächen und vier Textfelder hinzu.

3. Benennen Sie die Objekte wie in der folgenden Tabelle:

   Objekt	Eigenschaft	Einstellung
   Erste Schaltfläche	Name, Text	Start, Start
   Zweite Schaltfläche	Name, Text	Cancel, Cancel
   Erstes Textfeld	Name, Text	SourceFile, ""
   Zweites Textfeld	Name, Text	CompareString, ""
   Drittes Textfeld	Name, Text	WordsCounted, "0"
   Viertes Textfeld	Name, Text	LinesCounted, "0"

4. Fügen Sie neben jedem Textfeld eine Bezeichnung hinzu. Legen Sie die Text-Eigenschaft für jede Bezeichnung wie in der folgenden Tabelle fest.

   Objekt	Eigenschaft	Einstellung
   Erste Bezeichnung	Text	Quelldatei
   Zweite Bezeichnung	Text	Zeichenfolge vergleichen
   Dritte Bezeichnung	Text	Matching Words
   Vierte Bezeichnung	Text	Lines Counted

5. Fügen Sie dem Formular aus dem Abschnitt Komponenten der Toolbox eine BackgroundWorker-Komponente hinzu. Sie wird im Komponentenfach des Formulars angezeigt.

6. Legen Sie die folgenden Eigenschaften für das BackgroundWorker1-Objekt fest.

   Eigenschaft	Einstellung
   WorkerReportsProgress	True
   WorkerSupportsCancellation	True

So definieren Sie die Methode, die in einem separaten Thread ausgeführt wird

1. Klicken Sie im Menü Projekt auf Klasse hinzufügen, um dem Projekt eine Klasse hinzuzufügen. Das Dialogfeld Neues Element hinzufügen wird angezeigt.

2. Wählen Sie im Vorlagenfenster Klasse aus, und geben Sie in das Namensfeld Words.vb ein.

3. Klicken Sie auf Hinzufügen. Die Words-Klasse wird angezeigt.

4. Fügen Sie am Beginn der Words-Klasse über der Class-Anweisung eine Option Compare-Anweisung hinzu:

   Option Compare Text ' Case insensitive search.
   ' Use Option Compare Binary for case sensitive search.
   

5. Fügen Sie der Words-Klasse den folgenden Code hinzu:

   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
   

So behandeln Sie Ereignisse aus dem Thread

• Fügen Sie dem Hauptformular die folgenden Ereignishandler hinzu:

  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
  

So starten und rufen Sie einen neuen Thread auf, der die WordCount-Methode ausführt

1. Fügen Sie dem Programm die folgenden Prozeduren hinzu:

   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
   

2. Rufen Sie über die Start-Schaltfläche im Formular die StartThread-Methode auf:

   Private Sub Start_Click( _
       ByVal sender As System.Object, _
       ByVal e As System.EventArgs) _
       Handles Start.Click
   
       StartThread()
   End Sub
   

So implementieren Sie eine Cancel-Schaltfläche, die den Thread beendet

• Rufen Sie mit dem Click-Ereignishandler die StopThread-Prozedur für die Cancel-Schaltfläche auf:

  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
  

Testen

Jetzt können Sie die Anwendung testen, um sicherzustellen, dass sie ordnungsgemäß funktioniert.

So testen Sie die Anwendung

1. Drucken Sie F5, um die Anwendung auszuführen.

2. Wenn das Formular angezeigt wird, geben Sie im sourceFile-Feld den Dateipfad für die zu testende Datei ein. Für eine Testdatei mit der Bezeichnung Test.txt geben Sie z. B. C:\Test.txt ein.

3. In das zweite Textfeld geben Sie ein Wort oder eine Wortgruppe ein, nach der die Anwendung die Textdatei durchsuchen soll.

4. Klicken Sie auf die Schaltfläche Start. Der Wert der Schaltfläche LinesCounted sollte unverzüglich schrittweise erhöht werden. Nachdem der Vorgang beendet ist, wird in der Anwendung eine Meldung angezeigt, die darauf hinweist, dass die Zählung abgeschlossen ist.

So testen Sie die Schaltfläche "Cancel"

1. Drücken Sie F5, um die Anwendung zu starten, und geben Sie Dateiname und Suchbegriff ein (siehe oben stehende Schrittfolge). Vergewissern Sie sich, dass die verwendete Datei groß genug ist, damit Sie genügend Zeit haben, den Suchvorgang abzubrechen, bevor er beendet ist.

2. Klicken Sie auf die Schaltfläche Start, um die Anwendung zu starten.

3. Klicken Sie auf die Schaltfläche Cancel. Die Anwendung sollte den Zählvorgang sofort abbrechen.

Nächste Schritte

Diese Anwendung umfasst einige grundlegende Fehlerbehandlungsmethoden. Sie erkennt leere Suchzeichenfolgen. Damit die Anwendung insgesamt stabiler läuft, können auch andere Fehler (z. B. das Überschreiten der maximalen Anzahl zählbarer Wörter oder Zeilen) behandelt werden.

Siehe auch

Aufgaben

Exemplarische Vorgehensweise: Erstellen einer einfachen Multithreadkomponente mit Visual Basic

Weitere Ressourcen

Multithreading in Visual Basic

Änderungsverlauf

Date	Versionsgeschichte	Grund
Juli 2008	Behebung von Fehlern in der WordCount-Methode des Beispiels	Kundenfeedback.