Task<> 对象上的 C# async/await Progress 事件

Question

我对 C# 5 的新 async/await 关键字完全陌生，我对实现进度事件的最佳方式感兴趣。

现在，如果 Progress 事件发生在 Task<> 本身上，我会更喜欢它。我知道我可以将事件放在包含异步方法的类中，并在事件处理程序中传递某种状态对象，但对我来说，这似乎更像是一种解决方法而不是解决方案。我可能还希望不同的任务在不同的对象中触发事件处理程序，这样听起来很混乱。

有没有办法我可以做类似以下的事情？：

var task = scanner.PerformScanAsync();
task.ProgressUpdate += scanner_ProgressUpdate;
return await task;

Answer 1

简单地说，Task 不支持进度。但是，已经有一种传统的方法可以做到这一点，使用IProgress<T> 接口。 Task-based Asynchronous Pattern 基本上建议重载您的异步方法（在有意义的地方）以允许客户端传入 IProgress<T> 实现。然后，您的 async 方法将通过它报告进度。

Windows 运行时 (WinRT) API确实在 IAsyncOperationWithProgress<TResult, TProgress> 和 IAsyncActionWithProgress<TProgress> 类型中内置了进度指示器...因此，如果您实际上是为 WinRT 编写代码，那么这些是值得研究 - 但也请阅读下面的 cmets。

Answer 2

Task-based Asynchronous Pattern 文档中描述了推荐的方法，该文档为每个异步方法提供了自己的IProgress<T>：

public async Task PerformScanAsync(IProgress<MyScanProgress> progress)
{
  ...
  if (progress != null)
    progress.Report(new MyScanProgress(...));
}

用法：

var progress = new Progress<MyScanProgress>();
progress.ProgressChanged += ...
PerformScanAsync(progress);

注意事项：

1. 按照惯例，如果调用者不需要进度报告，progress 参数可能是 null，因此请务必在您的 async 方法中检查这一点。
2. 进度报告本身是异步的，因此您应该在每次调用时创建一个新的参数实例（更好的是，只需为事件参数使用不可变类型）。您应该不发生变异，然后重复使用相同的参数对象来多次调用Progress。
3. Progress<T> 类型将在构造时捕获当前上下文（例如 UI 上下文），并将在该上下文中引发其 ProgressChanged 事件。因此，在调用 Report 之前，您不必担心会封送回 UI 线程。

Answer 3

我不得不从几篇帖子中拼凑出这个答案，因为我试图弄清楚如何使这个工作适用于不那么琐碎的代码（即事件通知更改）。

假设您有一个同步项目处理器，它将宣布即将开始工作的项目编号。在我的示例中，我只是要操作 Process 按钮的内容，但您可以轻松更新进度条等。

private async void BtnProcess_Click(object sender, RoutedEventArgs e)
{       
    BtnProcess.IsEnabled = false; //prevent successive clicks
    var p = new Progress<int>();
    p.ProgressChanged += (senderOfProgressChanged, nextItem) => 
                    { BtnProcess.Content = "Processing page " + nextItem; };

    var result = await Task.Run(() =>
    {
        var processor = new SynchronousProcessor();

        processor.ItemProcessed += (senderOfItemProcessed , e1) => 
                                ((IProgress<int>) p).Report(e1.NextItem);

        var done = processor.WorkItWorkItRealGood();

        return done ;
    });

    BtnProcess.IsEnabled = true;
    BtnProcess.Content = "Process";
}

其中的关键部分是关闭ItemProcessed 订阅中的Progress<> 变量。这让一切都可以Just works ™。

Answer 4

当使用 Task.Run lambda 时，我在其中使用了 Invoke Action 来更新 ProgressBar 控件。这可能不是最好的方法，但它在紧要关头工作，无需重组任何东西。

   Invoke(new Action(() =>

               {
                   LogProgress();
               }));

它需要...

        private void LogProgress()
        {       
          progressBar1.Value = Convert.ToInt32((100 * (1.0 * LinesRead / TotalLinesToRead)));
        }