报告 UI 线程的后台线程进度

Question

我想实现以下结果 - UI 线程注册我的耗时操作的进度更改事件，然后运行方法“DoOperationAsync()”。然后该操作将报告进度更改，但是：必须在 UI 线程上调用该事件，我无法实现。事件触发，但是当我尝试更新 UI 时，我需要使用 Dispatcher，因为事件是从执行操作的线程触发的。我不觉得我的库应该强迫开发人员提前思考并在任何地方使用调度程序。

基本上我想做BackgroundWorker 所做的事情。 BackgroundWorker 如何在创建它的线程上触发 ProgressChanged 事件？

Answer 1

如果您使用 .NET 4.5，您将可以访问最新版本的 TPL 更改，其中包括 IProgress<T> 接口及其具体实现 Progress<T>。该界面旨在支持两个异步任务之间的进度报告，特别是您所追求的后台到 UI 线程的报告。

接口本身很简单，将Report(T) 方法定义为将T 类型的进度更新传递给其他任务的机制。当您有一些进展要报告时，您调用该操作。如果您想传递百分比进度，可以将 0.1 传递给 IProgress<float> 实例以报告 10% 的进度。

private async Task BackgroundWorkAsync(IProgress<float> progress)
{
    ...

    progress.Report(0.1); // 10%

    ...

    progress.Report(1.0); // 100%
}

UI 线程应该创建具体的Progress<T> 实例并将其传递到后台任务的范围内。 Progress<T> 提供了一个可以订阅的 ProgressChanged 事件，但通常你将一个操作传递给构造函数，以便在每次更新进度时调用：

var progress = new Progress(value => // set progress bar);

await this.BackgroundWorkAsync(progress);

这是一个粗略的例子，但它展示了Progress<T> 如何根据上下文同步回调的魔力，在本例中是 UI 线程。

Answer 2

BackgroundWorker 使用 Event-based asynchronous pattern。

在内部，它使用class AsyncOperation 的实例来引发事件。

具体来说，它调用AsyncOperation.Post() 在适当的线程或上下文中引发事件。

你应该可以用你的库代码做到这一点。

Answer 3

很久以前，没有代码可以准确地记住我是如何做到的，但这是我所做工作的基础。在我创建后台工作人员的 UI 对象中，我还创建了一个在报告进度时触发的方法。然后，在后台工作程序中，我设置了可以读取并放入我的 UI 的公共属性。

public class myUIFormControlWhatever
{
   ...
   public void CallTheBackgroundWorker()
   {
      myBackgroundWorker bgw = new myBackgroundWorker();
      // attach "listening" when the background worker reports changes
      bgw.ProgressChanged += thisObjectShowChangedProgress;
      bgw.RunWorkerAsync();
   }

   protected void thisObjectShowChangedProgress( object sender, ProgressChangedEventArgs e )
   {
      this.SomeTextShownOnUI = ((myBackgroundWorker)sender).ExposedProperty;
   }
}


public class myBackgroundWorker : BackgroundWorker
{
   public myBackgroundWorker()
   {
      WorkerReportsProgress = true;
      // hook up internal to background worker any strings
      // you want to expose once reporting and any other listeners are out there.
      ProgressChanged += StatusUpdate;
   }

   protected void StatusUpdate( object sender, ProgressChangedEventArgs e )
   {
      // set property to what you want any other listeners to grab/display
      ExposedProperty = "something you are handling internally to background worker";
   }

   public string ExposedProperty
   { get; protected set; }

}

同样，这大部分来自内存，查找了我不记得签名的事件处理程序参数参数。因此，UI 创建了后台工作人员，但通过连接到“ProgressChanged”事件来监听任何报告的更改。因此，一旦后台工作人员完成工作，UI 组件就会通过查看可以从后台工作人员本身的“object sender”参数读取的可见属性来处理它自己的段。