.net Core 中间件实现WebSocket通讯
文章目录
- 前言
- 一、WebSocket是什么？
- 二、.net Core 中使用WebSocket
-
- 1.创建保存 WebSocket 的类
- 2.创建管理和操作 WebSocket 的基类
- 3.创建 WebSocket 的中间件
- 4.创建 WebSocket 管理子类
- 5.创建注入扩展
- 6.配置 Startup.cs
- 7.测试
前言
最近有用的websocket通讯功能，在此记录一下。
一、WebSocket是什么？
Websocket是一种网络通信协议，是一个在计算机里专门在【两点】之间传输数据的约定和规范。
由于HTTP协议存在一个缺陷，即 通信只能由客户端发起。
但是实际上，如果服务器有连续的状态变化，客户端要获取信息就非常的麻烦，只能采用“轮询”：每隔一段时间，就发出一次询问，了解服务器有么有新的信息。这就会导致效率低下，且浪费资源。（因为没查看一次服务器是否有新消息时，就要建立tcp连接）
WebSocket 就是基于Http协议，或者说借用Http协议来完成一部分握手。
注意： WebSocket 没有同源限制，客户端可以与任意服务器通信，也就不用考虑跨域的问题
二、.net Core 中使用WebSocket
1.创建保存 WebSocket 的类
该类用于保存所有的 WebSocket 连接
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
using System.Net.WebSockets;
using System.Threading;
using System.Threading.Tasks;
namespace WebAPI.Socket
{
/// 2.创建管理和操作 WebSocket 的基类
该类旨在处理 socket 的连接和断连，以及接收和发送消息，属于基类。
using Newtonsoft.Json;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Net.WebSockets;
using System.Reflection;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
namespace WebAPI.Socket
{
/// 3.创建 WebSocket 的中间件
using Microsoft.AspNetCore.Http;
using Newtonsoft.Json;
using System;
using System.IO;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using System.Linq;
using System.Collections.Generic;
namespace WebAPI.Socket
{
/// 4.创建 WebSocket 管理子类
可以创建多个，用于个性化设置，主要是上面设置了接收的抽象方法，所以必须要重写 Receive 方法。如果不需要的话，其实把基类的抽象去掉，直接在基类中写也可以。
namespace ACH_Sampleonline.WebAPI.Socket
{
/// 5.创建注入扩展
直接在 Startup.cs 中写也无不可，但这是好习惯，将每个注入内容单独写到文件。
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using System.Reflection;
namespace WebAPI.Socket
{
/// 6.配置 Startup.cs
将上面的内容注入到启动项中即可。
在 ConfigureServices 中添加：
services.AddWebSocketManager();
在 Configure 中添加：
// Socket通讯
app.UseWebSockets();
app.MapWebSocketManager("/ws", app.ApplicationServices.GetService<BusMessageHandler>());
即可。如果提示serviceProvider找不到，在 Configure 的参数中添加：
IServiceProvider serviceProvider
7.测试
前端代码样例：
DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>测试title>
head>
<body>
<div id="message" style="border: solid 1px #333; padding: 4px; width: 550px; overflow: auto; background-color: #404040; height: 300px; margin-bottom: 8px; font-size: 14px;">
div>
<input id="text" type="text" onkeypress="enter(event);" style="width: 340px" />
<button id="send" onclick="send();">发送button>
<button onclick="quit();">停止button>
body>
html>
<script type="text/javascript">
var ws;
var msgContainer = document.getElementById('message');
var text = document.getElementById('text');
window.onload = function () {
ws = new WebSocket("ws://localhost:5056/ws?userName=张三&editId=" + "12345678");
ws.onopen = function (e) {
var msg = document.createElement('div');
msg.style.color = '#0f0';
msg.innerhtml = "server > connection open.";
msgcontainer.appendChild(msg);
};
ws.onmessage = function (e) {
console.log(e, "onmessage");
var msg = document.createElement('div');
msg.style.color = '#0f0';
msg.innerHTML = e.data;
msgContainer.appendChild(msg);
msgContainer.scrollTop = msgContainer.scrollHeight;
};
ws.onerror = function (e) {
console.log(e, "onerror");
var msg = document.createElement('div');
msg.style.color = '#0f0';
msg.innerHTML = 'Server > ' + e.data;
msgContainer.appendChild(msg);
};
ws.onclose = function (e) {
var msg = document.createElement('div');
msg.style.color = '#0f0';
msg.innerHTML = 'Server > connection closed.';
msgContainer.appendChild(msg);
ws = null;
};
}
function quit() {
if (ws) {
ws.close();
var msg = document.createElement('div');
msg.style.color = '#0f0';
msg.innerHTML = 'Server >start closed.';
msgContainer.appendChild(msg);
ws = null;
}
}
function send() {
ws.send(text.value);
var htmlValue = "客户端: " + text.value + " " + getNowTime();
var msg = document.createElement('div');
msg.style.color = '#ffff00';
msg.innerHTML = htmlValue;
msgContainer.appendChild(msg);
text.value = "";
msgContainer.scrollTop = msgContainer.scrollHeight;
}
function enter(event) {
if (event.keyCode == 13) {
send();
}
}
//获取当前时间
function getNowTime() {
var date = new Date();
//年 getFullYear()：四位数字返回年份
var year = date.getFullYear(); //getFullYear()代替getYear()
//月 getMonth()：0 ~ 11
var month = date.getMonth() + 1;
//日 getDate()：(1 ~ 31)
var day = date.getDate();
//时 getHours()：(0 ~ 23)
var hour = date.getHours();
//分 getMinutes()： (0 ~ 59)
var minute = date.getMinutes();
//秒 getSeconds()：(0 ~ 59)
var second = date.getSeconds();
var time = year + '/' + addZero(month) + '/' + addZero(day) + ' ' + addZero(hour) + ':' + addZero(minute) + ':' + addZero(second);
return time;
}
//小于10的拼接上0字符串
function addZero(s) {
return s < 10 ? ('0' + s) : s;
}
script>
参考链接：https://blog.csdn.net/wulex/article/details/115548474