WinForms 事件在异步等待中乱序执行

Question

WinForms 事件出现故障。我想我明白为什么，但我很好奇解决它的最佳方法。

在下面的（人为的）代码中，首先调用Load，但是当到达await 然后调用Shown 时它会放弃控制。一旦Shown完成，Load终于可以完成了。

private async void SomeForm_Load(object sender, EventArgs e)
{
    someLabel.Text = "Start Load";
    await SomeMethod();
    someLabel.Text = "Finish Load";
}

private void SomeForm_Shown(object sender, EventArgs e)
{
    someLabel.Text = "Shown";
}


private async Task SomeMethod()
{
    await Task.Delay(1).ConfigureAwait(false);
}

我需要确保Load 完成后才能执行Shown。

这是我目前的解决方案：

Task _isLoadedTask;

private async void SomeForm_Load(object sender, EventArgs e)
{
    var tcs = new TaskCompletionSource();
    _isLoadedTask = tcs.Task;

    someLabel.Text = "Start Load";
    await SomeMethod();
    someLabel.Text = "Finish Load";

    tcs.TrySetResult();
}

private async void SomeForm_Shown(object sender, EventArgs e)
{
    await _isLoadedTask;

    someLabel.Text = "Shown";
}

这样做的明显缺点是我必须手动设置边界/依赖项。确保事件按顺序执行的最佳方法是什么？

Answer 1

所有解决方案都需要阻止 Shown 继续直到加载完成。 TaskCompletionSource 似乎是实现这一目标的最优雅方式。

Task _isLoadedTask;

private async void SomeForm_Load(object sender, EventArgs e)
{
    var tcs = new TaskCompletionSource();
    _isLoadedTask = tcs.Task;

    someLabel.Text = "Start Load";
    await SomeMethod();
    someLabel.Text = "Finish Load";

    tcs.TrySetResult();
}

private async void SomeForm_Shown(object sender, EventArgs e)
{
    await _isLoadedTask;

    someLabel.Text = "Shown";
}

Answer 2

在这种情况下，覆盖OnLoad 或订阅Load 具有相同的效果。

但是，订阅 Load 会导致委托实例化和调用，而覆盖 OnLoad 不会也将给予对将执行的内容和执行顺序的更多控制。

试试这个：

private Task isLoadedTask;

protected override void OnLoad(EventArgs e)
{
    this.isLoadedTask = OnLoadAsync();

    base.OnLoad(e);
}

private async Task LoadAsync()
{
    someLabel.Text = "Start Load";
    await SomeMethod();
    someLabel.Text = "Finish Load";
}

protected override async void OnShown(EventArgs e)
{
    base.OnShown(e);

    await _isLoadedTask;

    someLabel.Text = "Shown";
}

Answer 3

您正在以正确的顺序获取事件。事件处理程序中的async void 和await 混淆了这个问题。从Form 类的角度来看，当它调用你的Load 事件处理程序时，当SomeMethod 中的await 被命中时，事件处理程序方法返回。当SomeMethod 任务完成时，Load 事件处理程序中的其余代码作为 continuation 返回 UI 线程执行 - 尽管它看起来仍在 Load 事件处理程序中，因为是您的代码所在的位置，这不是编译器发出的。有点混乱，肯定的。 Jon Skeet 的书C# in Depth: Fourth Edition 可能是我所见过的对此最好的解释之一。

此外，尽可能避免使用async void 方法，因为抛出异常可能会使您的进程崩溃。为了解决这两个问题并增加一些清晰度，我将使用 Load 事件来启动任务，然后在 Shown 中附加一个延续。这可确保当 Load 中的异步内容完成并显示时您想要运行的代码发生。

private Task _loadTask = Task.CompletedTask;
private Stopwatch _sw = Stopwatch.StartNew();

private void Form1_Load(object sender, EventArgs e)
{
    Trace.TraceInformation("[{0}] {1} Form1_Load - Begin", Thread.CurrentThread.ManagedThreadId, _sw.ElapsedMilliseconds);
    _loadTask = DoAsyncLoadStuff();
    Trace.TraceInformation("[{0}] {1} Form1_Load - End", Thread.CurrentThread.ManagedThreadId, _sw.ElapsedMilliseconds);
}

private void Form1_Shown(object sender, EventArgs e)
{
    Trace.TraceInformation("[{0}] {1} Form1_Shown - Begin", Thread.CurrentThread.ManagedThreadId, _sw.ElapsedMilliseconds);
    _loadTask.ContinueWith(DoStuffAfterShownAndAsyncLoadStuff, null, TaskScheduler.FromCurrentSynchronizationContext());
    Trace.TraceInformation("[{0}] {1} Form1_Shown - End", Thread.CurrentThread.ManagedThreadId, _sw.ElapsedMilliseconds);
}

private void DoStuffAfterShownAndAsyncLoadStuff(Task asyncLoadTask, object context)
{
    Trace.TraceInformation("[{0}] {1} DoStuffAfterShownAndAsyncLoadStuff. Task was {2}", Thread.CurrentThread.ManagedThreadId, 
        _sw.ElapsedMilliseconds, asyncLoadTask.Status);
}

private async Task DoAsyncLoadStuff()
{
    await Task.Delay(5000).ConfigureAwait(false);
    Trace.TraceInformation("[{0}] {1} DoAsyncLoadStuff - Returning", Thread.CurrentThread.ManagedThreadId, _sw.ElapsedMilliseconds);
    //throw new NotImplementedException();
}

上面的示例将在 Visual Studio 的“输出”窗口中输出线程 ID 和经过的毫秒数。调整延迟时间并取消注释抛出异常。请注意，DoStuffAfterShownAndAsyncLoadStuff 将始终在 UI 线程上执行。