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

    明白了BagkgroundWorker的事件调用顺序和参数传递机制之后在使用该组件用于多线程编程的时候就可以轻松许多了。

//我们假设获取的记录数固定,我们为此定义一个常量:
        private static int MaxRecords = 100;
        private void Form1_Load(object sender, EventArgs e)
        {
        }
        /// <summary>
        /// 开始
        /// </summary>
        private void button1_Click(object sender, EventArgs e)
        {
            if (this.backgroundWorker1.IsBusy)
            {
                MessageBox.Show("正在执行");
                return;
            }
            this.textBox1.Clear();
            //当Start按钮被点击后,RunWorkerAsync方法被掉调用,我们定义的常量(MaxRecords )当作参数被掺入。
            //随后,将会触发其DoWork事件
            this.backgroundWorker1.RunWorkerAsync(MaxRecords);
            this.button1.Enabled = false;
            this.button2.Enabled = true;
        }
        private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
        {
            try
            {
                //调用RetrieveData方法逐条获取数据
                e.Result = this.RetrieveData(this.backgroundWorker1, e);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
                throw;
            }
        }
        private int RetrieveData(BackgroundWorker worker, DoWorkEventArgs e)
        {
            int maxRecords = (int)e.Argument;
            int percent = 0;
            for (int i = 1; i <= maxRecords; i++)
            {
                if (worker.CancellationPending)
                {
                    return i;
                }
                percent = (int)(((double)i / (double)maxRecords) * 100);
                worker.ReportProgress(percent, new KeyValuePair<int, string>(i, Guid.NewGuid().ToString()));
                System.Threading.Thread.Sleep(100);
            }
            return maxRecords;
        }
        //这些操作需要操作UI上的控件,只能在Main Thread中进行。
        //如果在RetrieveData方法进行的话,由于该方式是一个异步方法,是会抛出异常的
        private void backgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
        {
            KeyValuePair<int, string> record = (KeyValuePair<int, string>)e.UserState;
            this.label1.Text = string.Format("There are {0} records retrieved!", record.Key);
            this.progressBar1.Value = e.ProgressPercentage;
            this.textBox1.AppendText(record.Value+"\r\n");
        }
        private void button2_Click(object sender, EventArgs e)
        {
            this.backgroundWorker1.CancelAsync();//请求结束后台操作
        }
        //如果操作正常地结束,BackgroundWorker的RunWorkerCompleted会被触发
        private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
            try
            {
                this.label1.Text = string.Format("Total records: {0}", e.Result);
                this.button1.Enabled = true;
                this.button2.Enabled = false;
            }
            catch (TargetInvocationException ex)
            {
                MessageBox.Show(ex.InnerException.GetType().ToString());
            }
        }


  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
WinForm BackgroundWorker是一个用于多线程处理的类。它主要用于在WinForm应用程序中执行长时间运行的任务,以避免阻塞主线程,使应用程序更加流畅和响应。 BackgroundWorker内置了几个关键事件:DoWork,ProgressChanged和RunWorkerCompleted。DoWork事件是用于执行后台工作的地方,我们可以在这个事件中编写长时间运行的代码。ProgressChanged事件用于向主线程报告后台工作的进度,可以在其中更新UI。RunWorkerCompleted事件在后台工作完成后触发,可以在其中处理后台工作完成后的逻辑。 通过BackgroundWorker,我们可以方便地实现异步任务的执行和UI更新,另外它还提供了一些属性和方法,如CancellationPending属性可以用于取消后台任务,ReportProgress方法用于报告后台任务的进度。 在使用BackgroundWorker时,我们需要注意一些问题。首先,长时间运行的任务应该放在DoWork事件中,以避免阻塞主线程。在DoWork事件中,我们可以通过e.Argument属性获取传递给后台任务的参数,通过e.Result属性返回后台任务的结果。 其次,使用ReportProgress方法来报告后台任务的进度,以便在ProgressChanged事件中更新UI。此外,我们还可以使用取消操作来停止后台任务的执行,可以在DoWork事件中检查CancellationPending属性来判断是否需要取消任务。 WinForm BackgroundWorker作为一个强大的多线程处理类,大大简化了多线程编程的复杂性,提供了方便的接口来执行长时间运行的任务,并且保持界面的响应性。它在传统的WinForm应用程序中具有广泛的应用,使得我们可以轻松实现后台任务的执行和UI的更新。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值