【问题标题】:Why is TaskScheduler.Current the default TaskScheduler?为什么 TaskScheduler.Current 是默认的 TaskScheduler?
【发布时间】:2011-10-11 15:46:43
【问题描述】:

Task Parallel Library 非常棒,在过去的几个月里我经常使用它。然而,有一些事情让我很困扰:TaskScheduler.Current 是默认任务调度程序,而不是TaskScheduler.Default。这在文档和示例中乍一看绝对不明显。

Current 可能会导致细微的错误,因为它的行为会根据您是否在另一个任务中而发生变化。哪个不容易确定。

假设我正在编写一个异步方法库,使用基于事件的标准异步模式在原始同步上下文中发出信号完成信号,就像 XxxAsync 方法在 .NET Framework 中所做的一样(例如DownloadFileAsync)。我决定使用任务并行库来实现,因为使用以下代码很容易实现此行为:

public class MyLibrary
{
    public event EventHandler SomeOperationCompleted;

    private void OnSomeOperationCompleted()
    {
        SomeOperationCompleted?.Invoke(this, EventArgs.Empty);
    }

    public void DoSomeOperationAsync()
    {
        Task.Factory.StartNew(() =>
        {
            Thread.Sleep(1000); // simulate a long operation
        }, CancellationToken.None, TaskCreationOptions.None, TaskScheduler.Default)
        .ContinueWith(t =>
        {
            OnSomeOperationCompleted(); // trigger the event
        }, TaskScheduler.FromCurrentSynchronizationContext());
    }
}

到目前为止,一切正常。现在,让我们在 WPF 或 WinForms 应用程序中单击按钮调用此库:

private void Button_OnClick(object sender, EventArgs args)
{
    var myLibrary = new MyLibrary();
    myLibrary.SomeOperationCompleted += (s, e) => DoSomethingElse();
    myLibrary.DoSomeOperationAsync(); // call that triggers the event asynchronously
}

private void DoSomethingElse() // the event handler
{
    //...
    Task.Factory.StartNew(() => Thread.Sleep(5000)); // simulate a long operation
    //...
}

这里,编写库调用的人选择在操作完成时启动一个新的Task。没有什么不寻常的。他或她遵循网络上随处可见的示例,只需使用Task.Factory.StartNew 而不指定TaskScheduler(并且在第二个参数处指定它并不容易重载)。 DoSomethingElse 方法在单独调用时工作正常,但一旦被事件调用,UI 就会冻结,因为 TaskFactory.Current 将重用我的库延续中的同步上下文任务调度程序。

找出这一点可能需要一些时间,尤其是当第二个任务调用隐藏在某个复杂的调用堆栈中时。当然,一旦你知道一切是如何工作的,这里的修复很简单:总是为你希望在线程池上运行的任何操作指定TaskScheduler.Default。但是,也许第二个任务是由另一个外部库启动的,不知道这种行为,并且在没有特定调度程序的情况下天真地使用 StartNew。我预计这种情况会很常见。

在思考之后,我无法理解编写 TPL 的团队选择使用 TaskScheduler.Current 而不是 TaskScheduler.Default 作为默认值:

  • 一点都不明显,Default不是默认的!而且文档严重缺乏。
  • Current 使用的真正任务调度程序取决于调用堆栈!这种行为很难保持不变量。
  • 使用StartNew 指定任务调度程序很麻烦,因为您必须先指定任务创建选项和取消令牌,导致行长、可读性差。这可以通过编写扩展方法或创建使用Default 的TaskFactory 来缓解。
  • 捕获调用堆栈会产生额外的性能成本。
  • 当我真的希望一个任务依赖于另一个正在运行的父任务时,我更愿意明确指定它以简化代码阅读,而不是依赖调用堆栈魔法。

我知道这个问题可能听起来很主观,但我找不到一个好的客观论据来解释为什么会出现这种行为。我确定我在这里遗漏了一些东西:这就是我转向你的原因。

