如何创建发布到给定 SynchronizationContext 的任务？

Question

给定我已经拥有的SynchronizationContext（基本上是一个特定线程的窗口），我如何创建发布到此上下文的Tasks？

作为参考，这里有一个非常基本的演示如何设置SynchronizationContext。

public class SomeDispatcher : SynchronizationContext
{
    SomeDispatcher() {

        new Thread(() => {

            SynchronizationContext.SetSynchronizationContext(this);

            // Dispatching loop (among other things)

        }).Start();
    }

    override void Post(SendOrPostCallback d, object state)
    {
        // Add (d, state) to a dispatch queue;
    }
}

这适用于已经在上下文中运行的 async / await。

现在，我希望能够从外部上下文（例如，从 UI 线程）向此发布 Tasks，但似乎找不到这样做的干净方法。

一种方法是使用TaskCompletionSource<>。

Task StartTask(Action action)
{
    var tcs = new TaskCompletionSource<object>();
    SaidDispatcher.Post(state => {
        try
        {
            action.Invoke();
            tcs.SetResult(null);
        }
        catch (Exception ex)
        {
            tcs.SetException(ex);
        }
    });
    return tcs.Task;
});

但这是在重新发明轮子，并且支持诸如 StartNew(Func<TResult>)、StartNew(Func<Task<TResult>>) 等变体的主要痛苦。

SynchronizationContext 的 TaskFactory 接口可能是理想的，但我似乎无法干净地实例化一个：

TaskFactory CreateTaskFactory()
{
    var original = SynchronizationContext.Current;
    SynchronizationContext.SetSynchronizationContext(SomeDispatcher); // yuck!
    try
    {
        return new TaskFactory(TaskScheduler.FromCurrentSynchronizationContext());
    }
    finally
    {
        SynchronizationContext.SetSynchronizationContext(original);
    }
}

（即必须临时处理当前线程的同步上下文似乎很麻烦。）

Answer 1

看来默认SynchronizationContextTaskScheduler是

1. 内部
2. 仅适用于当前同步上下文

但是它的源代码是可用的here 并且我们看到它相对简单，所以我们可以尝试推出我们自己的调度程序，如下所示：

public sealed class MySynchronizationContextTaskScheduler : TaskScheduler {
    private readonly SynchronizationContext _synchronizationContext;

    public MySynchronizationContextTaskScheduler(SynchronizationContext context) {
        _synchronizationContext = context;
    }

    [SecurityCritical]
    protected override void QueueTask(Task task) {
        _synchronizationContext.Post(PostCallback, task);
    }

    [SecurityCritical]
    protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued) {
        if (SynchronizationContext.Current == _synchronizationContext) {
            return TryExecuteTask(task);
        }
        else
            return false;
    }

    [SecurityCritical]
    protected override IEnumerable<Task> GetScheduledTasks() {
        return null;
    }

    public override Int32 MaximumConcurrencyLevel
    {
        get { return 1; }
    }

    private void PostCallback(object obj) {
        Task task = (Task) obj;
        base.TryExecuteTask(task);
    }
}

那么你的CreateTaskFactory就变成了：

TaskFactory CreateTaskFactory() {
    return new TaskFactory(new MySynchronizationContextTaskScheduler(SomeDispatcher));
}

然后你创建任务：

var factory = CreateTaskFactory();
var task = factory.StartNew(...);

Answer 2

Parallel Extensions Extras contains SynchronizationContextTaskScheduler 正是你想要的。

如果你不想自己编译 PEE，there is an unofficial NuGet package for it。

请注意，您通常不需要这样做，而您要求这样做的事实可能表明您的设计存在缺陷。