Návod: Spuštění operace na pozadí
Pokud máte operaci, která bude trvat dlouhou dobu a nechcete způsobit zpoždění v uživatelském rozhraní, můžete použít BackgroundWorker třídu ke spuštění operace v jiném vlákně.
Ú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ávrháři model Windows Forms v sadě Visual Studio, přetáhněte dva Button ovládací prvky ze sady nástrojů do formuláře a pak nastavte
Name
a Text vlastnosti tlačítek podle následující tabulky.Button Název Text button1
startBtn
Spustit 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 zobrazí v zásobníku komponent.V okně Vlastnosti nastavte WorkerSupportsCancellation vlastnost na
true
hodnotu .V okně Vlastnosti klikněte na tlačítko Události a potom poklikejte na DoWork události a RunWorkerCompleted vytvořte obslužné rutiny událostí.
Vložte časově náročný kód do DoWork obslužné rutiny události.
Extrahujte všechny parametry požadované operací z Argument vlastnosti parametru DoWorkEventArgs .
Přiřaďte výsledek výpočtu vlastnosti ResultDoWorkEventArgs.
Tato možnost bude k dispozici pro obslužnou rutinu RunWorkerCompleted události.
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 vaší operace do RunWorkerCompleted obslužné rutiny události.
// 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ávrháři model Windows Forms poklikáním
startButton
vytvořte obslužnou rutinu Click události.RunWorkerAsync Volání metody v obslužné rutině Click události 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ávrháři model Windows Forms poklikáním
cancelButton
vytvořte obslužnou rutinu Click události.CancelAsync Volání metody v obslužné rutině Click události 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áves Ctrl+F5 spusťte aplikaci mimo ladicí program.
Poznámka:
Pokud stisknutím klávesy F5 spustíte aplikaci v ladicím programu, je zachycena a zobrazena výjimkou vyvolaná v
TimeConsumingOperation
metodě ladicí program. Když spustíte aplikaci mimo ladicí program, BackgroundWorker zpracuje výjimku a uloží ji do mezipaměti ve Error vlastnosti objektu RunWorkerCompletedEventArgs.Kliknutím na tlačítko Start spusťte asynchronní operaci a kliknutím na tlačítko Storno zastavte spuštěnou asynchronní operaci.
Výsledek každé operace se zobrazí v sadě 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.
Viz také
.NET Desktop feedback