.Net Core SignalR - 连接超时 - 心跳定时器 - 连接状态变化处理
.Net Core SignalR - connection timeout - heartbeat timer - connection state change handling
事先说明一下,这个问题是关于 .Net Core SignalR 的,而不是以前的版本。
新的 SignalR 在 IIS 背后的 WebSockets 有问题(我无法让它们在 Chrome/Win7/IIS express 上工作)。因此,我改用服务器发送事件 (SSE)。
然而,问题是那些在大约 2 分钟后超时,连接状态从 2 变为 3。自动重新连接已被删除(显然它在以前的版本中效果不佳)。
我现在想实现一个心跳计时器来阻止客户端超时,每 30 秒计时一次就可以完成这项工作。
11 月 10 日更新
我现在已经设法实现了服务器端 Heartbeat,基本上取自 Ricardo Peres 的 https://weblogs.asp.net/ricardoperes/signalr-in-asp-net-core
- 在startup.cs中,添加到
public void Configure(IApplicationBuilder app, IHostingEnvironment env, IServiceProvider serviceProvider)
app.UseSignalR(routes =>
{
routes.MapHub<TheHubClass>("signalr");
});
TimerCallback SignalRHeartBeat = async (x) => {
await serviceProvider.GetService<IHubContext<TheHubClass>>().Clients.All.InvokeAsync("Heartbeat", DateTime.Now); };
var timer = new Timer(SignalRHeartBeat).Change(TimeSpan.FromSeconds(0), TimeSpan.FromSeconds(30));
- 中心Class
对于集线器Class,我添加了public async Task HeartBeat(DateTime now) => await Clients.All.InvokeAsync("Heartbeat", now);
显然,计时器、发送的数据(我只是发送 DateTime)和客户端方法名称都可以不同。
更新 .Net Core 2.1+
见下方评论;不应再使用计时器回调。我现在已经实现了一个 IHostedService(或者更确切地说是抽象的 BackgroundService)来做到这一点:
public class HeartBeat : BackgroundService
{
private readonly IHubContext<SignalRHub> _hubContext;
public HeartBeat(IHubContext<SignalRHub> hubContext)
{
_hubContext = hubContext;
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
while (!stoppingToken.IsCancellationRequested)
{
await _hubContext.Clients.All.SendAsync("Heartbeat", DateTime.Now, stoppingToken);
await Task.Delay(30000, stoppingToken);
}
}
}
在您的启动程序 class 中,在 services.AddSignalR();
:
之后连接它
services.AddHostedService<HeartBeat>();
- 客户
var connection = new signalR.HubConnection("/signalr", { transport: signalR.TransportType.ServerSentEvents });
connection.on("Heartbeat", serverTime => { console.log(serverTime); });
初题剩余部分
剩下的就是如何正确的重新连接客户端,例如IO 暂停后(浏览器的计算机进入休眠状态、失去连接、更换 Wifi 或其他)
我已经实现了一个正常工作的客户端 Heartbeat,至少在连接中断之前是这样:
- 中心Class:
public async Task HeartBeatTock() => await Task.CompletedTask;
客户:
var heartBeatTockTimer;
函数 sendHeartBeatTock() {
connection.invoke("HeartBeatTock");
}
connection.start().then(args => {
heartBeatTockTimer = setInterval(sendHeartBeatTock, 10000);
});
例如,在浏览器挂起 IO 之后,invoke 方法会抛出一个异常 - 它不能被简单的 try/catch 捕获,因为它是异步的。
我试图为我的 HeartBeatTock 做的是(伪代码):
function sendHeartBeatTock
try connection.invoke("HeartbeatTock)
catch exception
try connection.stop()
catch exception (and ignore it)
finally
connection = new HubConnection().start()
repeat try connection.invoke("HeartbeatTock")
catch exception
log("restart did not work")
clearInterval(heartBeatTockTimer)
informUserToRefreshBrowser()
现在,由于一些原因,这不起作用。由于 运行 异步,invoke 在代码块执行后抛出异常。它看起来好像公开了一个 .catch() 方法,但我不确定如何在那里正确地实现我的想法。
另一个原因是开始新连接需要我重新实现所有服务器调用,例如 "connection.on("send"...) - 这看起来很愚蠢。
任何关于如何正确实现重新连接客户端的提示都将不胜感激。
这是一个 issue when 运行 IIS 后面的 SignalR 核心。 IIS 将在 2 分钟后关闭空闲连接。长期计划是添加保持活动消息,作为副作用,它会阻止 IIS 关闭连接。要暂时解决此问题,您可以:
- 定期向客户发送消息
- 在此处
将 IIS 中的空闲超时设置更改为 described
- 如果关闭,请在客户端重新启动连接
- 使用不同的传输方式(例如长轮询,因为您不能在 IIS 后面的 Win7/Win2008 R2 上使用 webSockets)
我现在有了一个可行的解决方案(目前已在 Chrome 和 FF 中测试)。希望能够激励您想出更好的东西,或者在您自己想出这样的东西时为您节省一点时间,我在这里发布我的解决方案:
Heartbeat-"Tick" 消息(服务器定期 ping 客户端)在上面的问题中有描述。
客户端("Tock" 部分)现在有:
- 注册连接的函数,以便回调方法(connection.on())可以重复;重新启动 "new HubConnection" 否则
他们就会丢失
- 注册TockTimer的函数
- 以及实际发送 Tock ping 的函数
tock 方法在发送时捕获错误,并尝试启动新连接。由于计时器保持 运行,我正在注册一个新连接,然后简单地坐下来等待下一次调用。
把客户放在一起:
// keeps the connection object
var connection = null;
// stores the ID from SetInterval
var heartBeatTockTimer = 0;
// how often should I "tock" the server
var heartBeatTockTimerSeconds = 10;
// how often should I retry after connection loss?
var maxRetryAttempt = 5;
// the retry should wait less long then the TockTimer, or calls may overlap
var retryWaitSeconds = heartBeatTockTimerSeconds / 2;
// how many retry attempts did we have?
var currentRetryAttempt = 0;
// helper function to wait a few seconds
$.wait = function(miliseconds) {
var defer = $.Deferred();
setTimeout(function() { defer.resolve(); }, miliseconds);
return defer;
};
// first routine start of the connection
registerSignalRConnection();
function registerSignalRConnection() {
++currentRetryAttempt;
if (currentRetryAttempt > maxRetryAttempt) {
console.log("Clearing registerHeartBeatTockTimer");
clearInterval(heartBeatTockTimer);
heartBeatTockTimer = 0;
throw "Retry attempts exceeded.";
}
if (connection !== null) {
console.log("registerSignalRConnection was not null", connection);
connection.stop().catch(err => console.log(err));
}
console.log("Creating new connection");
connection = new signalR.HubConnection("/signalr", { transport: signalR.TransportType.ServerSentEvents });
connection.on("Heartbeat", serverTime => { console.log(serverTime); });
connection.start().then(() => {
console.log("Connection started, starting timer.");
registerHeartBeatTockTimer();
}).catch(exception => {
console.log("Error connecting", exception, connection);
});
}
function registerHeartBeatTockTimer() {
// make sure we're registered only once
if (heartBeatTockTimer !== 0) return;
console.log("Registering registerHeartBeatTockTimer");
if (connection !== null)
heartBeatTockTimer = setInterval(sendHeartBeatTock, heartBeatTockTimerSeconds * 1000);
else
console.log("Connection didn't allow registry");
}
function sendHeartBeatTock() {
console.log("Standard attempt HeartBeatTock");
connection.invoke("HeartBeatTock").then(() => {
console.log("HeartbeatTock worked.") })
.catch(err => {
console.log("HeartbeatTock Standard Error", err);
$.wait(retryWaitSeconds * 1000).then(function() {
console.log("executing attempt #" + currentRetryAttempt.toString());
registerSignalRConnection();
});
console.log("Current retry attempt: ", currentRetryAttempt);
});
}
基于 ExternalUse 的客户端版本 ...
import * as signalR from '@aspnet/signalr'
import _ from 'lodash'
var connection = null;
var sendHandlers = [];
var addListener = f => sendHandlers.push(f);
function registerSignalRConnection() {
if (connection !== null) {
connection.stop().catch(err => console.log(err));
}
connection = new signalR.HubConnectionBuilder()
.withUrl('myHub')
.build();
connection.on("Heartbeat", serverTime =>
console.log("Server heartbeat: " + serverTime));
connection.on("Send", data =>
_.each(sendHandlers, value => value(data)));
connection.start()
.catch(exception =>
console.log("Error connecting", exception, connection));
}
registerSignalRConnection();
setInterval(() =>
connection.invoke("HeartBeatTock")
.then(() => console.log("Client heatbeat."))
.catch(err => {
registerSignalRConnection();
}), 10 * 1000);
export { addListener };
事先说明一下,这个问题是关于 .Net Core SignalR 的,而不是以前的版本。
新的 SignalR 在 IIS 背后的 WebSockets 有问题(我无法让它们在 Chrome/Win7/IIS express 上工作)。因此,我改用服务器发送事件 (SSE)。 然而,问题是那些在大约 2 分钟后超时,连接状态从 2 变为 3。自动重新连接已被删除(显然它在以前的版本中效果不佳)。
我现在想实现一个心跳计时器来阻止客户端超时,每 30 秒计时一次就可以完成这项工作。
11 月 10 日更新
我现在已经设法实现了服务器端 Heartbeat,基本上取自 Ricardo Peres 的 https://weblogs.asp.net/ricardoperes/signalr-in-asp-net-core
- 在startup.cs中,添加到
public void Configure(IApplicationBuilder app, IHostingEnvironment env, IServiceProvider serviceProvider)
app.UseSignalR(routes =>
{
routes.MapHub<TheHubClass>("signalr");
});
TimerCallback SignalRHeartBeat = async (x) => {
await serviceProvider.GetService<IHubContext<TheHubClass>>().Clients.All.InvokeAsync("Heartbeat", DateTime.Now); };
var timer = new Timer(SignalRHeartBeat).Change(TimeSpan.FromSeconds(0), TimeSpan.FromSeconds(30));
- 中心Class
对于集线器Class,我添加了public async Task HeartBeat(DateTime now) => await Clients.All.InvokeAsync("Heartbeat", now);
显然,计时器、发送的数据(我只是发送 DateTime)和客户端方法名称都可以不同。
更新 .Net Core 2.1+
见下方评论;不应再使用计时器回调。我现在已经实现了一个 IHostedService(或者更确切地说是抽象的 BackgroundService)来做到这一点:
public class HeartBeat : BackgroundService
{
private readonly IHubContext<SignalRHub> _hubContext;
public HeartBeat(IHubContext<SignalRHub> hubContext)
{
_hubContext = hubContext;
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
while (!stoppingToken.IsCancellationRequested)
{
await _hubContext.Clients.All.SendAsync("Heartbeat", DateTime.Now, stoppingToken);
await Task.Delay(30000, stoppingToken);
}
}
}
在您的启动程序 class 中,在 services.AddSignalR();
:
services.AddHostedService<HeartBeat>();
- 客户
var connection = new signalR.HubConnection("/signalr", { transport: signalR.TransportType.ServerSentEvents });
connection.on("Heartbeat", serverTime => { console.log(serverTime); });
初题剩余部分
剩下的就是如何正确的重新连接客户端,例如IO 暂停后(浏览器的计算机进入休眠状态、失去连接、更换 Wifi 或其他)
我已经实现了一个正常工作的客户端 Heartbeat,至少在连接中断之前是这样:
- 中心Class:
public async Task HeartBeatTock() => await Task.CompletedTask;
客户:
var heartBeatTockTimer; 函数 sendHeartBeatTock() { connection.invoke("HeartBeatTock"); } connection.start().then(args => { heartBeatTockTimer = setInterval(sendHeartBeatTock, 10000); });
例如,在浏览器挂起 IO 之后,invoke 方法会抛出一个异常 - 它不能被简单的 try/catch 捕获,因为它是异步的。 我试图为我的 HeartBeatTock 做的是(伪代码):
function sendHeartBeatTock
try connection.invoke("HeartbeatTock)
catch exception
try connection.stop()
catch exception (and ignore it)
finally
connection = new HubConnection().start()
repeat try connection.invoke("HeartbeatTock")
catch exception
log("restart did not work")
clearInterval(heartBeatTockTimer)
informUserToRefreshBrowser()
现在,由于一些原因,这不起作用。由于 运行 异步,invoke 在代码块执行后抛出异常。它看起来好像公开了一个 .catch() 方法,但我不确定如何在那里正确地实现我的想法。 另一个原因是开始新连接需要我重新实现所有服务器调用,例如 "connection.on("send"...) - 这看起来很愚蠢。
任何关于如何正确实现重新连接客户端的提示都将不胜感激。
这是一个 issue when 运行 IIS 后面的 SignalR 核心。 IIS 将在 2 分钟后关闭空闲连接。长期计划是添加保持活动消息,作为副作用,它会阻止 IIS 关闭连接。要暂时解决此问题,您可以:
- 定期向客户发送消息
- 在此处 将 IIS 中的空闲超时设置更改为 described
- 如果关闭,请在客户端重新启动连接
- 使用不同的传输方式(例如长轮询,因为您不能在 IIS 后面的 Win7/Win2008 R2 上使用 webSockets)
我现在有了一个可行的解决方案(目前已在 Chrome 和 FF 中测试)。希望能够激励您想出更好的东西,或者在您自己想出这样的东西时为您节省一点时间,我在这里发布我的解决方案:
Heartbeat-"Tick" 消息(服务器定期 ping 客户端)在上面的问题中有描述。 客户端("Tock" 部分)现在有:
- 注册连接的函数,以便回调方法(connection.on())可以重复;重新启动 "new HubConnection" 否则 他们就会丢失
- 注册TockTimer的函数
- 以及实际发送 Tock ping 的函数
tock 方法在发送时捕获错误,并尝试启动新连接。由于计时器保持 运行,我正在注册一个新连接,然后简单地坐下来等待下一次调用。 把客户放在一起:
// keeps the connection object
var connection = null;
// stores the ID from SetInterval
var heartBeatTockTimer = 0;
// how often should I "tock" the server
var heartBeatTockTimerSeconds = 10;
// how often should I retry after connection loss?
var maxRetryAttempt = 5;
// the retry should wait less long then the TockTimer, or calls may overlap
var retryWaitSeconds = heartBeatTockTimerSeconds / 2;
// how many retry attempts did we have?
var currentRetryAttempt = 0;
// helper function to wait a few seconds
$.wait = function(miliseconds) {
var defer = $.Deferred();
setTimeout(function() { defer.resolve(); }, miliseconds);
return defer;
};
// first routine start of the connection
registerSignalRConnection();
function registerSignalRConnection() {
++currentRetryAttempt;
if (currentRetryAttempt > maxRetryAttempt) {
console.log("Clearing registerHeartBeatTockTimer");
clearInterval(heartBeatTockTimer);
heartBeatTockTimer = 0;
throw "Retry attempts exceeded.";
}
if (connection !== null) {
console.log("registerSignalRConnection was not null", connection);
connection.stop().catch(err => console.log(err));
}
console.log("Creating new connection");
connection = new signalR.HubConnection("/signalr", { transport: signalR.TransportType.ServerSentEvents });
connection.on("Heartbeat", serverTime => { console.log(serverTime); });
connection.start().then(() => {
console.log("Connection started, starting timer.");
registerHeartBeatTockTimer();
}).catch(exception => {
console.log("Error connecting", exception, connection);
});
}
function registerHeartBeatTockTimer() {
// make sure we're registered only once
if (heartBeatTockTimer !== 0) return;
console.log("Registering registerHeartBeatTockTimer");
if (connection !== null)
heartBeatTockTimer = setInterval(sendHeartBeatTock, heartBeatTockTimerSeconds * 1000);
else
console.log("Connection didn't allow registry");
}
function sendHeartBeatTock() {
console.log("Standard attempt HeartBeatTock");
connection.invoke("HeartBeatTock").then(() => {
console.log("HeartbeatTock worked.") })
.catch(err => {
console.log("HeartbeatTock Standard Error", err);
$.wait(retryWaitSeconds * 1000).then(function() {
console.log("executing attempt #" + currentRetryAttempt.toString());
registerSignalRConnection();
});
console.log("Current retry attempt: ", currentRetryAttempt);
});
}
基于 ExternalUse 的客户端版本
import * as signalR from '@aspnet/signalr'
import _ from 'lodash'
var connection = null;
var sendHandlers = [];
var addListener = f => sendHandlers.push(f);
function registerSignalRConnection() {
if (connection !== null) {
connection.stop().catch(err => console.log(err));
}
connection = new signalR.HubConnectionBuilder()
.withUrl('myHub')
.build();
connection.on("Heartbeat", serverTime =>
console.log("Server heartbeat: " + serverTime));
connection.on("Send", data =>
_.each(sendHandlers, value => value(data)));
connection.start()
.catch(exception =>
console.log("Error connecting", exception, connection));
}
registerSignalRConnection();
setInterval(() =>
connection.invoke("HeartBeatTock")
.then(() => console.log("Client heatbeat."))
.catch(err => {
registerSignalRConnection();
}), 10 * 1000);
export { addListener };