c# BackgroundWorker使用方法

在 winforms 中，有时要执行耗时的操作，在该操作未完成之前操作用户界面，会导致用户界面停止响应。解决的方法就是新开一个线程，把耗时的操作放到线程中执行，这样就可以在用户界面上进行其它操作。新建线程可以用 thread 类，可以实现多线程同时操作。简单的方法可以通过 backgroundworker 类实现。

backgroundworker 可以用来更新ui界面，但是通常用来progressbar（进度条）控件

例如更新ui

private void form1_load(object sender, eventargs e)
{
   this.backgroundworker1.runworkerasync();
}
private void backgroundworker1_runworkercompleted(object sender, runworkercompletedeventargs e)
{
    this.textbox1.text = "ui";
}

用 backgroundworker 类执行耗时的操作

backgroundworker 类在 system.componentmodel 命名空间下。
vs 的工具箱时有一个 backgroundworker 组件，就是这个类。

backgroundwork主要的事件及参数：

        1.dowork——当执行backgroundworker.runworkerasync方法时会触发该事件，并且传递doworkeventargs参数;

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

        3.progresschanged——操作处理中获得的处理状态变化，通过backgroundworker.reportprogress(int)方法触发该事件，并且传递progresschangedeventargs,其中包含了处理的百分比,这个参数在ui界面上设置progressbar控件。  

backgroundwork主要的方法：

        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组件

重要属性：

    1、cancellationpending         获取一个值，指示应用程序是否已请求取消后台操作。通过在dowork事件中判断cancellationpending属性可以认定是否需要取消后台操作（也就是结束线程）；

    2、 workerreportsprogress ：获取或设置一个值，该值指示backgroundworker能否报告进度更新

重要方法：

    1、cancelasync         请求取消挂起的后台操作

    2、runworkerasync      开始执行后台操作

    3、reportprogress      引发progresschanged事件 

重要事件：  

    1、dowork              调用 runworkerasync 时发生

    2、progresschanged     调用 reportprogress 时发生

    3、runworkercompleted  当后台操作已完成、被取消或引发异常时发生

    另外还有三个重要的参数是runworkercompletedeventargs以及doworkeventargs、progresschangedeventargs。

例子：

using system;
using system.collections.generic;
using system.componentmodel;
using system.data;
using system.drawing;
using system.linq;
using system.text;
using system.threading;
using system.threading.tasks;
using system.windows.forms;

namespace delegate3
{
  public partial class form1 : form
  {

    public form1()
    {
      initializecomponent();
    }
    
    private void button1_click(object sender, eventargs e)
    {
      //启动异步调用方法
      //调用runworkerasync()方法，会触发dowork事件
      this.backgroundworker2.runworkerasync();
    }

    private void backgroundworker2_dowork(object sender, doworkeventargs e)
    {
      backgroundworker2.workerreportsprogress = true;
      for (int i = 1; i <= 100; i++)
      {
        //这里判断一下是否用户要求取消后台进行，并可以尽早退出。
        //可以通过调用cancelasync方法设置cancellationpending的值为false
        if (backgroundworker2.cancellationpending)
        {
          backgroundworker2.reportprogress(i, string.format("{0}%,操作被用户申请中断", i));
        }

        //调用 reportprogress 方法，会触发progresschanged事件
        backgroundworker2.reportprogress(i, string.format("{0}%", i));
        system.threading.thread.sleep(10);
      }
    }

    private void backgroundworker2_progresschanged(object sender, progresschangedeventargs e)
    {
      this.progressbar1.value = e.progresspercentage;
      this.label1.text = e.userstate.tostring();
      this.label1.update();
    }

    private void backgroundworker2_runworkercompleted(object sender, runworkercompletedeventargs e)
    {
      //这是结束后做的事情
      messagebox.show("完成");
    }
  }
}

以上就是c# backgroundworker使用方法的详细内容，更多关于c# backgroundworker用法的资料请关注其它相关文章！