Azure、SignalR 和 Web Api 不向客户端发送消息

Question

我从 56 分 11 秒部分的视频“Scaling the Real-time Web with ASP.NET SignalR”中获得了灵感。

想象一个基于 Web 的聊天客户端使用 SignalR 与服务器进行通信。当客户端连接时，其端点信息存储在 Azure 表中。

聊天客户端可以通过 SignalR 向另一个聊天客户端发送消息，后者查找感兴趣的目标客户端的端点(可能在不同的实例上)，然后使用 Web API 通过 SignalR 将消息发送到另一个实例到客户端。

为了证明我有 uploaded a sample application to github .

当只有一个 Azure 实例时，这一切都有效。但是，如果有 MULTIPLE azure 实例，则从服务器到客户端对 SignalR 的最后一次调用将以静默方式失败。它就像动态代码不存在或者它来自一个“坏”线程或者消息以某种方式发送到错误的实例或者我刚刚犯了一个愚蠢的错误。

任何想法将不胜感激。

网页是这样设置的

<input type="radio" name='ClientId' value='A' style='width:30px'/>Chat client A</br>
<input type="radio" name='ClientId' value='B' style='width:30px'/>Chat client B</br>
<input type='button' id='register' value='Register' />
<input type='text' id='txtMessage' size='50' /><input type='button' id='send' value='Send' />

<div id='history'>
</div>

JS是

<script type="text/javascript">
    $(function () {

        // Declare a proxy to reference the hub. 
        var chat = $.connection.chatHub;

        chat.client.sendMessageToClient = function (message) {
            $('#history').append("<br/>" + message);
        };


        // Start the connection.
        $.connection.hub.start().done(function () {

            $('#register').click(function () {

                // Call the Send method on the hub. 
                chat.server.register($('input[name=ClientId]:checked', '#myForm').val());

            });


            $('#send').click(function () {

                // Call the Send method on the hub. 
                chat.server.sendMessageToServer($('input[name=ClientId]:checked', '#myForm').val(), $('#txtMessage').val());
            });

        });
    });
</script>

枢纽如下。 (我有一个小的存储类来将端点信息存储在 Azure 表中)。请注意静态方法 SendMessageToClient。这是最终失败的原因。它是从 Web Api 类调用的(如下)

public class ChatHub : Hub
{
    public void Register(string chatClientId)
    {
        Storage.RegisterChatEndPoint(chatClientId, this.Context.ConnectionId);
    }

    /// <summary>
    /// Receives the message and sends it to the SignalR client.
    /// </summary>
    /// <param name="message">The message.</param>
    /// <param name="connectionId">The connection id.</param>
    public static void SendMessageToClient(string message, string connectionId)
    {
        GlobalHost.ConnectionManager.GetHubContext<ChatHub>().Clients.Client(connectionId).SendMessageToClient(message);

        Debug.WriteLine("Sending a message to the client on SignalR connection id: " + connectionId);
        Debug.WriteLine("Via the Web Api end point: " + RoleEnvironment.CurrentRoleInstance.InstanceEndpoints["WebApi"].IPEndpoint.ToString());

    }


    /// <summary>
    /// Sends the message to other instance.
    /// </summary>
    /// <param name="chatClientId">The chat client id.</param>
    /// <param name="message">The message.</param>
    public void SendMessageToServer(string chatClientId, string message)
    {
        // Get the chatClientId of the destination.
        string otherChatClient = (chatClientId == "A" ? "B" : "A");

        // Find out this other chatClientId's end point
        ChatClientEntity chatClientEntity = Storage.GetChatClientEndpoint(otherChatClient);

        if (chatClientEntity != null)
            ChatWebApiController.SendMessage(chatClientEntity.WebRoleEndPoint, chatClientEntity.SignalRConnectionId, message);
    }
}

最后 ChateWebApiController 是这个

public class ChatWebApiController : ApiController
{
    [HttpGet]
    public void SendMessage(string message, string connectionId)
    {
        //return message;
        ChatHub.SendMessageToClient(message, connectionId);
    }

    /// <summary>
    /// This calls the method above but on a different instance via Web API
    /// </summary>
    /// <param name="endPoint">The end point.</param>
    /// <param name="connectionId">The connection id.</param>
    /// <param name="message">The message.</param>
    public static void SendMessage(string endPoint, string connectionId, string message)
    {
        HttpClient client = new HttpClient();
        client.BaseAddress = new Uri("http://" + endPoint);

        // Add an Accept header for JSON format.
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

        string url = "http://" + endPoint + "/api/ChatWebApi/SendMessage/?Message=" + HttpUtility.UrlEncode(message) + "&ConnectionId=" + connectionId;

        client.GetAsync(url);
    }

}

Answer 1

首先，由于没有任何社区对此问题的洞察力，我可能花了太多时间来深入了解这个问题。我预计微软将在 future 几个月内发布关于这些问题的一些指导，但在那之前我们主要靠自己。

这个问题的答案非常复杂，但是当您了解 SignalR 实际上是如何在幕后工作时，这一切就都说得通了。对于冗长的答案表示歉意，但为了给这个问题提供应有的能量，这是必要的。

此解决方案仅适用于多实例 Azure 和 SignalR 通信。如果您不在 Azure(即 Windows Server)上，那么它可能不适用于您，或者如果您计划仅运行 Azure 的一个实例，那么这也不适用于您。
这是必不可少的观看http://channel9.msdn.com/Events/Build/2013/3-502特别是从43分14秒到结束。

开始了…

