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控件。   this

   
 主要的方法:
         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该方法才可用)。spa

BackgroundWorker组件
在VS2005中添加了BackgroundWorker组件,该组件在多线程编程方面使用起来很是方便,然而在开始时因为没有搞清楚它的使用机制,走了很多的弯路,如今把我在使用它的过程当中的经验与诸位分享一下。
    BackgroundWorker类中主要用到的有这列属性、方法和事件:
    重要属性:
    一、CancellationPending             获取一个值,指示应用程序是否已请求取消后台操做。经过在DoWork事件中判断CancellationPending属性能够认定是否须要取消后台操做(也就是结束线程);
    二、IsBusy                          获取一个值,指示 BackgroundWorker 是否正在运行异步操做。程序中使用IsBusy属性用来肯定后台操做是否正在使用中;
    三、WorkerReportsProgress           获取或设置一个值,该值指示BackgroundWorker可否报告进度更新
    四、WorkerSupportsCancellation      获取或设置一个值,该值指示 BackgroundWorker 是否支持异步取消。设置WorkerSupportsCancellation为true使得程序能够调用CancelAsync方法提交终止挂起的后台操做的请求;
    重要方法:
    一、CancelAsync         请求取消挂起的后台操做
    二、RunWorkerAsync      开始执行后台操做
    三、ReportProgress      引起ProgressChanged事件  
    重要事件:
    一、DoWork              调用 RunWorkerAsync 时发生
    二、ProgressChanged     调用 ReportProgress 时发生
    三、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事件来实现。


在WinForm中常常遇到一些费时的操做界面,好比统计某个磁盘分区的文件夹或者文件数目,若是分区很大或者文件过多的话,处理很差就会形成“假死”的状况,或者报“线程间操做无效”的异常,为了解决这个问题,可使用委托来处理,在.net2.0中还能够用BackgroundWorker类。

BackgroundWorker类是.net 2.0里新增长的一个类,对于须要长时间操做而不须要用户长时间等待的状况可使用这个类。
注意确保在 DoWork 事件处理程序中不操做任何用户界面对象。而应该经过 ProgressChanged 和 RunWorkerCompleted 事件与用户界面进行通讯。 
 
 
public  partial  class  MainWindow : Window
     {
 
         private  BackgroundWorker m_BackgroundWorker; // 申明后台对象
 
         public  MainWindow()
         {
             InitializeComponent();
 
             m_BackgroundWorker = new  BackgroundWorker(); // 实例化后台对象
 
             m_BackgroundWorker.WorkerReportsProgress = true ; // 设置能够通告进度
             m_BackgroundWorker.WorkerSupportsCancellation = true ; // 设置能够取消
 
             m_BackgroundWorker.DoWork += new  DoWorkEventHandler(DoWork);
             m_BackgroundWorker.ProgressChanged += new  ProgressChangedEventHandler(UpdateProgress);
             m_BackgroundWorker.RunWorkerCompleted += new  RunWorkerCompletedEventHandler(CompletedWork);
 
             m_BackgroundWorker.RunWorkerAsync( this );
         }
 
 
         void  DoWork( object  sender, DoWorkEventArgs e)
         {
             BackgroundWorker bw = sender as  BackgroundWorker;
             MainWindow win = e.Argument as  MainWindow;
 
             int  i = 0;
             while  ( i <= 100 )
             {
                 if  (bw.CancellationPending)
                 {
                     e.Cancel = true ;
                     break ;
                 }
 
                 bw.ReportProgress(i++);
     
                 Thread.Sleep(1000);
 
             }
         }
 
         void  UpdateProgress( object  sender, ProgressChangedEventArgs e)
         {
             int  progress = e.ProgressPercentage;
 
             label1.Content = string .Format( "{0}" ,progress);
         }
 
 
         void  CompletedWork( object  sender, RunWorkerCompletedEventArgs e)
         {
             if  ( e.Error != null )
             {
                 MessageBox.Show( "Error" );
             }
             else  if  (e.Cancelled)
             {
                 MessageBox.Show( "Canceled" );
             }
             else
             {
                 MessageBox.Show( "Completed" );
             }
         }
 
 
         private  void  button1_Click( object  sender, RoutedEventArgs e)
         {
             m_BackgroundWorker.CancelAsync();
         }
     }
相关文章
相关标签/搜索