BackgroundWprker 配合ProcessBar 实现实时更新界面UI 状态

最新推荐文章于 2023-02-22 16:17:23 发布

Ru_Tesla

最新推荐文章于 2023-02-22 16:17:23 发布

阅读量213

点赞数

分类专栏： wpf 文章标签： ui java c# Powered by 金山文档

本文链接：https://blog.csdn.net/Ru_Tesla/article/details/129087062

版权

wpf 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

首先在窗体的构造函数里加入这些事件，属性，后面再细致讲解

  public partial class WindowDisInflect : Window //窗体
  {

 public WindowDisInflect()
        {
            InitializeComponent();
             //在构造函数里添加以下代码，打开该窗口的时候就加载以下代码

            //DoWork 用于后台数据处理的主要过程，并在必要时候汇报进度（ReportProgress）；
            //ProgressChanged 用于在 DoWork 汇报进度时决定做什么；
            //RunWorkerCompleted 用于在 DoWork 结束时执行后续的处理或显示等工作
            BackgroundWorker1 = new BackgroundWorker();
            BackgroundWorker1.DoWork += this.BackgroundWorker1_DoWork;
            BackgroundWorker1.RunWorkerCompleted += backgroundWorker1_RunWorkerCompleted;
            BackgroundWorker1.WorkerReportsProgress = true;
            BackgroundWorker1.WorkerSupportsCancellation = true;
            BackgroundWorker1.ProgressChanged += BackgroundWorker1_ProgressChanged;
        }
   }

BackgroundWorker类允许您在单独的线程上执行某个可能导致用户界面（UI）停止响应的耗时操作（比如文件下载数据库事务等），并且想要一个响应式的UI来反应当前耗时操作的进度。

可以看的出来，BackgroundWorker组件提供了一种执行异步操作（后台线程）的同时，并且还能妥妥的显示操作进度的解决方案。于是乎，我便深入的了解了一下BackgroundWorker类。针对BackgroundWorker类的部分重要属性和方法进行了一次总结。

属性：

WorkerReportsProgress

bool类型，指示BackgroundWorker是否可以报告进度更新。当该属性值为True是，将可以成功调用ReportProgress方法，否则将引发InvalidOperationException异常。

用法：

private BackgroundWorker bgWorker = new BackgroundWorker();
bgWorker.WorkerReportsProgress = true;

WorkerSupportsCancellation

bool类型，指示BackgroundWorker是否支持异步取消操作。当该属性值为True是，将可以成功调用CancelAsync方法，否则将引发InvalidOperationException异常，调用CancelAsync（）方法可取消dowork的线程。

bgWorker.WorkerSupportsCancellation = true;

CancellationPending
bool类型，指示应用程序是否已请求取消后台操作。此属性通常放在用户执行的异步操作内部，用来判断用户是否取消执行异步操作。当执行BackgroundWorker.CancelAsync()方法时，该属性值将变为True。在DoWorkS事件中加入以下代码
用法：


