开源软件名称:Naruto.WebSocket
开源软件地址:https://gitee.com/haiboi/Naruto.WebSocket
开源软件介绍:
Naruto.WebSocket介绍此项目是使用中间件对WebSocket 进行封装,方便使用 单机10000连接,内存占用220M 软件架构软件架构采用的是.Net Core 6.0 支持- 支持点对点的发送消息,支持群聊消息,支持发送所有人的消息,支持发送指定用户消息,支持集群扩展,支持多租户的模式.
- 支持授权验证
- 用户可以使用NarutoWebSocketEvent处理上下线的事件通知
- 集群版默认使用的redis的发布订阅功能,消息可能存在丢失(后续计划实现ack)
- 目前仅支持文本发送,后续计划更新MessagePack消息协议
使用说明- 核心对象NarutoWebSocketService,处理接收服务的操作,使用者需要继承此对象,实现自己的方法,且方法的访问级别为Public,方法的参数支持无参和实例对象两种,并且方法的返回值必须为Task,并且原生支持DI,生命周期为作用域Scope模式
- 示例 安装Nuget包Naruto.WebSocket, 并注入所需服务和对应的接收服务的对象
//注入服务 services.AddNarutoWebSocket<MyService>(a => { a.Path = new PathString("/ws");//websocket的请求路径 a.AuthorizationFilters.Add(new MyAuthorizationFilters());//追加websocket连接的授权信息 }); - 服务端也可以使用IClientSend<TService>操作消息的发送
- 集群版,安装Nuget包Naruto.WebSocket.Redis,然后还需注入
//注入集群版需要的服务 services.AddNarutoWebSocketRedis(a => a.Connection = new string[] { "127.0.0.1:6379" }); - 消息的发送和接收的都是采用标准的json格式
- 客户端发送接收的消息格式
var msg = { action: "send",//调用的后端/前端的方法,大小写必须一致 message: object//发送的消息内容 消息内容为json对象格式 } webSocket.send(JSON.stringify(msg)); - 客户端当发送的action为HeartbeatCheck,代表执行的心跳检查,客户端应每隔60s执行一次心跳检查
- 当执行的action,无法在后端找到对应的方法的时候,连接将会断开
- 用户可以在创建websocket客户端的时候主动传递一个当前websocket的连接Id,不传递则由后台自动生成
//主动传递一个连接Id的值ConnectionId var webSocket = new WebSocket("ws://localhost:5003/ws?ConnectionId=12345678"); 参与贡献- Fork 本仓库
- 新建 Feat_xxx 分支
- 提交代码
- 新建 Pull Request
|
请发表评论