Návod: Spuštění operace na pozadí

Článek
12/17/2024

Pokud máte operaci, která bude trvat dlouhou dobu a nechcete způsobit zpoždění v uživatelském rozhraní, můžete operaci spustit v jiném vlákně pomocí třídy BackgroundWorker.

Úplný výpis kódu použitého v tomto příkladu najdete v tématu Postupy: Spuštění operace na pozadí.

Spuštění operace na pozadí

Když je formulář aktivní v nástroji Windows Forms Designer v sadě Visual Studio, přetáhněte dva ovládací prvky Button z panelu nástrojů do formuláře a potom nastavte vlastnosti Name a Text tlačítek podle následující tabulky.

Knoflík Jméno Text

button1 startBtn Začátek

button2 cancelBtn Zrušit
Otevřete Panel nástrojů, klikněte na kartu Součásti a přetáhněte komponentu BackgroundWorker do formuláře.

Komponenta backgroundWorker1 se objeví v zásobníku komponent .
V okně Vlastnosti nastavte vlastnost WorkerSupportsCancellation na true.
V okně Vlastnosti klikněte na tlačítko Události a potom poklikejte na události DoWork a RunWorkerCompleted a vytvořte obslužné rutiny.
Vložte časově náročný kód do obslužné rutiny události DoWork.
Extrahujte všechny parametry vyžadované operací z vlastnosti Argument parametru DoWorkEventArgs.

Knoflík	Jméno	Text
`button1`	`startBtn`	Začátek
`button2`	`cancelBtn`	Zrušit

Přiřaďte výsledek výpočtu do vlastnosti Result objektu DoWorkEventArgs.

To bude k dispozici pro zpracovatele události RunWorkerCompleted.

private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
{
    // Do not access the form's BackgroundWorker reference directly.
    // Instead, use the reference provided by the sender parameter.
    BackgroundWorker bw = sender as BackgroundWorker;

    // Extract the argument.
    int arg = (int)e.Argument;

    // Start the time-consuming operation.
    e.Result = TimeConsumingOperation(bw, arg);

    // If the operation was canceled by the user,
    // set the DoWorkEventArgs.Cancel property to true.
    if (bw.CancellationPending)
    {
        e.Cancel = true;
    }
}

Private Sub backgroundWorker1_DoWork( _
sender As Object, e As DoWorkEventArgs) _
Handles backgroundWorker1.DoWork

   ' Do not access the form's BackgroundWorker reference directly.
   ' Instead, use the reference provided by the sender parameter.
   Dim bw As BackgroundWorker = CType( sender, BackgroundWorker )
   
   ' Extract the argument.
   Dim arg As Integer = Fix(e.Argument)
   
   ' Start the time-consuming operation.
   e.Result = TimeConsumingOperation(bw, arg)
   
   ' If the operation was canceled by the user, 
   ' set the DoWorkEventArgs.Cancel property to true.
   If bw.CancellationPending Then
      e.Cancel = True
   End If

End Sub

Vložte kód pro načtení výsledku operace do obslužné rutiny události RunWorkerCompleted.

// This event handler demonstrates how to interpret
// the outcome of the asynchronous operation implemented
// in the DoWork event handler.
private void backgroundWorker1_RunWorkerCompleted(
    object sender,
    RunWorkerCompletedEventArgs e)
{
    if (e.Cancelled)
    {
        // The user canceled the operation.
        MessageBox.Show("Operation was canceled");
    }
    else if (e.Error != null)
    {
        // There was an error during the operation.
        string msg = String.Format("An error occurred: {0}", e.Error.Message);
        MessageBox.Show(msg);
    }
    else
    {
        // The operation completed normally.
        string msg = String.Format("Result = {0}", e.Result);
        MessageBox.Show(msg);
    }
}

' This event handler demonstrates how to interpret 
' the outcome of the asynchronous operation implemented
' in the DoWork event handler.
Private Sub backgroundWorker1_RunWorkerCompleted( _
sender As Object, e As RunWorkerCompletedEventArgs) _
Handles backgroundWorker1.RunWorkerCompleted

   If e.Cancelled Then
      ' The user canceled the operation.
      MessageBox.Show("Operation was canceled")
   ElseIf (e.Error IsNot Nothing) Then
      ' There was an error during the operation.
      Dim msg As String = String.Format("An error occurred: {0}", e.Error.Message)
      MessageBox.Show(msg)
   Else
      ' The operation completed normally.
      Dim msg As String = String.Format("Result = {0}", e.Result)
      MessageBox.Show(msg)
   End If
End Sub

Implementujte metodu TimeConsumingOperation.

// This method models an operation that may take a long time
// to run. It can be cancelled, it can raise an exception,
// or it can exit normally and return a result. These outcomes
// are chosen randomly.
private int TimeConsumingOperation(
    BackgroundWorker bw,
    int sleepPeriod )
{
    int result = 0;

    Random rand = new Random();

    while (!bw.CancellationPending)
    {
        bool exit = false;

        switch (rand.Next(3))
        {
            // Raise an exception.
            case 0:
            {
                throw new Exception("An error condition occurred.");
                break;
            }

            // Sleep for the number of milliseconds
            // specified by the sleepPeriod parameter.
            case 1:
            {
                Thread.Sleep(sleepPeriod);
                break;
            }

            // Exit and return normally.
            case 2:
            {
                result = 23;
                exit = true;
                break;
            }

            default:
            {
                break;
            }
        }

        if( exit )
        {
            break;
        }
    }

    return result;
}

' This method models an operation that may take a long time 
' to run. It can be cancelled, it can raise an exception,
' or it can exit normally and return a result. These outcomes
' are chosen randomly.
Private Function TimeConsumingOperation( _
bw As BackgroundWorker, _
sleepPeriod As Integer) As Integer

   Dim result As Integer = 0
   
   Dim rand As New Random()
   
     While Not bw.CancellationPending
         Dim [exit] As Boolean = False

         Select Case rand.Next(3)
             ' Raise an exception.
             Case 0
                 Throw New Exception("An error condition occurred.")
                 Exit While

                 ' Sleep for the number of milliseconds
                 ' specified by the sleepPeriod parameter.
             Case 1
                 Thread.Sleep(sleepPeriod)
                 Exit While

                 ' Exit and return normally.
             Case 2
                 result = 23
                 [exit] = True
                 Exit While

             Case Else
                 Exit While
         End Select

         If [exit] Then
             Exit While
         End If
     End While
   
   Return result
End Function

V nástroji Windows Forms Designer poklikáním na startButton vytvořte obslužnou rutinu události Click.

Zavolejte metodu RunWorkerAsync v obslužné rutině události Click pro startButton.

private void startBtn_Click(object sender, EventArgs e)
{
    this.backgroundWorker1.RunWorkerAsync(2000);
}

Private Sub startButton_Click(ByVal sender As Object, ByVal e As EventArgs) Handles startBtn.Click
    Me.backgroundWorker1.RunWorkerAsync(2000)
End Sub

V nástroji Windows Forms Designer poklikáním na cancelButton vytvořte obslužnou rutinu události Click.

Zavolejte metodu CancelAsync v rámci obsluhy události Click pro cancelButton.

private void cancelBtn_Click(object sender, EventArgs e)
{
    this.backgroundWorker1.CancelAsync();
}

Private Sub cancelButton_Click(ByVal sender As Object, ByVal e As EventArgs) Handles cancelBtn.Click
    Me.backgroundWorker1.CancelAsync()
End Sub

V horní části souboru naimportujte obory názvů System.ComponentModel a System.Threading.

using System;
using System.ComponentModel;
using System.Drawing;
using System.Threading;
using System.Windows.Forms;

Imports System.ComponentModel
Imports System.Drawing
Imports System.Threading
Imports System.Windows.Forms

Stisknutím klávesy F6 sestavte řešení a stisknutím klávesy Ctrl+F5 spusťte aplikaci mimo ladicí program.

Poznámka

Pokud stisknete F5 ke spuštění aplikace pod ladicím programem, ladicí program zachytí a zobrazí výjimku vyvolanou v metodě TimeConsumingOperation. Když spustíte aplikaci mimo ladicí program, BackgroundWorker zpracuje výjimku a uloží ji do vlastnosti Error mezipaměti RunWorkerCompletedEventArgs.
Kliknutím na tlačítko Spustit spusťte asynchronní operaci a potom kliknutím na tlačítko Zrušit zastavte spuštěnou asynchronní operaci.

Výsledek každé operace se zobrazí v MessageBox.

Další kroky

Implementujte formulář, který hlásí průběh při asynchronní operaci. Další informace naleznete v tématu Postupy: Implementace formuláře, který používá operaci na pozadí.
Implementujte třídu, která podporuje asynchronní vzor pro komponenty. Další informace naleznete v tématu Implementace asynchronního vzoru založeného na událostech.

Sdílet prostřednictvím

Návod: Spuštění operace na pozadí

Spuštění operace na pozadí

Další kroky

Viz také

Další materiály