如何等待事件处理程序调用？

Question

基本上，我有一个调用事件处理程序的方法。 事件处理程序调用异步方法，我需要知道该方法的结果（真或假）。 由于事件处理程序只能返回 void，因此我创建了自己的 eventargs 并带有一个成功属性，如果它正确，我在该方法中将其设置为 true。

public virtual async Task<bool> TrySomething()
        {
            var args = new MyEventArgs();
            SomeEvent?.Invoke(this, args);
            return args.Success;
        }

SomeEvent 连接到 SomeEventHandler

private async void SomeEventHandler(object sender, MyEventArgs e)
        {
            e.Success = await AnAsyncMethod();
        }

private asyc Task<bool> AnAsyncMethod()
{
  //...
}

我感到困惑的是，是否可以保证 TrySomething 方法将等待 SomeEvent 完成，因此在返回之前设置了 Success？ 如果不是，我如何确保它确实如此？

谢谢

Answer 1

是否可以保证 TrySomething 方法将等待 SomeEvent 完成，因此在返回之前设置了 Success？

不， async void表示“完成后不通知调用者”。 因此，引发事件的代码无法知道事件处理程序何时完成，除非您自己编写附加逻辑。

如果不是，我如何确保它确实如此？

嗯，这更像是一个棘手的问题。 .NET 事件被设计为我所说的“通知事件”——也就是说，当一个事件触发时，它会通知它的所有侦听器。 没有必要“等待”，因为听众无法向通知者提供反馈。

您的代码是我称之为“命令事件”的示例 - 代码是一个event但与通知事件的语义不匹配。 您的代码需要处理程序的响应。

所以，你需要问自己的第一个问题是“我真的希望这成为一个事件吗？” 一个很好的试金石是“如果有多个处理程序，我可以定义有意义的语义吗？”

更具体地说，如果多个处理程序连接到事件，您的代码应该如何表现？ 也许答案是“那没有意义”。 或者答案可能是“我想等待它们全部完成，并且只有在它们都‘成功’的情况下才‘成功’”。 或者“等待所有人，如果其中任何一个‘成功’，就‘成功’”。 或“等待第一个完成并使用该结果”。 或者“等待他们一次完成一个，在第一次成功时停止”。 或者“等待他们一次完成一个，在第一次失败时停止”。 这些是立即浮现在脑海中的选择； 可能还有更多。

如果答案是“这不会在我的代码中发生”或“多个处理程序没有意义”或“现在很难做出决定”，那么适当的答案是删除event 。 这不是一个事件。 这是一个方法调用。 在设计模式术语中， events用于实现观察者模式，但您拥有的是策略模式，这就是为什么event不适合。 在这种情况下，您可以使用Gabriel 的答案或类似的东西，在其中使用接口定义策略，而不是引发事件，而是调用该接口上的方法。

但是，如果拥有多个处理程序确实有意义，并且您可以使用有意义的语义，那么您需要修改EventArgs类型以拥有某种响应“收集器”，然后让您的事件引发代码解释这些响应。 确切的代码将根据您需要的语义而有所不同。

Answer 2

允许async void的全部原因是事件处理程序。 从关于Async Return Types的文档中：

您在需要 void 返回类型的异步事件处理程序中使用 void 返回类型。

也就是说，事件旨在向任何相关方（如果有的话）“发出动作发生的信号”（可以没有，也可以有多个）。 可以将其想象为向订阅特定邮件列表的任何人发送 email 通知：这些人在收到通知时可能需要做一些事情，但这不是您关心的问题 - 您在发送 email 后继续执行下一个任务。 这就是所有的事件。 事件处理程序不应该对 object 的正常运行很重要。

事件并非设计为“嘿，这件事发生了，接下来我该怎么做？” 所以应该不需要等待事件处理程序。

如果返回args.Success取决于SomeEventHandler成功完成，那么它不应该是事件处理程序。 相反，您可以拥有一个Func<Task<bool>>属性（返回Task<bool>的 function ）。 像这样的东西：

public class SomeClass {
    private Func<Task<bool>> IsSuccessful;

    public SomeClass(Func<Task<bool>> isSuccessful) {
        // Accept a reference to a function and store it
        IsSuccessful = isSuccessful;
    }

    public async Task<bool> DoSomething() {
        // Call our function and return the result
        return await IsSuccessful();
    }
}

然后你可以像这样使用它：

// This is the method we want it to call
private async Task<bool> AnAsyncMethod() {
  await Task.Delay(1);
  return true;
}

// so we pass it in the constructor of the class.
// You don't have to pass it in the constructor - this is just an example
var myClass = new SomeClass(AnAsyncMethod);

这样，很明显SomeClass不能正确地调用 function 而不调用该方法，因此必须将该方法的一个实现传递给 class。

Answer 3

您可以将Success属性声明为Task<bool>而不是bool 。 然后像这样在处理程序中分配它：

private void SomeEventHandler(object sender, MyEventArgs e)
{
    e.Success = AnAsyncMethod(); // Without await
}

最后，您将能够在调用事件并等待属性后获得结果。

public virtual async Task<bool> TrySomething()
{
    var args = new MyEventArgs();
    SomeEvent?.Invoke(this, args);
    return await (args.Success ?? Task.FromResult(false));
}