c# - 将 Backgroundworker 重构为异步/等待

Question

我一直使用 Backgroundworker 并且我对 async/await 关键字不熟悉。现在我正在尝试将一些代码从 Backgroundworker 重构为 async/await(这是一个 WPF MVVM 应用程序)。

我的虚拟机中有一个命令，它是这样实例化的:

GenerateCommand = new DelegateCommand(GenerateHandler, CanGenerate);

我看到在 dev express 库中有一个“AsyncCommand”，它可能适合我。

所有处理程序所做的就是向已完成的事件注册一个事件处理程序并调用服务上的生成方法。

private void GenerateHandler()
{
  generatorService.GenerationFinished += OnGenerationFinished;
  generatorService.Generate(mDataFields, mGenerateFilesViewModel, mAmount);      
}

然后服务的Generate方法启动一个BackGroundWorker:

public void Generate(IEnumerable<IDataField> dataFields, IGenerateFilesViewModel generateFilesViewModel, int amount)
{
  BackgroundWorker worker = new BackgroundWorker();
  worker.DoWork += worker_DoWork;
  worker.RunWorkerAsync();
}

DoWork 方法完成耗时任务

private void worker_DoWork(object sender, DoWorkEventArgs e)
{
  GenerateCommand generateCommand = null;
  if (mUploadFiles)
  {
    generateCommand = new GenerateCommand(mDataFields, mOutputDirectory, mTemplateFileName, mAmount, mSelectedCollection, mSelectedAccountKey);
  }
  else
  {
    generateCommand = new GenerateCommand(mDataFields, mOutputDirectory, mTemplateFileName, mAmount);
  }

  try
  {
    generateCommand.Execute();
  }
  catch (SEHException ex)
  {
    Console.WriteLine(String.Format("Generation of files threw an exception. {0}", ex.Message));
  }
}

我不确定我现在必须用 async 关键字标记哪个方法以及我必须在哪里等待我的异步方法。我尝试将 worker_DoWork 标记为异步并等待 Generate 方法中的调用，但随后 Generate 方法也必须标记为异步才能在虚拟机的 GenerateHandler 中等待？

对不起，如果我让你感到困惑，但这一切让我有点困惑......

感谢帮助

Answer 1

async/await 语法糖的好处之一是编码方便 - 您可以编写真正的异步方法，就像通常编写同步方法一样。

这里有 worker_DoWork重载和OnGenerationFinished最后的方法。所以你的 GenerateHandler可以看起来像这样:

private async void GenerateHandler()
{
    await Task.Run(() => worker_DoWork());

    OnGenerationFinished();
}

如果您的 OnGenerationFinished方法逻辑不直接更改任何 UI 元素，您可以使用 ConfigureAwait 进一步卸载 UI 线程:

await Task.Run(() => worker_DoWork()).ConfigureAwait(false);

在这里我展示了这个想法，没有考虑你的特殊generatorService实现。您最终的实现可能不会完全相同。

一些注意事项:

通常 async 方法应该返回 Task或 Task<T> , 但一旦 GenerateHandler实际上是命令的处理程序，在这种情况下返回类型是 void 是正常的。

这个例子是如何工作的(简单来说):

在 GenerateHandler 之后在 UI 线程中调用，Task.Run将委托(delegate)worker_DoWork处理线程池中的线程，因此 UI 线程保持空闲以响应 UI 事件。

await 关键字的作用:在 Task.Run 之后在线程池中创建任务，它只是从 GenerateHandler 返回.但它会记住方法的其余部分(在这种情况下为 OnGenerationFinished)和当前同步上下文(在这种情况下为 UI 线程)，其中方法的其余部分将在 worker_DoWork 之后处理。将完成工作。

但是如果您不需要 OnGenerationFinished 的 UI 线程处理，你可以告诉 await 不要使用当前同步上下文来调用方法的其余部分，这就是 ConfigureAwait(false)为了。在那种情况下 OnGenerationFinished将在线程池的另一个线程中执行，允许 UI 线程不会分散非 UI 作业的注意力。