C# - 异步编程 - BackgroundWorker 类

后台线程，BackgroundWorker 类用于创建一个线程，在后台持续运行以完成某项工作，并不时地与主线程通信。

BackgroundWorker 类的属性，方法与事件。

属性：

• WorkerReportsProgress ：设置后台任务是否可以把它的进度汇报给主线程。
• WorkerSupportsCancellation ：是否支持从主线程取消。
• IsBusy ：检查后台任务是否正在运行。
• CancellationPending ：每隔一段时间会检查该属性是否停止处理。

事件：

• DoWork - 在后台线程开始时触发。
• ProgressChanged - 后台任务汇报进度时触发。
• RunWorkerCompleted - 后台工作线程退出时触发。

方法：

• RunWorkerAsync() - 获取后台线程并执行 DoWork 事件处理程序。
• CancelAsync() - 设置 CancellationPending 属性为true。
• DoWork() - 事件处理程序希望向主线程序汇报进度的时候，调用 ReportProgress 方法。

namespace WpfApp1
{
    /// <summary>
    /// MainWindow.xaml 的交互逻辑
    /// </summary>
    public partial class MainWindow : Window
    {
        BackgroundWorker bgWorker = new BackgroundWorker();
        public MainWindow()
        {
            InitializeComponent();
            // 初始化
            bgWorker.WorkerReportsProgress = true;
            bgWorker.WorkerSupportsCancellation = true;
            
            // 事件注册
            bgWorker.DoWork += DoWork_Handler;
            bgWorker.ProgressChanged += ProgressChanged_Handler;
            bgWorker.RunWorkerCompleted += RunWorkerCompleted_Handler;
        }

        private void RunWorkerCompleted_Handler(object sender, RunWorkerCompletedEventArgs e)
        {
            progressBar.Value = 0;
            if (e.Cancelled)
                MessageBox.Show("Process was cancelled.", "Process Cancelled");
            else
                MessageBox.Show("Process completed normally.", "Process Completed");
        }

        private void ProgressChanged_Handler(object sender, ProgressChangedEventArgs e)
        {
            // 设置进度条值
            progressBar.Value = e.ProgressPercentage;
        }

        private void DoWork_Handler(object sender, DoWorkEventArgs e)
        {
            BackgroundWorker worker = sender as BackgroundWorker;

            for (int i = 0; i <= 10; i++)
            {
                // 循环判断 CancellationPending 是否为true。
                if (worker.CancellationPending)
                {
                    e.Cancel = true;
                    break;
                }
                else
                {
                    // 触发主线程 ProgressChanged
                    worker.ReportProgress(i * 10);
                    Thread.Sleep(250);
                }

            }
        }

        private async void btnProcess_Click(object sender, RoutedEventArgs e)
        {
            // 判断当前后台线程是否运行
           if (!bgWorker.IsBusy)
                // 调用方法启动后台线程，并触发 DoWork 事件
                bgWorker.RunWorkerAsync();
        }

        private void btnCancel_Click(object sender, RoutedEventArgs e)
        {
            // 设置对象 CancelltionPending 为true；
            bgWorker.CancelAsync();
        }
    }
}