//以下事件处理器订阅了 DoWork 事件
  private void BackgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
        {
            try
            {
                Server8Chan.API_DisinfectIO_OutPut(1, true); //channel 控制启动消毒 2023.02.16
                int TotalMinutes = 1;//修改该值可以修改消毒时间
                int CurSeconds = 0;
                int curSec = 0;
                
                while (!isstop)
                {
                    if (BackgroundWorker1.CancellationPending == true)
                    {
                        e.Cancel = true;
                        isstop = true;
                        cancel = true;
                        return;
                    }
                    else
                    {
                        Thread.Sleep(1000); //停止一秒
                        curSec += 1;
                        CurSeconds = curSec;
                        int per = (int)((CurSeconds * 1.0f / (TotalMinutes * 60)) * 100);
                        BackgroundWorker1.ReportProgress(per);
                        if (CurSeconds >= TotalMinutes * 60)
                        {
                            e.Cancel = true;
                            isstop = true;
                            return;
                        }
                    }

                }
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
        }

IsBusy

bool类型，指示BackgroundWorker是否正在执行一个异步操作。此属性通常放在BackgroundWorker.RunWorkerAsync()方法之前，避免多次调用RunWorkerAsync()方法引发异常。当执行BackgroundWorker.RunWorkerAsync()方法是，该属性值将变为True。

用法：

这里放在Loded 事件里，当窗体加载的时候会触发load事件，当然触发load事件之前还是会先运行最上面构造函数里面的程序

 private void Grid_Loaded(object sender, RoutedEventArgs e)
        {
            if (!this.BackgroundWorker1.IsBusy)
            {
                this.BackgroundWorker1.RunWorkerAsync();
            }
        }

下面介绍几个方法：

1，

RunWorkerAsync()

开始执行一个后台操作。调用该方法后，将触发BackgroundWorker.DoWork事件，并以异步的方式执行DoWork事件中的代码。

该方法还有一个带参数的重载方法：RunWorkerAsync(Object)。该方法允许传递一个Object类型的参数到后台操作中，并且可以通过DoWork事件的DoWorkEventArgs.Argument属性将该参数提取出来。

注：当BackgroundWorker的IsBusy属性为True时，调用该方法将引发InvalidOperationException异常。

用法：

  private void Grid_Loaded(object sender, RoutedEventArgs e)
        {
            if (!this.BackgroundWorker1.IsBusy)
            {
                this.BackgroundWorker1.RunWorkerAsync();
            }
        }

2，

ReportProgress(Int percentProgress)

报告操作进度。调用该方法后，将触发BackgroundWorker. ProgressChanged事件。另外，该方法包含了一个int类型的参数percentProgress，用来表示当前异步操作所执行的进度百分比。

该方法还有一个重载方法：ReportProgress(Int percentProgress, Object userState)。允许传递一个Object类型的状态对象到 ProgressChanged事件中，并且可以通过ProgressChanged事件的ProgressChangedEventArgs.UserState属性取得参数值。

注：调用该方法之前需确保WorkerReportsProgress属性值为True，否则将引发InvalidOperationException异常。

用法：

 int per = (int)((CurSeconds * 1.0f / (TotalMinutes * 60)) * 100);
                        BackgroundWorker1.ReportProgress(per); 传入int类型 
                        if (CurSeconds >= TotalMinutes * 60)
                        {
                            e.Cancel = true;
                            isstop = true;
                            return;
                        }

3，CancelAsync();

请求取消挂起的后台操作，即取消dowork 事件订阅的 BackgroundWorker1_DoWork（）方法。

请求取消当前正在执行的异步操作。调用该方法将使BackgroundWorker.CancellationPending属性设置为True。

但需要注意的是，并非每次调用CancelAsync()都能确保异步操作，CancelAsync()通常不适用于取消一个紧密执行的操作，更适用于在循环体中执行。

用法：

  private void btnCancel_Click(object sender, RoutedEventArgs e)
        {
            Server8Chan.API_DisinfectIO_OutPut(1, false); //channel 控制启动消毒 2023.02.16
            BackgroundWorker1.CancelAsync();
            this.Close();
        }

事件：

DoWork

用于承载异步操作。当调用BackgroundWorker.RunWorkerAsync()时触发。

需要注意的是，由于DoWork事件内部的代码运行在非UI线程之上，所以在DoWork事件内部应避免于用户界面交互，而于用户界面交互的操作应放置在ProgressChanged和RunWorkerCompleted事件中。

代码示例：

 private void BackgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
        {
            try
            {
                Server8Chan.API_DisinfectIO_OutPut(1, true); //channel 控制启动消毒 2023.02.16
                int TotalMinutes = 1;//修改该值可以修改消毒时间
                int CurSeconds = 0;
                int curSec = 0;
                
                while (!isstop)
                {
                    if (BackgroundWorker1.CancellationPending == true)
                    {
                        e.Cancel = true;
                        isstop = true;
                        cancel = true;
                        return;
                    }
                    else
                    {
                        Thread.Sleep(1000); //停止一秒
                        curSec += 1;
                        CurSeconds = curSec;
                        int per = (int)((CurSeconds * 1.0f / (TotalMinutes * 60)) * 100);
                        BackgroundWorker1.ReportProgress(per);
                        if (CurSeconds >= TotalMinutes * 60)
                        {
                            e.Cancel = true;
                            isstop = true;
                            return;
                        }
                    }

                }
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
        }

ProgressChanged

当调用BackgroundWorker.ReportProgress(int percentProgress)方式时触发该事件。

该事件的ProgressChangedEventArgs.ProgressPercentage属性可以接收来自ReportProgress方法传递的percentProgress参数值,ProgressChangedEventArgs.UserState属性可以接收来自ReportProgress方法传递的userState参数。

代码示例：

  private void BackgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
        {
            ProBar1.Value = e.ProgressPercentage;//这里的ProBar1为ProgressBar的Name，

         
        }

RunWorkerCompleted

异步操作完成或取消时执行的操作，当调用DoWork事件执行完成时触发。

该事件的RunWorkerCompletedEventArgs参数包含三个常用的属性Error,Cancelled,Result。其中，Error表示在执行异步操作期间发生的错误；Cancelled用于判断用户是否取消了异步操作；Result属性接收来自DoWork事件的DoWorkEventArgs参数的Result属性值，可用于传递异步操作的执行结果。

用法：

代码示例：

 private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
            Server8Chan.API_DisinfectIO_OutPut(1,false); //channel 控制停止消毒 2023.02.16
         
            this.Close();
            //下面写入强制自动关机的代码
            try
            {
                Process process = new Process();
                process.StartInfo.FileName = "shutdown";
                process.StartInfo.Arguments = "-s -t 0";
                if (isstop == true)
                {
                    if (cancel !=true)
                    {
                        process.Start();
                    }
                }
              
               
            }
            catch (Exception)
            {

                MessageBox.Show("自动关机失败，请手动关机");
            }

        }

Ru_Tesla

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
BackgroundWprker 配合ProcessBar 实现实时更新界面UI 状态

可以看的出来，BackgroundWorker组件提供了一种执行异步操作（后台线程）的同时，并且还能妥妥的显示操作进度的解决方案。需要注意的是，由于DoWork事件内部的代码运行在非UI线程之上，所以在DoWork事件内部应避免于用户界面交互，而于用户界面交互的操作应放置在ProgressChanged和RunWorkerCompleted事件中。但需要注意的是，并非每次调用CancelAsync()都能确保异步操作，CancelAsync()通常不适用于取消一个紧密执行的操作，更适用于在循环体中执行。
复制链接

扫一扫