.NET Core 基于Websocket的在线聊天室实现

2023-07-29 19:03:04 297

什么是Websocket

我们在传统的客户端程序要实现实时双工通讯第一想到的技术就是socket通讯，但是在web体系是用不了socket通讯技术的，因为http被设计成无状态，每次跟服务器通讯完成后就会断开连接。

在没有websocket之前web系统如果要做双工通讯往往使用httplongpolling技术。httplongpolling每次往服务器发送请求后，服务端不会立刻返回信息来结束请求，而是一直挂着直到有数据需要返回，或者等待超时了才会返回。客户端在结束上一次请求后立刻再发送一次请求，如此反复。httplongpolling虽然能实现web系统的双工通讯，但是有个很大的问题，就是基于http协议客户端每次发送请求都需要携带巨大的头部。在并发交互少量数据的时候非常不划算，对服务器资源的消耗也是巨大的。

websocket很好的改善了以上问题。它基于tcp重新设计了一套协议，同时又兼容http，默认跟http一样使用80/443端口。

websocket链接建立本质上就是一次http请求，直接使用http协议的upgrade头来标识这是一次websocket请求，服务端回复101状态码表示“握手”成功。

//客户端请求
GET/HTTP/1.1
Upgrade:websocket
Connection:Upgrade
Host:example.com
Origin:http://example.com
Sec-WebSocket-Key:sN9cRrP/n9NdMgdcy2VJFQ==
Sec-WebSocket-Version:13

//服务端响应
HTTP/1.1101SwitchingProtocols
Upgrade:websocket
Connection:Upgrade
Sec-WebSocket-Accept:fFBooB7FAkLlXgRSz0BT3v4hq5s=
Sec-WebSocket-Location:ws://example.com/

使用asp.netcore来处理websocket

上面我们简单的了解了websocket，那么如何来使用asp.netcore处理websocket呢？因为websocket的握手就是一次http请求，那么我们就可以使用一个middleware来拦截websocket的请求，把建立的链接统一进行管理，其实微软已经帮我们简单的封装过了。

新建一个asp.netcore网站

新建WebsocketHandlerMiddleware中间件

这个中间件就是我们管理websocket链接的入口，我们调用context.WebSockets.AcceptWebSocketAsync()方法把请求转换为websocket链接。

在Invoke方法内接收websocket链接

publicasyncTaskInvoke(HttpContextcontext)
{
if(context.Request.Path=="/ws")
{
if(context.WebSockets.IsWebSocketRequest)
{
WebSocketwebSocket=awaitcontext.WebSockets.AcceptWebSocketAsync();
stringclientId=Guid.NewGuid().ToString();;
varwsClient=newWebsocketClient
{
Id=clientId,
WebSocket=webSocket
};
try
{
awaitHandle(wsClient);
}
catch(Exceptionex)
{
_logger.LogError(ex,"Echowebsocketclient{0}err.",clientId);
awaitcontext.Response.WriteAsync("closed");
}
}
else
{
context.Response.StatusCode=404;
}
}
else
{
await_next(context);
}
}

在Hanle方法等待客户端的消息

privateasyncTaskHandle(WebsocketClientwebSocket)
{
WebsocketClientCollection.Add(webSocket);
_logger.LogInformation($"Websocketclientadded.");

WebSocketReceiveResultresult=null;
do
{
varbuffer=newbyte[1024*1];
result=awaitwebSocket.WebSocket.ReceiveAsync(newArraySegment(buffer),CancellationToken.None);
if(result.MessageType==WebSocketMessageType.Text&&!result.CloseStatus.HasValue)
{
varmsgString=Encoding.UTF8.GetString(buffer);
_logger.LogInformation($"WebsocketclientReceiveAsyncmessage{msgString}.");
varmessage=JsonConvert.DeserializeObject(msgString);
message.SendClientId=webSocket.Id;
MessageRoute(message);
}
}
while(!result.CloseStatus.HasValue);
WebsocketClientCollection.Remove(webSocket);
_logger.LogInformation($"Websocketclientclosed.");
}

在MessageRoute方法内对客户端的消息进行转发

对客户端的消息定义几个标准的action，对不同的action进行特定的处理，比如加入房间、离开房间、在房间内广播消息等。

privatevoidMessageRoute(Messagemessage)
{
varclient=WebsocketClientCollection.Get(message.SendClientId);
switch(message.action)
{
case"join":
client.RoomNo=message.msg;
client.SendMessageAsync($"{message.nick}joinroom{client.RoomNo}success.");
_logger.LogInformation($"Websocketclient{message.SendClientId}joinroom{client.RoomNo}.");
break;
case"send_to_room":
if(string.IsNullOrEmpty(client.RoomNo))
{
break;
}
varclients=WebsocketClientCollection.GetRoomClients(client.RoomNo);
clients.ForEach(c=>
{
c.SendMessageAsync(message.nick+":"+message.msg);
});
_logger.LogInformation($"Websocketclient{message.SendClientId}sendmessage{message.msg}toroom{client.RoomNo}");

break;
case"leave":
varroomNo=client.RoomNo;
client.RoomNo="";
client.SendMessageAsync($"{message.nick}leaveroom{roomNo}success.");
_logger.LogInformation($"Websocketclient{message.SendClientId}leaveroom{roomNo}");
break;
default:
break;
}
}

新建WebsocketClientCollection管理类

这个类是个容器，用来存放所有的websocket链接，便于统一管理。

publicclassWebsocketClientCollection
{
privatestaticList_clients=newList();

publicstaticvoidAdd(WebsocketClientclient)
{
_clients.Add(client);
}

publicstaticvoidRemove(WebsocketClientclient)
{
_clients.Remove(client);
}

publicstaticWebsocketClientGet(stringclientId)
{
varclient=_clients.FirstOrDefault(c=>c.Id==clientId);

returnclient;
}

publicstaticListGetRoomClients(stringroomNo)
{
varclient=_clients.Where(c=>c.RoomNo==roomNo);
returnclient.ToList();
}
}

在Startup中使用中间件

有了上面的中间件，我们需要use一下。

app.UseWebSockets(newWebSocketOptions
{
KeepAliveInterval=TimeSpan.FromSeconds(60),
ReceiveBufferSize=1*1024
});
app.UseMiddleware();

到此我们的服务端基本完成了，下面进行客户端html跟JavaScript的编写。

编写客户端界面

修改index.cshtml来实现一个简单的聊天室ui。


roomno:joinroomleaveroom

nickname:

send

.NET Core 基于Websocket的在线聊天室实现

热门推荐

随机推荐