如果您“阅读盒子的侧面”，您会相信连接到 Azure 的 SignalR 将使用 WebSockets。这将使我们的生活变得简单，因为客户端和 Azure 之间的单个开放套接字连接本质上将始终绑定(bind)到单个 Azure 实例，并且所有通信都可以通过该 channel 流动。

如果你相信这一点，那你就错了。

在当前版本中，针对 Azure 的 SignalR 不使用 WebSockets。 (这是记录在 http://www.asp.net/signalr/overview/getting-started/supported-platforms )IE10 作为客户端将使用“永久框架”——嵌入式 iframe 的一种定义不明确和奇特的使用。阅读在 http://campusmvp.net/signalr-ebook 上找到的优秀电子书建议它“永远”保持与服务器的连接。情况并非完全如此。使用 Fiddler 表明，每次客户端需要与服务器通信时，它都会打开一个 HTTP 连接，尽管初始通信(导致调用 OnConnect 方法)始终保持打开状态。 URL 将采用这种格式/signalr/connect?transport=foreverFrame&connectionToken= 您将看到 Fiddler 中的图标是一个向下的绿色箭头，表示“正在下载”。

我们知道 Azure 使用负载均衡器。鉴于永久帧每次需要向服务器发送消息时都会建立新连接，那么负载均衡器如何知道始终将消息发送回负责建立 SignalR 连接的服务器端的 Azure 实例?答案……不是；取决于应用程序，这可能是也可能不是问题。如果只需要记录发送到 Azure 的消息或采取其他一些操作，则无需进一步阅读。你没有问题。您的服务器端方法将被调用并执行操作；简单的。

但是，如果消息需要通过 SignalR 发送回客户端或发送到另一个客户端(即聊天应用程序)，那么您还有很多工作要做。消息可以实际发送到多个实例中的哪一个？我如何找到它？你怎么能得到消息给另一个实例？

为了演示所有这些方面是如何相互作用的，我编写了一个演示应用程序，可以在 https://github.com/daveapsgithub/AzureSignalRInteration 找到该应用程序。
该应用程序在其网页上有很多详细信息，但简而言之，如果您运行它，您将很容易看到唯一将消息成功发送回客户端的实例是接收“OnConnect”方法的实例。尝试向任何其他实例上的客户端发送消息将默默地失败。

它还表明负载均衡器正在将消息分流到各种实例，并且尝试对不是“OnConnected”实例的任何实例进行回复将无声地失败。幸运的是，无论接收消息的实例如何，该客户端的 SignalR 连接 ID 都保持不变。 (如你所料)

考虑到这些教训，我重新审视了我原来的问题并更新了可以在 https://github.com/daveapsgithub/AzureSignalRWebApi2 上找到的项目。 Azure 表存储的处理现在稍微复杂一些。由于无法为 OnConnected 方法提供任何参数，因此我们需要在调用 OnConnected 时最初将 SignalR 连接 id 和 WebApi 端点存储在 Azure 表存储中。随后，当每个客户端将自己“注册”为客户端 ID“A”或客户端 ID“B”时，此注册调用需要查找该连接 ID 的 Azure 表存储并适当设置客户端 ID。

当 A 向 B 发送消息时，我们不知道该消息出现在哪个实例上。但这现在不是问题，因为我们只需查找“B”的端点，对其进行 WebApi 调用，然后 SignalR 就可以向 B 发送消息。

您需要注意两个主要陷阱。如果您正在调试并且在 OnConnected 中有断点并逐步执行代码，那么客户端可能会超时并发送后续重新连接请求(请务必查看 Fiddler)。完成检查 OnConnected 后，您将看到它作为重新连接请求的一部分再次被调用。可能是什么问题呢？问题是重新连接请求是在另一个必须通过负载平衡器的 HTTP 请求上。您现在将使用即将存储在数据库中的不同 WebApi 端点调试一个完全不同的实例。这个实例，虽然它是通过“OnConnected”消息接收的，但它不是“OnConnected”实例。收到 OnConnected 消息的第一个实例是唯一可以向客户端发送消息的实例。所以总而言之，不要在 OnConnected 中做任何耗时的事件(如果你必须使用一些异步模式让它在单独的线程上运行，以便 OnConnected 可以快速返回)。

其次，不要使用 IE10 的两个实例来测试使用此架构的 SignalR 应用程序。使用 IE 和其他浏览器。如果您打开一个建立 SignalR 连接的 IE，然后打开另一个 IE，则第一个浏览器的 SignalR 连接将被放弃，第一个 IE 开始使用第二个 IE 的 SignalR 连接。这实际上很难相信，但请参阅 Compute Emulator 输出窗口以验证这种疯狂。

由于第一个 SignalR 已放弃其原始连接，因此其 Azure 实例也将“移动”到另一个实例，WebApi 端点不会在 Azure 表中更新，并且发送到它的任何消息都将无声无息地失败。

我已经更新了作为原始问题的一部分发布的源代码，以证明它是有效的。
除了对 Azure 表存储类的更改之外，代码更改很小。我们只需要向 Onconnected 方法添加一些代码。

public override System.Threading.Tasks.Task OnConnected()
    {
        Storage.RegisterChatEndPoint(this.Context.ConnectionId);
        staticEndPoint = RoleEnvironment.CurrentRoleInstance.InstanceEndpoints["WebApi"].IPEndpoint.ToString();
        staticConnectionId = this.Context.ConnectionId;

        return base.OnConnected();
    }

    public void Register(string chatClientId)
    {
        Storage.RegisterChatClientId(chatClientId, this.Context.ConnectionId);
    }