C#中backgroundworker的使用

介绍：

根据MSDN介绍：
BackgroundWorker 类允许您在单独的专用线程上运行操作。耗时的操作（如下载和数据库事务）在长时间运行时可能会导致用户界面 (UI) 似乎处于停止响应状态。如果您需要能进行响应的用户界面，而且面临与这类操作相关的长时间延迟，则可以使用 BackgroundWorker 类方便地解决问题。
若要在后台执行耗时的操作，请创建一个 BackgroundWorker，侦听那些报告操作进度并在操作完成时发出信号的事件。可以通过编程方式创建 BackgroundWorker，也可以将它从“工具箱”的“组件”选项卡中拖到窗体上。如果在 Windows 窗体设计器中创建 BackgroundWorker，则它会出现在组件栏中，而且它的属性会显示在“属性”窗口中。
若要为后台操作做好准备，请添加 DoWork 事件的事件处理程序。在此事件处理程序中调用耗时的操作。若要开始此操作，请调用 RunWorkerAsync。若要收到进度更新的通知，请处理 ProgressChanged 事件。若要在操作完成时收到通知，请处理 RunWorkerCompleted 事件。

有2点需要注意的：
1、由于DoWork事件内部的代码运行在非UI线程之上,确保在 DoWork 事件处理程序中不操作任何用户界面对象。而应该通过 ProgressChanged 和 RunWorkerCompleted 事件与用户界面进行通信。

2、BackgroundWorker 事件不跨 AppDomain 边界进行封送处理。请不要使用 BackgroundWorker 组件在多个 AppDomain 中执行多线程操作。

使用:

运行显示：

1、声明一个BackgroundWorker

BackgroundWorker backgroundWorker1 = null;

2、初始化BackgroundWorker，设置属性并绑定事件

public Form1()
{
    InitializeComponent();
    backgroundWorker1 = new BackgroundWorker();
    backgroundWorker1.WorkerReportsProgress = true;//能否报告进度更新。
    backgroundWorker1.WorkerSupportsCancellation = true;//是否支持异步取消
    //绑定事件
    backgroundWorker1.DoWork += new DoWorkEventHandler(backgroundWorker1_DoWork);
    backgroundWorker1.ProgressChanged += new ProgressChangedEventHandler(backgroundWorker1_ProgressChanged);
    backgroundWorker1.RunWorkerCompleted += new RunWorkerCompletedEventHandler(backgroundWorker1_RunWorkerCompleted);
}

3、BackgroundWorker事件

DoWork事件

private void backgroundWorker1_DoWork(object sender, System.ComponentModel.DoWorkEventArgs e)
{    
    //句柄sender指向的就是该BackgroundWorker。

    //e.Argument 获取异步操作参数的值  
    //e.Cancel 是否应该取消事件
    //e.Result  获取或设置异步操作结果的值(在RunWorkerCompleted事件可能会使用到)
    object a = e.Argument;//获取RunWorkerAsync(object argument)传入的值
    BackgroundWorker worker = sender as BackgroundWorker;
           
    for (int i = 1; i <= 10; i++)
    {
        if (worker.CancellationPending == true)//在耗时操作中判断CancellationPending属性，如果为false则退出
        {
            e.Cancel = true;
            break;
        }
        else
        {
            // Perform a time consuming operation and report progress.
            System.Threading.Thread.Sleep(500);
            worker.ReportProgress(i * 10, "Object userState");// 将触发BackgroundWorker.ProgressChanged事件，向ProgressChanged报告进度
        }
    }
    e.Result = "结束";
}

RunWorkerCompleted事件：当DoWork事件处理完成之后，将会触发该事件。

private void backgroundWorker1_RunWorkerCompleted(object sender, System.ComponentModel.RunWorkerCompletedEventArgs e)
{
    //e.Cancelled指示异步操作是否已被取消
    //e.Error 指示异步操作期间发生的错误
    //e.Result 获取异步操作结果的值,即DoWork事件中，Result设置的值。
    if (e.Cancelled == true)
    {
        resultLabel.Text = "Canceled!";
    }
    else if (e.Error != null)
    {
        resultLabel.Text = "Error: " + e.Error.Message;
    }
    else
    {
        resultLabel.Text = e.Result.ToString();
    }
}

ProgressChanged事件:ProgressChanged事件处理程序的第二个参数e有一个ProgressPercentage属性，它就由 ReportProgress的第一个参数percentProgress来提供。这个参数一般用来报告该后台操作完成的进度，然后用 ProgressChanged的第二个参数e的ProgressPercentage属性来获取该进度信息。如果用户还想传递更多的信息，可以使用 ReportProgress的第二种重载，它的第二个参数userState将会传递给ProgressChanged事件的参数e的UserState属性。

private void backgroundWorker1_ProgressChanged(object sender, System.ComponentModel.ProgressChangedEventArgs e)
{
    //e.ProgressPercentage  获取异步操作进度的百分比
    resultLabel.Text = (e.ProgressPercentage.ToString() + "%");
    string state = (string)e.UserState;//接收ReportProgress方法传递过来的userState
}

4、按钮事件

 //开始按钮
private void btnStart_Click(object sender, EventArgs e)
{
    if (backgroundWorker1.IsBusy != true)//判断BackgroundWorker 是否正在运行异步操作。
    {
        // Start the asynchronous operation.
        backgroundWorker1.RunWorkerAsync("object argument");//启动异步操作，有两种重载。将触发BackgroundWorker.DoWork事件
    }
}

 //终止
private void btnEnd_Click(object sender, EventArgs e)
{
    if (backgroundWorker1.WorkerSupportsCancellation == true)
    {
        // Cancel the asynchronous operation.
        backgroundWorker1.CancelAsync(); //请求取消挂起的后台操作。调用该方法将使BackgroundWorker.CancellationPending属性设置为True。 
    }
}

C#中backgroundworker的使用

介绍：

使用:

猜你喜欢