Question

我有一个与SignalR Hub（服务器）通信的.Net Windows服务（客户端）。大多数客户端方法需要时间才能完成。当从服务器接收呼叫时，我如何（或者我需要）包装目标方法/ hub.On以避免警告：

“因为没有等待这个调用，所以当前方法的执行在调用完成之前继续。考虑将await运算符应用于调用的结果”

在客户端上，这是启动/设置代码的示例：

IHubProxy _hub
string hubUrl = @"http://localhost/";

var connection = new HubConnection(hubUrl, hubParams);
_hub = connection.CreateHubProxy("MyHub");
await connection.Start();

_hub.On<Message>("SendMessageToClient", i => OnMessageFromServer(i.Id, i.Message));
_hub.On<Command>("SendCommandToClient", i => OnCommandFromServer(i.Id, i.Command));

同样在客户端上，这是方法的示例：

public static async Task<bool> OnMessageFromServer(string Id, string message)
{
    try
    {
        var result = await processMessage(message);  //long running task
    }
    catch (Exception ex)
    {
        throw new Exception("There was an error processing the message: ", ex);
    }
    return result;
}

public static async Task<bool> OnCommandFromServer(string Id, string command)
{
    try
    {
        var result = await processCommand(command);  //long running task
    }
    catch (Exception ex)
    {
        throw new Exception("There was an error processing the message: ", ex);
    }
    return result;
}

最终，我认为_hub.On正在注册回调，而不是来自服务器的实际执行（调用）。我想我需要进入实际执行的中间，等待On [X] FromServer的结果并返回结果。

*************更新了带有更正代码的示例*********************

IHubProxy _hub
string hubUrl = @"http://localhost/";

var connection = new HubConnection(hubUrl, hubParams);
_hub = connection.CreateHubProxy("MyHub");
await connection.Start();

//original
//_hub.On<Message>("SendMessageToClient", i => OnMessageFromServer(i.Id, i.Message));
//_hub.On<Command>("SendCommandToClient", i => OnCommandFromServer(i.Id, i.Command));

//new async 
_hub.On<Message>("SendMessageToClient", 
    async (i) => await OnMessageFromServer(i.Id, i.Message));

_hub.On<Message>("SendCommandToClient", 
    async (i) => await OnCommandFromServer(i.Id, i.Message));

//expanding to multiple parameters
_hub.On<Message, List<Message>, bool, int>("SendComplexParamsToClient", 
    async (p1, p2, p3, p4) => 
       await OnComplexParamsFromServer(p1.Id, p1.Message, p2, p3, p4));

然后目标方法签名就像

public static async Task<bool> OnComplexParamsFromServer(string id, string message,
                 List<Message> incommingMessages, bool eatMessages, int repeat)
{
    try
    {
        var result = await processCommand(message);  //long running task
        if (result) 
        {
             // eat up your incoming parameters
        }
    }
    catch (Exception ex)
    {
        throw new Exception("There was an error processing the message: ", ex);
    }
    return result;
}

感谢@AgentFire快速回复!!!

Answer 1

这是一个无法等待的模式，请使用它：

_hub.On<Message>("SendMessageToClient", async i => await OnMessageFromServer(i.Id, i.Message))

Answer 2

我知道这很旧，但是接受的答案会创建一个async void的lambda。

但是，如果有未处理的异常，async void方法可能会使您的应用程序崩溃。阅读here和here。

这些文章确实说，由于事件的缘故，async void仅被允许使用，而这些是我们正在谈论的事件。但是，仍然可以例外的是，异常可能会使您的整个应用崩溃。因此，如果要执行此操作，请确保在可能会引发异常的任何地方放置try / catch块。

但是async void方法也可能导致意外行为，因为调用它的代码没有在开始执行其他操作之前等待它完成。

请记住，await的好处是ASP.NET可以关闭并执行其他操作，稍后再返回其余代码。通常那很好。但是在这种特定情况下，这可能意味着可以同时处理两条（或更多条）传入的消息，并且要对先完成的消息进行一次折腾（完成处理的第一个消息可能不是传入的第一个））。尽管这可能与您的情况无关紧要。

您最好等一下：

_hub.On<Message>("SendMessageToClient",
                 i => OnMessageFromServer(i.Id, i.Message).GetAwaiter().GetResult());

有关使用.GetAwaiter().GetResult()而非.Wait()的好处，请参见here和here。

Answer 3

SignalR客户端旨在按顺序调用处理程序方法，而无需进行交织。换句话说，“ SingleThreaded”。通常，您可以依赖于称为“ SingleThreaded”的所有处理程序方法来设计signalR客户端代码。（我在引号中使用“ SingleThreaded”，因为...它不是单线程的，但是我们似乎没有表达顺序调用的异步方法的语言，而没有以概念上单线程的方式进行交织）

但是，这里讨论的“异步无效”方法打破了这种设计假设，并导致了意外的副作用，即客户端处理程序方法现在被并发调用。这是引起副作用的代码示例：

/// Yes this looks like a correct async method handler but the compiler is
/// matching the connection.On<int>(string methodName, Action<int> method)
/// overload and we get the "async-void" behaviour discussed above
connection.On<int>(nameof(AsyncHandler), async (i) => await AsyncHandler(i)));

/// This method runs interleaved, "multi-threaded" since the SignalR client is just
/// "fire and forgetting" it.
async Task AsyncHandler(int value) {
    Console.WriteLine($"Async Starting {value}");
    await Task.Delay(1000).ConfigureAwait(false);
    Console.WriteLine($"Async Ending {value}");
}

/* Example output:
Async Starting 0
Async Starting 1
Async Starting 2
Async Starting 3
Async Starting 4
Async Starting 5
Async Starting 6
Async Starting 7
Async Starting 8
Async Ending 2
Async Ending 3
Async Ending 0
Async Ending 1
Async Ending 8
Async Ending 7
*/

如果您使用的是ASP.NET Core，我们可以附加异步方法处理程序，并让客户端一次依次调用它们，而无需交织，也不会阻塞任何线程。我们利用SignalR中为ASP.NET Core引入的following override。

IDisposable On(this HubConnection hubConnection, string methodName, Type[] parameterTypes,
                Func<object[], Task> handler)

这是实现它的代码。可悲的是，您编写的用于附加处理程序的代码有点晦涩，但在这里是：

/// Properly attaching an async method handler
connection.On(nameof(AsyncHandler), new[] { typeof(int) }, AsyncHandler);

/// Now the client waits for one handler to finish before calling the next.
/// We are back to the expected behaviour of having the client call the handlers
/// one at a time, waiting for each to finish before starting the next.
async Task AsyncHandler(object[] values) {
    var value = values[0];
    Console.WriteLine($"Async Starting {value}");
    await Task.Delay(1000).ConfigureAwait(false);
    Console.WriteLine($"Async Ending {value}");
}

/* Example output
Async Starting 0
Async Ending 0
Async Starting 1
Async Ending 1
Async Starting 2
Async Ending 2
Async Starting 3
Async Ending 3
Async Starting 4
Async Ending 4
Async Starting 5
Async Ending 5
Async Starting 6
Async Ending 6
Async Starting 7
Async Ending 7
*/

当然，现在您知道如何根据您的要求实现两种客户端行为。如果选择使用async-void行为，则最好对此做个很好的注释，以免引起其他程序员的陷阱，并确保不要抛出未处理的任务异常。

如何在SignalR客户端中使用async / await与hub.On

3 个答案: