基于.net C#实现websocket前后端消息实时推送
程序员文章站
2022-03-23 16:31:37
一、准备环境 IIS需支持websocket协议，同时需要配置进行如下配置 websocket 宿主配置完成。 二、实现方法 我采用两种方式进行测试： 1、基于webapi...
一、准备环境
IIS需支持websocket协议，同时需要配置进行如下配置
websocket 宿主配置完成。
二、实现方法
我采用两种方式进行测试：
1、基于webapi作为服务端
2、一般处理程序作为服务端
两种形式，实际都一样，只不过相对于客户端来说，请求路径和方式不同而已。
最主要的还是websoket组件部分，这里使用的是第三方的组件Fleck实现，有了这个组件很容易实现websocket服务创建了。如下：
using Fleck;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
namespace WebSocketTest.DAL
{
public class TestSocket
{
private string msg = "默认信息";
public void socketServer() {
string serverIP = System.Configuration.ConfigurationManager.AppSettings["serverIP"];
var allSockets = new List<IWebSocketConnection>();
var server = new WebSocketServer(serverIP);
server.Start(socket =>//服务开始
{
socket.OnOpen = () =>
{
Console.WriteLine("Open!");
allSockets.Add(socket);
};
socket.OnClose = () =>
{
Console.WriteLine("Close!");
allSockets.Remove(socket);
};
socket.OnMessage = message =>
{ //客户端交互的消息
System.Timers.Timer t = new System.Timers.Timer(1000);//实例化Timer类，设置间隔时间为10000毫秒；
t.Elapsed += new System.Timers.ElapsedEventHandler(theout);//到达时间的时候执行事件；
t.AutoReset = true;//设置是执行一次（false）还是一直执行(true)；
t.Enabled = true;//是否执行System.Timers.Timer.Elapsed事件；
allSockets.ToList().ForEach(s => s.Send("Echo: " + msg));
};
});
}
public void theout(object source, System.Timers.ElapsedEventArgs e)
{
msg = GetRandomString();
}
///<summary>
///生成随机字符串 --用于测试随机发送
///</summary>
///<param name="length">目标字符串的长度</param>
///<param name="useNum">是否包含数字，1=包含，默认为包含</param>
///<param name="useLow">是否包含小写字母，1=包含，默认为包含</param>
///<param name="useUpp">是否包含大写字母，1=包含，默认为包含</param>
///<param name="useSpe">是否包含特殊字符，1=包含，默认为不包含</param>
///<param name="custom">要包含的自定义字符，直接输入要包含的字符列表</param>
///<returns>指定长度的随机字符串</returns>
public static string GetRandomString()
{
byte[] b = new byte[4];
new System.Security.Cryptography.RNGCryptoServiceProvider().GetBytes(b);
Random r = new Random(BitConverter.ToInt32(b, 0));
string s = null, str ="";
str += "我们都有一个家abcdefghijklmnopqrstuvwxyz123456789";
for (int i = 0; i < 15; i++)
{
s += str.Substring(r.Next(0, str.Length - 1), 1);
}
return s;
}
}
}
配置文件部分
<appSettings>
<add key="webpages:Version" value="3.0.0.0" />
<add key="webpages:Enabled" value="false" />
<add key="ClientValidationEnabled" value="true" />
<add key="UnobtrusiveJavaScriptEnabled" value="true" />
<!--用于配置websocket通信的地址 var server = new WebSocketServer(serverIP);-->
<add key="serverIP" value="ws://127.0.0.1:8881" />
</appSettings>
webapi代码如下
[RoutePrefix("api/server")]
public class ValuesController : ApiController
{
[HttpGet,Route("getmsg")]
public void getmsg() {
TestSocket t = new TestSocket();//调用websocket工具类
t.socketServer();
}
}
一般处理程序代码如下：
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using WebSocketTest.DAL;
namespace WebSocketTest
{
/// <summary>
/// test 的摘要说明
/// </summary>
public class test : IHttpHandler
{
public void ProcessRequest(HttpContext context)
{
TestSocket t = new TestSocket();
t.socketServer();
}
public bool IsReusable
{
get
{
return false;
}
}
}
}
前端页面部分
<html>
<head>
<meta charset="UTF-8"></meta>
<title>.net项目WebSocket</title>
</head>
<body>
<h3>.net项目WebSocket</h3>
<h4>测试说明</h4>
<h5>文本框中数据数据，点击‘发送测试’，文本框中的数据会发送到后台websocket，后台接受到之后，会再推送数据到前端，展示在下方；点击关闭连接，可以关闭该websocket；可以跟踪代码，了解具体的流程；代码上有详细注解</h5>
<br />
<input id="text" type="text" />
<button onclick="send()">发送测试</button>
<hr />
<button onclick="clos()">关闭连接</button>
<hr />
<div id="message"></div>
<script>
var websocket = null;
if('WebSocket' in window){
websocket = new WebSocket("ws://127.0.0.1:8888/test.ashx");//服务端访问的路径，如果是webapi则用api路由路径即可
}else{
alert("您的浏览器不支持websocket");
}
websocket.onerror = function(){
setMessageInHtml("send error！");
}
websocket.onopen = function () {
setMessageInHtml("connection success！")
}
websocket.onmessage = function(event){
setMessageInHtml(event.data);
}
websocket.onclose = function(){
setMessageInHtml("closed websocket!")
}
window.onbeforeunload = function(){
clos();
}
function setMessageInHtml(message){
document.getElementById('message').innerHTML += message;
}
function clos(){
websocket.close(3000,"强制关闭");
}
function send(){
var msg = document.getElementById('text').value;
websocket.send(msg);
}
</script>
</body>
</html>
备注：该页面的内容我是用的别人写的，自己没写，目的看看效果，由衷感谢那位朋友！
效果展示
随机打印出一大堆随机字符串，测试通过。