In-depth explanation of C# BackgroundWorker

2 years ago
Isabella Edwards
2 minutes

The C# BackgroundWorker is a component used to perform time-consuming operations in a background thread. It allows us to continue responding to user interface interactions while executing tasks, and provides mechanisms for progress reporting and task cancellation.

The basic steps for using BackgroundWorker are as follows:

  1. Create a BackgroundWorker object and subscribe to its DoWork, ProgressChanged, and RunWorkerCompleted events.
BackgroundWorker worker = new BackgroundWorker();
worker.DoWork += Worker_DoWork;
worker.ProgressChanged += Worker_ProgressChanged;
worker.RunWorkerCompleted += Worker_RunWorkerCompleted;
  1. Execute time-consuming tasks in the DoWork event. This event runs on a background thread.
private void Worker_DoWork(object sender, DoWorkEventArgs e)
{
    // 耗时的任务
}
  1. If you need to report progress during task execution, you can call the ReportProgress method in the DoWork event.
worker.ReportProgress(progressPercentage);
  1. Update the progress bar or other UI elements in the ProgressChanged event.
private void Worker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
    // 更新 UI
}
  1. Process the logic after the task is completed in the RunWorkerCompleted event. This event is executed on the main thread.
private void Worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    // 处理任务完成后的逻辑
}
  1. Start the background task.
worker.RunWorkerAsync();

It is important to note that the BackgroundWorker component has been deprecated after .NET Framework 4.5. It is recommended to use the Task-based Asynchronous Pattern (TAP) or utilize the async/await keywords to handle asynchronous tasks.

bannerAds