C# 中的 BackgroundWorker 类是 .NET Framework 提供的一个组件，用于在后台线程上异步执行长时间运行的操作，同时保持与用户界面（UI）的交互，如更新进度信息或处理取消请求。这使得可以轻松地在不冻结UI的情况下执行耗时的任务。
以下是如何在 C# 中使用 BackgroundWorker 的基本步骤：
-
初始化 BackgroundWorker： 在窗体加载或者其他合适的地方创建一个
BackgroundWorker实例，并设置其属性。private BackgroundWorker backgroundWorker = new BackgroundWorker(); // 在构造函数或Form_Load事件中初始化 public Form1() { InitializeComponent(); InitializeBackgroundWorker(); } private void InitializeBackgroundWorker() { // 允许报告进度 backgroundWorker.WorkerReportsProgress = true; // 允许在后台任务执行过程中取消操作 backgroundWorker.WorkerSupportsCancellation = true; // 为DoWork、ProgressChanged和RunWorkerCompleted事件添加事件处理器 backgroundWorker.DoWork += bgWorker_DoWork; backgroundWorker.ProgressChanged += bgWorker_ProgressChanged; backgroundWorker.RunWorkerCompleted += bgWorker_WorkerCompleted; } -
定义 DoWork 事件处理程序： 这是在后台线程上实际执行工作的位置。通过调用
ReportProgress()方法可以发送进度信息到主线程。private void bgWorker_DoWork(object sender, DoWorkEventArgs e) { BackgroundWorker worker = sender as BackgroundWorker; for (int i = 1; i <= 100; i++) { if (worker.CancellationPending) // 检查是否收到取消请求 { e.Cancel = true; break; } else { // 执行耗时操作 var result = PerformSomeLongRunningOperation(i); // 如果允许报告进度，则报告当前进度 worker.ReportProgress(i, result); // 可能需要在此处模拟延迟，例如 Thread.Sleep(100); } } } -
定义 ProgressChanged 事件处理程序： 当
ReportProgress()被调用时，这个事件会触发，用来更新 UI 上的进度条或其他进度指示器。private void bgWorker_ProgressChanged(object sender, ProgressChangedEventArgs e) { int progressPercentage = e.ProgressPercentage; string message = e.UserState as string; // 如果传递了其他数据 // 更新进度条控件 progressBar.Value = progressPercentage; // 或者显示消息 labelProgress.Text = $"已完成 {progressPercentage}%"; } -
定义 RunWorkerCompleted 事件处理程序： 当后台任务完成（成功、失败或被取消）时，此事件将触发，可以在这里进行清理工作或者通知用户操作已完成。
private void bgWorker_WorkerCompleted(object sender, RunWorkerCompletedEventArgs e) { if (e.Cancelled) { MessageBox.Show("操作已取消"); } else if (e.Error != null) { MessageBox.Show($"后台工作遇到错误: {e.Error.Message}"); } else { MessageBox.Show("后台工作已完成!"); // 此处可以获取后台任务的结果（如果有），例如：var result = e.Result; } // 恢复之前禁用的界面元素 buttonStart.Enabled = true; buttonCancel.Enabled = false; } -
启动 BackgroundWorker： 在按钮点击事件或其他触发点调用
RunWorkerAsync()来开始执行后台任务。private void buttonStart_Click(object sender, EventArgs e) { // 禁止再次点击直到后台任务完成 buttonStart.Enabled = false; buttonCancel.Enabled = true; // 启动后台任务并可选择性传递参数 backgroundWorker.RunWorkerAsync(); } -
取消 BackgroundWorker： 如果支持取消，在取消按钮的点击事件中调用
CancelAsync()方法来请求取消后台任务。private void buttonCancel_Click(object sender, EventArgs e) { backgroundWorker.CancelAsync(); }
以上就是一个典型的 BackgroundWorker 使用示例，注意实际应用中根据具体需求调整代码。
虽然 .NET Framework 和 .NET Core/.NET 5 及更高版本依然支持 BackgroundWorker，但在现代开发中更倾向于使用 Task 和 async/await 关键字来实现异步编程，或者使用 IProgress<T> 接口结合 async 方法来报告进度。
请注意，使用BackgroundWorker时，要确保任务是可中断的，因为它是在一个单独的线程中执行的。如果任务需要连续执行，可能需要特殊的处理。
