Procédure pas à pas : multithreading

  • Article

Mise à jour : Juillet 2008

Cette procédure pas à pas montre comment créer une application multithread qui recherche dans un fichier texte les occurrences d'un mot. Elle présente les points suivants :

  • Définition d'une classe à l'aide d'une méthode qui peut être appelée par le composant BackgroundWorker.

  • Gestion des événements déclenchés par le composant BackgroundWorker.

  • Démarrage d'un composant BackgroundWorker pour l'exécution d'une méthode.

  • Implémentation d'un bouton Cancel qui arrête le composant BackgroundWorker.

Pour créer l'exemple de code de cette rubrique

  1. Ouvrez un nouveau projet Application Windows Visual Basic, puis créez un formulaire nommé Form1.

  2. Ajoutez deux boutons et quatre zones de texte à Form1.

  3. Nommez les objets de la façon indiquée dans le tableau suivant.

    Objet

    Propriété

    Paramètre

    Premier bouton

    Name, Text

    Start, Start

    Deuxième bouton

    Name, Text

    Cancel, Cancel

    Première zone de texte

    Name, Text

    SourceFile, ""

    Deuxième zone de texte

    Name, Text

    CompareString, ""

    Troisième zone de texte

    Name, Text

    WordsCounted, "0"

    Quatrième zone de texte

    Name, Text

    LinesCounted, "0"

  4. Ajoutez une étiquette à côté de chaque zone de texte. Définissez la propriété Text pour chaque étiquette, comme illustré dans le tableau suivant.

    Objet

    Propriété

    Paramètre

    Première étiquette

    Text

    Source File

    Deuxième étiquette

    Text

    Compare String

    Troisième étiquette

    Text

    Matching Words

    Quatrième étiquette

    Text

    Lines Counted

  5. Ajoutez un composant BackgroundWorker contenu dans la section Composants de la Boîte à outils à votre formulaire. Il apparaît dans la barre d'état des composants du formulaire.

  6. Définissez les propriétés suivantes pour l'objet BackgroundWorker1.

    Propriété

    Paramètre

    WorkerReportsProgress

    True

    WorkerSupportsCancellation

    True

Pour définir la méthode qui s'exécutera sur un thread distinct

  1. Dans le menu Projet, sélectionnez Ajouter une classe pour ajouter une classe au projet. La boîte de dialogue Ajouter un nouvel élément s'affiche.

  2. Sélectionnez Classe dans la fenêtre des modèles et tapez Words.vb dans le champ du nom.

  3. Cliquez sur Ajouter. La classe Words s'affiche.

  4. Ajoutez une instruction Option Compare en haut de la classe Words, au-dessus de l'instruction Class :

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

  5. Ajoutez le code suivant à la classe 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

Pour gérer les événements à partir du thread

  • Ajoutez les gestionnaires d'événements suivants au formulaire principal :

    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

Pour démarrer et appeler un nouveau thread qui exécute la méthode WordCount

  1. Ajoutez les procédures suivantes à votre programme :

    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. Appelez la méthode StartThread à partir du bouton Start sur le formulaire :

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

    StartThread()
End Sub

Pour implémenter un bouton Cancel qui arrête le thread

  • Appelez la procédure StopThread à partir du gestionnaire d'événements Click pour le bouton 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

Test

Vous pouvez à présent tester l'application afin de vous assurer qu'elle fonctionne correctement.

Pour tester l'application

  1. Appuyez sur F5 pour exécuter l'application.

  2. Quand le formulaire s'affiche, entrez le chemin d'accès à un fichier de votre choix pour réaliser le test dans la zone sourceFile. Par exemple, supposons que le fichier de test se nomme Test.txt, entrez C:\Test.txt.

  3. Dans la deuxième zone de texte, entrez un mot ou une expression que l'application va devoir rechercher dans le fichier texte.

  4. Cliquez sur le bouton Start. Sur le bouton LinesCounted, la valeur affichée devrait commencer immédiatement à être incrémentée. L'application affiche le message « Finished Counting » une fois terminé.

Pour tester le bouton Cancel

  1. Appuyez sur F5 pour démarrer l'application, puis entrez le nom de fichier et le mot à rechercher comme le décrit la procédure précédente. Assurez-vous que le fichier choisi est suffisamment volumineux pour que vous ayez le temps d'annuler la procédure avant qu'elle ne soit terminée.

  2. Cliquez sur le bouton Start pour lancer l'application.

  3. Cliquez sur le bouton Cancel. L'application devrait cesser le décompte immédiatement.

Étapes suivantes

Cette application contient une fonctionnalité de base de gestion des erreurs. Elle détecte les chaînes de recherche vides. Vous pouvez ajouter robustesse à ce programme en lui permettant de gérer d'autres erreurs, telles que le dépassement du nombre maximal de mots ou de lignes pouvant être dénombrés.

Voir aussi

Tâches

Procédure pas à pas : création d'un composant simple multithread avec Visual Basic

Autres ressources

Multithreading dans Visual Basic

Historique des modifications

Date

Historique

Raison

Juillet 2008

Erreurs corrigées dans la méthode WordCount illustrée dans l'exemple.

Commentaires client.