如何在 C# 中使用 TPL 任务将工作编组到主线程而不导致死锁？

Question

我正在编写一个消耗资源的库，无论出于何种原因，API 的设计方式都是在不同的线程上引发事件，但 API 的调用必须在主线程上完成。

假设我尝试使用的 API 定义为（我将省略事件定义）：

public sealed class DodgyService
{
    public void MethodThatHasToBeCalledOnTheMainThread() { ... }
}

为了使用这个 API，我在我的库中添加了一个名为 Service（是的，非常原始的名称）的服务，它将创建一个新任务（当我指定一个从SynchronizationContext)。

这是我的实现：

public class Service
{
  private readonly TaskFactory _taskFactory;
  private readonly TaskScheduler _mainThreadScheduler;

  public Service(TaskFactory taskFactory, TaskScheduler mainThreadScheduler)
  {
      _taskFactory = taskFactory;
      _mainThreadScheduler = mainThreadScheduler;
  }

  // Assume this method can be called from any thread.
  // In this sample is called by the main thread but most of the time
  // the caller will be running on a background thread.
  public Task ExecuteAsync(string taskName)
  {
      return _taskFactory.StartNew(
          () => ReallyLongCallThatForWhateverStupidReasonHasToBeCalledOnMainThread(taskName),
          new CancellationToken(false), TaskCreationOptions.None, _mainThreadScheduler)
          .ContinueWith(task => Trace.TraceInformation("ExecuteAsync has completed on \"{0}\"...", taskName));
  }

  private void ReallyLongCallThatForWhateverStupidReasonHasToBeCalledOnMainThread(string taskName)
  {
      Trace.TraceInformation("Starting \"{0}\" really long call...", taskName);
      new DodgyService().MethodThatHasToBeCalledOnTheMainThread();
      Trace.TraceInformation("Finished \"{0}\" really long call...", taskName);
  }

}

现在，如果我（在主线程上）执行我的服务调用并尝试在主线程上等待，应用程序将进入死锁，因为主线程将等待已安排在主线程上执行的任务主线程。

如何在不阻塞整个进程的情况下将这些调用编组到主线程？

在某些时候，我想在创建新任务之前执行主线程的检测，但我不想破解这个。

对于任何感兴趣的人，我得到了一个要点 here，其中包含代码和一个显示该问题的 WPF 应用程序。

顺便说一句，该库必须在 .net framework 4.0 上编写

编辑！ 我按照Scott Chamberlain 提供的here 提供的建议解决了我的问题

Answer 1

因为主线程将等待任务

这是一个有保证的死锁。一个任务不能在主线程上执行，直到它空闲，运行调度程序循环（也就是泵送消息循环）。正是调度程序循环实现了让代码在特定线程上运行的魔力。然而，主线程不会空闲，它正在“等待任务”。所以任务不能完成，因为主线程不会空闲，主线程不能空闲，因为任务不会完成。死锁城市。

您必须重写代码，这样您的主线程就不会等待。将等待调用之后出现的任何代码移动到在主线程上运行的另一个任务，就像真正的LongCall()一样。

请注意，您似乎根本没有从使用任务中获得任何好处，您的 sn-p 建议 没有 重要的代码在工作线程上运行。所以你还不如直接调用它，也能解决问题。

Answer 2

来自您的示例程序：

  private void HandleClosed(object sender, EventArgs e)
  {
      var list = new[]
      {
          _service.ExecuteAsync("first task"),
          _service.ExecuteAsync("second task"),
          _service.ExecuteAsync("third task")
      };

      //uncommenting this line blocks all three previous activities as expected
      //as it drives the current main thread to wait for other tasks waiting to be executed by the main thread.

      //Task.WaitAll(list);
  }

Task.WaitAll是阻塞调用，不能在主线程上进行阻塞调用，否则会导致死锁。您可以做的（如果您使用的是 Visual Studio 2012 或更新版本）是使用 NuGet 包 Microsoft.Bcl.Async，它为 .Net 4.0 提供了 async/await 支持。

添加包后修改代码

private async void HandleClosed(object sender, EventArgs e)
{
    var list = new[]
  {
      _service.ExecuteAsync("first task"),
      _service.ExecuteAsync("second task"),
      _service.ExecuteAsync("third task")
  };

    //uncommenting this line blocks all three previous activities as expected
    //as it drives the current main thread to wait for other tasks waiting to be executed by the main thread.

    await TaskEx.WhenAll(list);
}

并且您的程序将不再死锁（它在await TaskEx.WhenAll(list); 之后也不会执行任何代码，但那是因为此代码在关机过程中运行，当您await 它让关机继续处理，如果它被放置在其他地方，就像点击事件一样，您会看到更正常的行为）。

---

另一种选择是拥有第二个“主线程”并将工作分派给该线程。通常，当必须在“主”线程上运行某些东西时，实际上是在说它们需要在“一个 STA Windows 消息泵出该对象最初创建于”线程上运行.这是一个示例（取自here）

private void runBrowserThread(Uri url) {
    var th = new Thread(() => {
        var br = new WebBrowser();
        br.DocumentCompleted += browser_DocumentCompleted;
        br.Navigate(url);
        Application.Run();
    });
    th.SetApartmentState(ApartmentState.STA);
    th.Start();
}

void browser_DocumentCompleted(object sender, WebBrowserDocumentCompletedEventArgs e) {
    var br = sender as WebBrowser;
    if (br.Url == e.Url) {
        Console.WriteLine("Natigated to {0}", e.Url);
        Application.ExitThread();   // Stops the thread
    }
}

Answer 3

@HansPassant 是正确的；通过阻止调度程序线程等待任务，您可以防止任务被执行。您可能做出的最简单的更改是将Task.WaitAll(list) 替换为：

_taskFactory.ContinueWhenAll(
    list,
    tasks => { /* resume here */ });

...然后将调用WaitAll() 之后的任何代码移动到延续中。请记住检查任务结果并对可能发生的任何异常做出适当的响应。

但除非使用您的示例代码中不明显的 Tasks 有一些切实的好处，否则我会听取 Hans 的建议并简单地放弃 Tasks 以支持同步调用。