BackGroundWorker组件详解

注：本文转自比new Thread好用的BackgroundWorker

BackgroundWorker 可以用于启动后台线程。

主要的事件及参数：
　　1.DoWork——当执行BackgroundWorker.RunWorkerAsync方法时会触发该事件，并且传递DoWorkEventArgs参数;

　　2.RunWorkerCompleted——异步操作完成或中途终止会触发该事件。

如果需要提前终止执行后台操作，可以调用BackgroundWorker.CancelAsync方法。

在处理DoWork事件的函数中检测BackgroundWorker.CancellationPending属性是否为true，如果是true，则表示用户已经取消了异步调用，同时将DoWorkEventArgs.Cancel属性设为true(传递给处理DoWork事件的函数的第二个参数)，这样当退出异步调用的时候，可以让处理RunWorkerCompleted事件的函数知道是正常退出还是中途退出。
　　3.ProgressChanged——操作处理中获得的处理状态变化，通过BackgroundWorker.ReportProgress(int)方法触发该事件，并且传递ProgressChangedEventArgs,其中包含了处理的百分比,这个参数在UI界面上设置progressbar控件。

主要的方法：
1. BackgroundWorker.RunWorkerAsync——“起动”异步调用的方法有两次重载RunWorkerAsync(),RunWorkerAsync(object argument)，第二个重载提供了一个参数，可以供异步调用使用。（如果有多个参数要传递怎么办，使用一个类来传递他们吧)。调用该方法后会触发DoWork事件，并且为处理DoWork事件的函数传递DoWorkEventArg参数，其中包含了RunWorkerAsync传递的参数。在相应DoWork的处理函数中就可以做具体的复杂操作。
2. BackgroundWorker.ReportProgress——需要在一个冗长的操作中向用户不断反馈进度，这样的话就可以调用的ReportProgress(int percent),在调用 ReportProgress 方法时，触发ProgressChanged事件。提供一个在 0 到 100 之间的整数，它表示后台活动已完成的百分比。你也可以提供任何对象作为第二个参数，允许你 给事件处理程序传递状态信息。作为传递到此过程的 ProgressChangedEventArgs 参数属性，百分比和你自己的对象（如果提供的话）均要被传递到 ProgressChanged 事件处理程序。这些属性被分别命名为 ProgressPercentage 和 UserState，并且你的事件处理程序可以以任何需要的方式使用它们。(注意：只有在BackgroundWorker.WorkerReportsProgress属性被设置为true该方法才可用)。
3. BackgroundWorker.CancelAsync——但需要退出异步调用的时候，就调用的这个方法。但是样还不够，因为它仅仅是将BackgroudWorker.CancellationPending属性设置为true。你需要在具体的异步调用处理的时候，不断检查BackgroudWorker.CancellationPending是否为true，如果是真的话就退出。(注意：只有在BackgroundWorker.WorkerSupportsCancellation属性被设置为true该方法才可用)。

 

BackgroundWorker组件
在VS2005中添加了BackgroundWorker组件，该组件在多线程编程方面使用起来非常方便，然而在开始时由于没有搞清楚它的使用机制，走了不少的弯路，现在把我在使用它的过程中的经验与诸位分享一下。
BackgroundWorker类中主要用到的有这列属性、方法和事件：
重要属性：
1、CancellationPending 获取一个值，指示应用程序是否已请求取消后台操作。通过在DoWork事件中判断CancellationPending属性可以认定是否需要取消后台操作（也就是结束线程）；
2、IsBusy 获取一个值，指示 BackgroundWorker 是否正在运行异步操作。程序中使用IsBusy属性用来确定后台操作是否正在使用中；
3、WorkerReportsProgress 获取或设置一个值，该值指示BackgroundWorker能否报告进度更新
4、WorkerSupportsCancellation 获取或设置一个值，该值指示 BackgroundWorker 是否支持异步取消。设置WorkerSupportsCancellation为true使得程序可以调用CancelAsync方法提交终止挂起的后台操作的请求；
重要方法：
1、CancelAsync 请求取消挂起的后台操作
2、RunWorkerAsync 开始执行后台操作
3、ReportProgress 引发ProgressChanged事件
重要事件：
1、DoWork 调用 RunWorkerAsync 时发生
2、ProgressChanged 调用 ReportProgress 时发生
3、RunWorkerCompleted 当后台操作已完成、被取消或引发异常时发生
另外还有三个重要的参数是RunWorkerCompletedEventArgs以及DoWorkEventArgs、ProgressChangedEventArgs。
BackgroundWorker的各属性、方法、事件的调用机制和顺序：

