ASP.NET Core SignalR .NET 客户端

自动重新连接

可以将 HubConnection 配置为对 WithAutomaticReconnect 使用 HubConnectionBuilder 方法来自动重新连接。 默认情况下，它不会自动重新连接。

HubConnection connection= new HubConnectionBuilder()
    .WithUrl(new Uri("http://127.0.0.1:5000/chathub"))
    .WithAutomaticReconnect()
    .Build();

在没有任何参数的情况下，WithAutomaticReconnect() 将客户端配置为在每次尝试重新连接之前分别等待 0、2、10 和 30 秒，在四次尝试失败后停止。

在开始任何重新连接尝试之前，HubConnection 会转换为 HubConnectionState.Reconnecting 状态，并触发 Reconnecting 事件。 这样就可警告用户连接已丢失，并提醒其禁用 UI 元素。 非交互式应用可以开始排队或删除消息。

connection.Reconnecting += error =>
{
    Debug.Assert(connection.State == HubConnectionState.Reconnecting);

    // Notify users the connection was lost and the client is reconnecting.
    // Start queuing or dropping messages.

    return Task.CompletedTask;
};

如果客户端在其前四次尝试中成功重新连接，则 HubConnection 将转换回 Connected 状态并触发 Reconnected 事件。 这样就可通知用户已重新建立连接并对任何已排队的消息取消排队。

由于连接对服务器来说是全新的，因此将为 ConnectionId 事件处理程序提供一个新的 Reconnected。

connection.Reconnected += connectionId =>
{
    Debug.Assert(connection.State == HubConnectionState.Connected);

    // Notify users the connection was reestablished.
    // Start dequeuing messages queued while reconnecting if any.

    return Task.CompletedTask;
};

WithAutomaticReconnect() 不会将 HubConnection 配置为重试初始启动失败，因此需要手动处理启动失败：

public static async Task<bool> ConnectWithRetryAsync(HubConnection connection, CancellationToken token)
{
    // Keep trying to until we can start or the token is canceled.
    while (true)
    {
        try
        {
            await connection.StartAsync(token);
            Debug.Assert(connection.State == HubConnectionState.Connected);
            return true;
        }
        catch when (token.IsCancellationRequested)
        {
            return false;
        }
        catch
        {
            // Failed to connect, trying again in 5000 ms.
            Debug.Assert(connection.State == HubConnectionState.Disconnected);
            await Task.Delay(5000);
        }
    }
}

如果客户端在其前四次尝试中未成功重新连接，则 HubConnection 将转换为 Disconnected 状态并触发 Closed 事件。 这样就可以尝试手动重启连接或通知用户连接已永久丢失。

connection.Closed += error =>
{
    Debug.Assert(connection.State == HubConnectionState.Disconnected);

    // Notify users the connection has been closed or manually try to restart the connection.

    return Task.CompletedTask;
};

若要在断开连接或更改重新连接时间安排之前配置自定义的重新连接尝试次数，WithAutomaticReconnect 会接受一个数字数组，表示在每次开始尝试重新连接之前要等待的延迟（以毫秒为单位）。

HubConnection connection = new HubConnectionBuilder()
    .WithUrl(new Uri("http://127.0.0.1:5000/chathub"))
    .WithAutomaticReconnect(new[] { TimeSpan.Zero, TimeSpan.Zero, TimeSpan.FromSeconds(10) })
    .Build();

    // .WithAutomaticReconnect(new[] { TimeSpan.Zero, TimeSpan.FromSeconds(2), TimeSpan.FromSeconds(10), TimeSpan.FromSeconds(30) }) yields the default behavior.

前面的示例将 HubConnection 配置为在连接丢失后立即开始尝试重新连接。 这也适用于默认配置。

如果第一次重新连接尝试失败，则第二次重新连接尝试还会立即启动，而不是像在默认配置中一样等待 2 秒钟。

如果第二次重新连接尝试失败，则第三次重新连接尝试将在 10 秒后启动，这与默认配置相同。

自定义行为再次与默认行为不同，它会在第三次重新连接尝试失败后停止。 在默认配置中，会在接下来 30 秒过后再次尝试重新连接。

如果想要更好地控制自动重新连接尝试的时间安排和次数，则 WithAutomaticReconnect 需接受实现 IRetryPolicy 接口的对象，该对象具有一个名为 NextRetryDelay 的方法。

NextRetryDelay 采用一个 RetryContext 类型的参数。 RetryContext 具有三个属性：PreviousRetryCount、ElapsedTime 和 RetryReason，分别为 long、 TimeSpan 和 Exception。 在尝试第一次重新连接之前，PreviousRetryCount 和 ElapsedTime 将为零，RetryReason 将是导致连接丢失的异常。 在每次重试失败后，PreviousRetryCount 的数量将增加一个，并更新 ElapsedTime 以反映截止目前重新连接所花的时间，RetryReason 将是导致最后一个重新连接尝试失败的异常。

NextRetryDelay 必须返回表示在下次重新连接尝试之前等待的时间的 TimeSpan，或者在 null 应停止重新连接的情况下返回 HubConnection。

public class RandomRetryPolicy : IRetryPolicy
{
    private readonly Random _random = new Random();

    public TimeSpan? NextRetryDelay(RetryContext retryContext)
    {
        // If we've been reconnecting for less than 60 seconds so far,
        // wait between 0 and 10 seconds before the next reconnect attempt.
        if (retryContext.ElapsedTime < TimeSpan.FromSeconds(60))
        {
            return TimeSpan.FromSeconds(_random.NextDouble() * 10);
        }
        else
        {
            // If we've been reconnecting for more than 60 seconds so far, stop reconnecting.
            return null;
        }
    }
}

HubConnection connection = new HubConnectionBuilder()
    .WithUrl(new Uri("http://127.0.0.1:5000/chathub"))
    .WithAutomaticReconnect(new RandomRetryPolicy())
    .Build();

或者，你可以编写将手动重新连接客户端的代码，如手动重新连接中所述。