【问题讨论】:

  • 我正在努力完全按照您的示例进行操作,但是假设将在 UI 上下文中调用它,这难道不是消费代码 (DoSomethingElse) 中的错误吗? (如果这就是你想要表达的意思——它不是在 UI 上下文中创建任务)
  • 恰恰相反:DoSomethingElse 可以在此处的任何上下文中运行,但在这种特定情况下,它创建的任务将在父任务的上下文中运行,它本身在 UI 线程上运行,没有知道它。如果使用Default 任务调度程序,则没有问题。我指定它没有任何问题,但我不控制每个第三方库,并不总是意识到这一事实。我不明白为什么Current 是所有那些潜在危险的变化上下文的默认值。不过这个问题可能太有争议了。
  • 在 .NET 4.5 中,现在有 Task.Run,​​其中 TaskScheduler.Default 是默认的 TaskScheduler:blogs.msdn.com/b/pfxteam/archive/2011/10/24/10229468.aspx
  • 您是否考虑过显式调用 UI 线程而不是使用调度程序进行调用?对我来说,这似乎是灾难的秘诀。不过我同意你的看法,这在 TPL 团队方面相当缺乏逻辑。

标签: c# .net task-parallel-library conceptual synchronizationcontext


【解决方案1】:

[编辑] 下面只解决Task.Factory.StartNew使用的调度器的问题。
但是,Task.ContinueWith 有一个硬编码的TaskScheduler.Current。 [/编辑]

首先,有一个简单的解决方案可用 - 请参阅本文底部。

这个问题背后的原因很简单:不仅有一个默认的任务调度程序(TaskScheduler.Default),还有一个TaskFactory(TaskFactory.Scheduler)的默认任务调度程序。 这个默认调度器可以在创建时在TaskFactory的构造函数中指定。

但是,Task.Factory 后面的TaskFactory 是这样创建的:

s_factory = new TaskFactory();

如您所见,没有指定TaskScheduler; null 用于默认构造函数 - 最好是 TaskScheduler.Default(文档指出使用“Current”,结果相同)。
这再次导致TaskFactory.DefaultScheduler(私有成员)的实现:

private TaskScheduler DefaultScheduler 
{ 
   get
   { 
      if (m_defaultScheduler == null) return TaskScheduler.Current;
      else return m_defaultScheduler;
   }
}

在这里您应该可以识别出这种行为的原因:由于 Task.Factory 没有默认的任务调度程序,因此将使用当前的。

那么,当当前没有任务正在执行(即我们没有当前的 TaskScheduler)时,我们为什么不遇到 NullReferenceExceptions 呢?
原因很简单:

public static TaskScheduler Current
{
    get
    {
        Task internalCurrent = Task.InternalCurrent;
        if (internalCurrent != null)
        {
            return internalCurrent.ExecutingTaskScheduler;
        }
        return Default;
    }
}

TaskScheduler.Current 默认为TaskScheduler.Default。

我认为这是一个非常不幸的实现。

但是,有一个简单的解决方法:我们可以简单地将Task.Factory 的默认TaskScheduler 设置为TaskScheduler.Default

TaskFactory factory = Task.Factory;
factory.GetType().InvokeMember("m_defaultScheduler", BindingFlags.SetField | BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.DeclaredOnly, null, factory, new object[] { TaskScheduler.Default });

我希望我能帮助我的回复,虽然已经很晚了:-)

【讨论】:

  • 我已经看到了实现以及它为什么会这样工作,但这仍然是一个很好的答案,谢谢!关于使用反射来更改默认调度程序,我不会在生产代码中这样做,但它可能会有所帮助。
【解决方案2】:

而不是Task.Factory.StartNew()

考虑使用:Task.Run()

这将始终在线程池线程上执行。我刚刚遇到了问题中描述的相同问题,我认为这是处理此问题的好方法。

查看此博客条目: http://blogs.msdn.com/b/pfxteam/archive/2011/10/24/10229468.aspx

【讨论】:

  • 如果我需要指定 TaskCreationOptions.LongRunning 怎么办?我相信不是所有Task.Factory.StartNew()或new Task()的地方都可以用Task.Run()来改变
【解决方案3】:

我刚刚花了几个小时试图调试一个奇怪的问题,我的任务被安排在 UI 线程上,即使我没有指定它。事实证明,问题正是您的示例代码所展示的:在 UI 线程上安排了一个任务延续,并且在该延续的某个地方,启动了一个新任务,然后在 UI 线程上安排了一个新任务,因为当前正在执行的任务有一个具体TaskScheduler设置。

幸运的是,这是我拥有的所有代码,所以我可以通过确保我的代码在开始新任务时指定 TaskScheduler.Default 来修复它,但如果你不那么幸运,我的建议是使用 Dispatcher.BeginInvoke 而不是使用 UI 调度程序。

