如何正确实现自定义 awaiter 的 OnCompleted 方法?

Gyö*_*zeg 6 c# async-await

我有一个自定义的可等待类型,问题是延续在不同的线程上恢复,这会导致 WinForms/WPF/MVC/等 UI 出现问题:

private MyAwaitable awaitable;

private async void buttonStart_Click(object sender, EventArgs e)
{
    awaitable = new MyAwaitable(false);
    progressBar1.Visible = true;

    // A regular Task can marshal the execution back to the UI thread
    // Here ConfigureAwait is not available and I don't know how to control the flow
    var result = await awaitable;

    // As a result, here comes the usual "Cross-thread operation not valid" exception
    // A [Begin]Invoke could help but regular Tasks also can handle this situation
    progressBar1.Visible = false;
}

private void buttonStop_Click(object sender, EventArgs e) => awaitable.Finish();
Run Code Online (Sandbox Code Playgroud)

这是MyAwaitable课程:

public class MyAwaitable
{
    private volatile bool finished;
    public bool IsFinished => finished;
    public MyAwaitable(bool finished) => this.finished = finished;
    public void Finish() => finished = true;
    public MyAwaiter GetAwaiter() => new MyAwaiter(this);
}
Run Code Online (Sandbox Code Playgroud)

还有有问题的自定义等待器:

public class MyAwaiter : INotifyCompletion
{
    private readonly MyAwaitable awaitable;
    private readonly SynchronizationContext capturedContext = SynchronizationContext.Current;

    public MyAwaiter(MyAwaitable awaitable) => this.awaitable = awaitable;
    public bool IsCompleted => awaitable.IsFinished;

    public int GetResult()
    {
        var wait = new SpinWait();
        while (!awaitable.IsFinished)
            wait.SpinOnce();
        return new Random().Next();
    }

    public void OnCompleted(Action continuation)
    {            
        // continuation(); // This would block the UI thread

        // Task constructor + Start was suggested by the references I saw,
        // Results with Task.Run/Task.Factory.StartNew are similar.
        var task = new Task(continuation, TaskCreationOptions.LongRunning);

        // If executed from a WinForms app, we have a WinFormsSyncContext here,
        // which is promising, still, it does not solve the problem.
        if (capturedContext != null)
            capturedContext.Post(state => task.Start(), null);
        else
            task.Start();
    }
}
Run Code Online (Sandbox Code Playgroud)

我怀疑我的OnCompleted实现不太正确。

我试图深入研究ConfiguredTaskAwaiter该Task.ConfigureAwait(bool).GetAwaiter()方法返回的内容,可以看到黑魔法发生在一个SynchronizationContextAwaitTaskContinuation类中,但这是一个内部类,以及许多其他内部使用的类型。有没有办法重构我的OnCompleted实现以按预期工作?

更新:给downvoters 的注意:我知道我在 中做了不正确的事情OnCompleted,这就是我问的原因。如果您对质量(或其他任何问题)有疑问,请发表评论并帮助我改进问题,以便我也可以帮助您更好地突出问题。谢谢。

注 2:我知道我可以使用 aTaskCompletionSource<TResult>及其常规Task<TResult>结果的解决方法,但我想了解背景。这是唯一的动力。纯粹的好奇。

更新 2:我调查的值得注意的参考文献:

等待器的工作原理:

一些实现:

Iva*_*oev 8

OnCompleted方法的MSDN解释是:

安排在实例完成时调用的延续操作。

因此, 的实现都不OnCompleted是“正确的”,因为awaiter如果awaitable尚未完成,则不应在该调用期间执行传递的委托,而是将其注册为在awaitable完成时执行。

唯一不清楚的是如果在awaitable调用方法时已经完成了该方法应该做什么(尽管在这种情况下编译器生成的代码不会调用它) - 忽略继续委托或执行。根据Task实现,应该是后者(执行)。

当然,规则也有例外(因此使用“正确”一词)。例如,YieldAwaiter特别总是返回IsCompleted == false强制调用它的OnCompleted方法,该方法立即在线程池上调度传递的委托。但是“通常”你不会那样做。

通常(与标准Task实现一样)awaitable将执行操作,提供结果,等待机制,并将维护/执行延续。他们awaiters通常struct持有对 shared 的引用awaitable(以及需要时的延续选项),并将GetResult和OnCompleted方法调用委托给 shared awaitable,特别是OnCompleted将延续委托以及选项传递给awaitable负责注册/执行它们的内部方法. “可配置” awaitables 将简单地保存共享awaitable和选项,并将它们简单地传递给创建的awaiters。

由于在您的示例中,等待和结果由 提供awaiter,因此awaitable可以简单地提供完成事件:

public class MyAwaitable
{
    private volatile bool finished;
    public bool IsFinished => finished;
    public event Action Finished;
    public MyAwaitable(bool finished) => this.finished = finished;
    public void Finish()
    {
        if (finished) return;
        finished = true;
        Finished?.Invoke();
    }
    public MyAwaiter GetAwaiter() => new MyAwaiter(this);
}
Run Code Online (Sandbox Code Playgroud)

并且awaiters 会订阅它:

public class MyAwaiter : INotifyCompletion
{
    private readonly MyAwaitable awaitable;
    private int result;

    public MyAwaiter(MyAwaitable awaitable)
    {
        this.awaitable = awaitable;
        if (IsCompleted)
            SetResult();

    }
    public bool IsCompleted => awaitable.IsFinished;

    public int GetResult()
    {
        if (!IsCompleted)
        {
            var wait = new SpinWait();
            while (!IsCompleted)
                wait.SpinOnce();
        }
        return result;
    }

    public void OnCompleted(Action continuation)
    {
        if (IsCompleted)
            {
                continuation();
                return;
            }
        var capturedContext = SynchronizationContext.Current;
        awaitable.Finished += () =>
        {
            SetResult();
            if (capturedContext != null)
                capturedContext.Post(_ => continuation(), null);
            else
                continuation();
        };
    }

    private void SetResult()
    {
        result = new Random().Next();
    }
}
Run Code Online (Sandbox Code Playgroud)

当OnCompleted被调用时,首先我们检查我们是否完成。如果是,我们只需执行传递的委托并返回。否则,我们捕获同步上下文,订阅awaitable完成事件,并在该事件中通过捕获的同步上下文或直接执行操作。

同样,在现实生活场景中awaitable,awaiters应该执行实际工作,提供结果并维护继续操作,而s 应该只注册继续操作,最终抽象出继续执行策略 - 直接,通过捕获的同步上下文,通过线程池等。

  • 完全同意 - MSDN 应该对实现者的期望提供一个很好的解释,以及每个播放器的目的、方法和调用时间,而不是从链接中进行简单的总结。看起来他们只为他们的实现保留“高级”的东西:) (2认同)