从上图可见在整个生活周期内发生了3次重要的参数传递过程：
参数传递1：此次的参数传递是将RunWorkerAsync(Object)中的Object传递到DoWork事件的DoWorkEventArgs.Argument,由于在这里只有一个参数可以传递，所以在实际应用往封装一个类，将整个实例化的类作为RunWorkerAsync的Object传递到DoWorkEventArgs.Argument；
参数传递2：此次是将程序运行进度传递给ProgressChanged事件，实际使用中往往使用给方法和事件更新进度条或者日志信息；
参数传递3：在DoWork事件结束之前，将后台线程产生的结果数据赋给DoWorkEventArgs.Result一边在RunWorkerCompleted事件中调用RunWorkerCompletedEventArgs.Result属性取得后台线程产生的结果。
另外从上图可以看到DoWork事件是在后台线程中运行的，所以在该事件中不能够操作用户界面的内容，如果需要更新用户界面，可以使用ProgressChanged事件及RunWorkCompleted事件来实现。

                                               

                                                  

                                                                 上面总结性描述，来源于网络资源

项目中的运用:

private BackgroundWorker worker = new BackgroundWorker();

      

        private void InitBackWorker()

        {

            worker.WorkerReportsProgress = true;

            worker.DoWork += new DoWorkEventHandler(worker_DoWork);

            worker.ProgressChanged += new ProgressChangedEventHandler(worker_ProgressChanged);

            worker.RunWorkerCompleted += new RunWorkerCompletedEventHandler(worker_RunWorkerCompleted);

        }

 

        void worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)

        {

            this.Dispatcher.Invoke(DispatcherPriority.Normal, new function(HideRollerBuoy));

            worker.CancelAsync();

        }

 

        void HideRollerBuoy()

        {

            this.rollerBuoy.Visibility = Visibility.Hidden;

        }

 

        void worker_ProgressChanged(object sender, ProgressChangedEventArgs e)

        {

 

            List listState = e.UserState as List;

            string buoyCode = listState[0];

            string AccessSourceTabName = listState[1];

            string newestTime = listState[2];

            int inserted = Convert.ToInt32(listState[3]);

 

            #region 更新前台显示的状态表

 

            bool exist = false;

            bool existAccessTabName = false;

            for (int j = 0; j < this.BuoyAcceptStateTab.Rows.Count; j++)

            {

                if (AccessSourceTabName == this.BuoyAcceptStateTab.Rows[j].ItemArray[1].ToString())

                {

                    existAccessTabName = true;

                }

 

                if (this.BuoyAcceptStateTab.Rows[j].ItemArray[0].ToString() == buoyCode && this.BuoyAcceptStateTab.Rows[j].ItemArray[1].ToString() == AccessSourceTabName)

                {

                    exist = true;

                    this.BuoyAcceptStateTab.Rows[j][2] = this.DateFormatChange(newestTime);

                    int InsertCount = Convert.ToInt16(this.BuoyAcceptStateTab.Rows[j].ItemArray[3].ToString());

                    InsertCount = InsertCount + inserted;

                    this.BuoyAcceptStateTab.Rows[j][3] = InsertCount.ToString();

                }

            }

 

            if (!exist)

            {

                #region 插入新纪录

                DataRow newRow = this.BuoyAcceptStateTab.NewRow();

                newRow[0] = buoyCode;

                newRow[1] = AccessSourceTabName;

                newRow[2] = this.DateFormatChange(newestTime);

                newRow[3] = inserted;

                this.BuoyAcceptStateTab.Rows.Add(newRow);

                #endregion

            }

 

            if (!existAccessTabName)

            {

                #region  添加新的 RadioButton

                asdf = AccessSourceTabName ;

                this.Dispatcher.Invoke(DispatcherPriority.Normal, new function(CreateRadioBtnOfBuoy));

                //RadioButton radioBtn = new RadioButton();

                //radioBtn.Content = AccessSourceTabName;

                //radioBtn.VerticalAlignment = VerticalAlignment.Center;

                //radioBtn.Checked += new RoutedEventHandler(radioBtn_Checked);

                //this.stkBuoyAcceptView.Children.Add(radioBtn);

                #endregion

            }

 

            #endregion

 

            #region 记录日志

            string item = System.DateTime.Now.ToString("HH:mm:ss") + "  " + buoyCode + "  接收了 " + inserted + " 条" + AccessSourceTabName + "型数据";

            //Notes note = new Notes(item);

            //if (this.listBuoyLog.Count >= 300)

            //{

            //    this.listBuoyLog.RemoveAt(0);

            //}

            //this.listBuoyLog.Add(note);

            log = item;

            this.Dispatcher.Invoke(DispatcherPriority.Normal, new function(ShowLog));

            LogManage logManage = new LogManage();

            logManage.WriteBuoyLog(buoyCode, inserted.ToString(), AccessSourceTabName);

 

            #endregion

        }

 

        private delegate void function();

 

        string asdf = "";

        string log = "";

        private void CreateRadioBtnOfBuoy()

        {

            RadioButton radioBtn = new RadioButton();

            //radioBtn.Content = AccessSourceTabName;

            radioBtn.Content = asdf;

            radioBtn.VerticalAlignment = VerticalAlignment.Center;

            radioBtn.Checked += new RoutedEventHandler(radioBtn_Checked);

            this.stkBuoyAcceptView.Children.Add(radioBtn);

 

           

 

        }

 

        private void ShowLog()

        {

            Notes note = new Notes(log);

            if (this.listBuoyLog.Count >= 300)

            {

                this.listBuoyLog.RemoveAt(0);

            }

            this.listBuoyLog.Add(note);

        }

 

        private ObservableCollection listBuoyLog = new ObservableCollection();

 

        void radioBtn_Checked(object sender, RoutedEventArgs e)

        {

            string accessTabName = (sender as RadioButton).Content.ToString();

            DataTable newTab = new DataTable();

            newTab.Columns.Add("浮标号");

            newTab.Columns.Add("接收量");

 

            for (int i = 0; i < this.BuoyAcceptStateTab.Rows.Count; i++)

            {

                if (this.BuoyAcceptStateTab.Rows[i].ItemArray[1].ToString() == accessTabName)

                {

                    DataRow newRow = newTab.NewRow();

                    newRow[0] = this.BuoyAcceptStateTab.Rows[i].ItemArray[0].ToString();

                    newRow[1] = this.BuoyAcceptStateTab.Rows[i].ItemArray[3].ToString();

                    newTab.Rows.Add(newRow);

                }

            }

 

            // 出图

        }

 

        void worker_DoWork(object sender, DoWorkEventArgs e)

        {

            this.RefreshBuoyData();

        }

 

 

特别说明:   Dowork()为后台执行的内容,当需要反馈给前台时则ReportProcess.在ProcessChanged事件得到响应.

   若需要修改主线程的UI要素,则需要用主线程去调用.明显,BackGroundWork只是优化后的新线程,与主线程异步.

   这时候,我们可以通过委托解决调用主线程来实现,具体参考上面给出的实例代码.