所以,而不是:

var uiScheduler = TaskScheduler.FromCurrentSynchronizationContext();
var task = Task.Factory.StartNew(() => Thread.Sleep(5000));
task.ContinueWith((t) => UpdateUI(), uiScheduler);

试试:

var uiDispatcher = Dispatcher.CurrentDispatcher;
var task = Task.Factory.StartNew(() => Thread.Sleep(5000));
task.ContinueWith((t) => uiDispatcher.BeginInvoke(new Action(() => UpdateUI())));

但它的可读性有点差。

【讨论】:

    【解决方案4】:

    一点都不明显,默认不是默认!而且文档严重缺乏。

    Default 是默认值,但并不总是Current。

    正如其他人已经回答的那样,如果您希望任务在线程池上运行,您需要通过将Default 调度程序传递给TaskFactory 或StartNew 方法来显式设置Current 调度程序.

    由于您的问题涉及库,我认为答案是您不应该做任何会更改库外部代码看到的Current 调度程序的事情。这意味着您在引发 SomeOperationCompleted 事件时不应使用 TaskScheduler.FromCurrentSynchronizationContext()。相反,请执行以下操作:

    public void DoSomeOperationAsync() {
        var context = SynchronizationContext.Current;
        Task.Factory
            .StartNew(() => Thread.Sleep(1000) /* simulate a long operation */)
            .ContinueWith(t => {
                context.Post(_ => OnSomeOperationCompleted(), null);
            });
    }
    

    我什至认为您不需要在 Default 调度程序上明确启动您的任务 - 如果他们愿意,让调用者确定 Current 调度程序。

    【讨论】:

      【解决方案5】:

      我认为当前的行为是有道理的。如果我创建自己的任务调度程序,并启动一些任务来启动其他任务,我可能希望所有任务都使用我创建的调度程序。

      我同意有时从 UI 线程启动任务使用默认调度程序而有时不使用这很奇怪。但我不知道如果我在设计它,我会如何让它变得更好。

      关于您的具体问题:

      • 我认为在指定调度程序上启动新任务的最简单方法是new Task(lambda).Start(scheduler)。这样做的缺点是,如果任务返回某些内容,您必须指定类型参数。 TaskFactory.Create 可以为您推断类型。
      • 您可以使用Dispatcher.Invoke() 而不是TaskScheduler.FromCurrentSynchronizationContext()。

      【讨论】:

      • 虽然没有关于自定义 TaskScheduler,但这可能是我困扰的地方:如果有人创建自己的任务调度程序并开始使用父任务调用我的代码,我不想要我的代码行为改变,除非我真的想要它(手动指定当前)。关于我的具体问题,我更喜欢自定义 TaskFactory 方式,但无论如何感谢您的解决方案。
      • @Julien Lebosquain 然后,您应该始终明确指定要在 TPL 调用中使用的 TaskScheduler。只需输入少量额外代码,但可以保证您得到您想要的。
      • 我同意 Julien 的观点,这种行为是糟糕的设计,并且在语义上将 default 的含义更改为 api 的一部分中的“默认调度程序”,但如果您在其中运行,则为“当前调度程序”, api的另一部分中的else default'正在自找麻烦。事实上,它也被 rx 团队抓住了! social.msdn.microsoft.com/Forums/en-US/rx/thread/…
      • @Drew,我认为重点不在于 Julien 在他自己的代码中所做的事情,而是当其他库的作者在他们真正的意思是 Default 时犯了使用 Current 的简单错误时会发生什么.正如 Dan 指出的那样,我们已经在 Rx 中看到了这一点,我也在其他库中遇到过。 IMO 解决此问题的方法是弃用当前默认使用 Current 的 API(如果您明白我的意思!),并将它们替换为需要明确指定调度程序的 API。
      • 我完全不同意:通常,我不希望将paren 的任务调度程序选为子任务的默认任务调度程序。例如,调度程序可能用于同步对共享资源的访问——在这种情况下,它可能被实现为串行执行上下文。或者它可能是用于写入/读取 IO 的专用执行上下文。通常不应在此调度程序上执行子任务。如果调度程序被实现为串行执行上下文并且同步调用操作 - 如果子进程也使用相同的调度程序,您也会遇到死锁。
      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2015-06-09
      • 1970-01-01
      • 2014-06-09
      • 1970-01-01
      • 2010-11-04
      相关资源
      最近更新 更多