如何异步调用事件？

Question

我正在构建一个可供其他开发人员使用的控件，并且在一些地方我有开发人员可以订阅的事件来执行一些可能很长的操作。

我的目标是让他们选择使用 async/await、多线程、backgroundworkers 等。如果他们选择，但仍然能够在事件调用完成之前完成执行。这是一个伪代码示例（我意识到这不会编译，但希望意图很明确）：

我的代码：

public event MyEventHandler MyEvent;
private void InvokeMyEvent()
{
    var args = new MyEventArgs();

    // Keep the UI responsive until this returns
    await MyEvent?.Invoke(this, args);

    // Then show the result
    MessageBox.Show(args.Result);
}

开发者/订阅者的潜在代码：

// Option 1: The operation is very quick,
// so the dev doesn't mind doing it synchronously
private void myForm_MyEvent(object sender, MyEventArgs e)
{
    // Short operation, I'll just do it right here.
    string result = DoQuickOperation();
    e.Result = result;
}

// Option 2, The operation is long,
// so the dev wants to do it on another thread and keep the UI responsive.
private void myForm_MyEvent(object sender, MyEventArgs e)
{
    myForm.ShowProgressPanel();

    // Long operation, I want to multithread this!
    Task.Run(() =>
    {
        string result = DoVeryLongOperation();
        e.Result = result;
    })
    .ContinueWith((task) =>
    {
        myForm.HideProgressPanel();
    }
}

有没有标准的方法来完成这个？我正在查看委托的 BeginInvoke 和 EndInvoke 方法，希望它们能有所帮助，但我并没有真正想出任何东西。

任何帮助或建议将不胜感激！谢谢！

Answer 1

没有标准的方法。

当我遇到这种情况时，我个人的偏好是使用返回 Task 的自定义委托类型。同步返回的处理程序可以简单地返回Task.CompletedTask，他们不需要为此创建新任务。

public delegate Task MyAsyncEventHandler(object sender, MyEventArgs e);
public event MyAsyncEventHandler MyEvent;
private async Task InvokeMyEvent()
{
    var args = new MyEventArgs();

    // Keep the UI responsive until this returns
    var myEvent = MyEvent;
    if (myEvent != null)
        await Task.WhenAll(Array.ConvertAll(
          myEvent.GetInvocationList(),
          e => ((MyAsyncEventHandler)e).Invoke(this, args)));

    // Then show the result
    MessageBox.Show(args.Result);
}

注意在局部变量中捕获myEvent 以避免线程问题，并使用GetInvocationList() 确保等待所有任务。

请注意，在此实现中，如果您有多个事件处理程序，它们会同时调度，因此可以并行执行。处理程序需要确保他们不会以线程不安全的方式访问args。

根据您的用例，按顺序执行处理程序（await 在循环中）可能更合适。

Answer 2

您可能会发现我的blog post on async events 很有用。

没有严格的约定，但由于 WinRT/Win10 API 处理此问题的方式，存在一个宽松的约定：延迟。我有一个DeferralManager type 可以帮助您：

class MyEventArgs : IDeferralSource
{
  private IDeferralSource _deferralSource;
  public MyEventArgs(IDeferralSource deferralSource) { _deferralSource = deferralSource; }
  IDisposable GetDeferral() => _deferralSource.GetDeferral();

  ... // Other properties
}

public event MyEventHandler MyEvent;
private async Task InvokeMyEventAsync()
{
  var deferralManager = new DeferralManager();
  var args = new MyEventArgs(deferralManager.DeferralSource);

  MyEvent?.Invoke(this, args);

  await deferralManager.WaitForDeferralsAsync();

  MessageBox.Show(args.Result);
}

这种方法具有很好的特性，即同步事件处理程序与普通事件处理程序完全一样，同时允许异步事件处理程序。但这并不理想；特别是，强制异步事件处理程序获取延迟 - 如果没有，那么它不会按预期工作。

但是，我必须提醒您，首先将事件用于这种设计是可疑的。在 .NET 中，事件是观察者设计模式的适当实现。但是您的代码没有使用观察者；它使用模板方法设计模式。您遇到的设计问题是因为您试图使用事件来实现模板方法设计模式。您可以强制它适应（以几种不同的方式），但这并不理想。