6 Star 44 Fork 18

张海波 / Naruto.WebSocket

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

Naruto.WebSocket

介绍

此项目思路借鉴微软的signalr项目,为了帮助快速了解signalr的基本原理 使用中间件对WebSocket 进行封装,方便使用
单机10000连接,内存占用220M

软件架构

软件架构采用的是.Net Core 6.0

支持

  1. 支持点对点的发送消息,支持群聊消息,支持发送所有人的消息,支持发送指定用户消息,支持集群扩展,支持多租户的模式.
  2. 支持授权验证
  3. 用户可以使用NarutoWebSocketEvent处理上下线的事件通知
  4. 集群版默认使用的redis的发布订阅功能,消息可能存在丢失(后续计划实现ack)
  5. 目前仅支持文本发送,后续计划更新MessagePack消息协议

使用说明

  1. 核心对象NarutoWebSocketService,处理接收服务的操作,使用者需要继承此对象,实现自己的方法,且方法的访问级别为Public,方法的参数支持无参和实例对象两种,并且方法的返回值必须为Task,并且原生支持DI,生命周期为作用域Scope模式
  2. 示例 安装Nuget包Naruto.WebSocket, 并注入所需服务和对应的接收服务的对象
            //注入服务
            services.AddNarutoWebSocket<MyService>(a =>
            {
                a.Path = new PathString("/ws");//websocket的请求路径
                a.AuthorizationFilters.Add(new MyAuthorizationFilters());//追加websocket连接的授权信息
            });
  1. 服务端也可以使用IClientSend<TService>操作消息的发送
  2. 集群版,安装Nuget包Naruto.WebSocket.Redis,然后还需注入
            //注入集群版需要的服务
            services.AddNarutoWebSocketRedis(a => a.Connection = new string[] { "127.0.0.1:6379" });

  1. 消息的发送和接收的都是采用标准的json格式
  2. 客户端发送接收的消息格式
     var msg =  {
            action: "send",//调用的后端/前端的方法,大小写必须一致
            message: object//发送的消息内容 消息内容为json对象格式
        }
        webSocket.send(JSON.stringify(msg));
  1. 客户端当发送的action为HeartbeatCheck,代表执行的心跳检查,客户端应每隔60s执行一次心跳检查
  2. 当执行的action,无法在后端找到对应的方法的时候,连接将会断开
  3. 用户可以在创建websocket客户端的时候主动传递一个当前websocket的连接Id,不传递则由后台自动生成
    //主动传递一个连接Id的值ConnectionId
     var webSocket = new WebSocket("ws://localhost:5003/ws?ConnectionId=12345678");

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request
MIT License Copyright (c) 2020 也许所谓 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

一个WebSocket的中间件的消息通讯框架 展开 收起
C# 等 2 种语言
MIT
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
C#
1
https://gitee.com/haiboi/Naruto.WebSocket.git
git@gitee.com:haiboi/Naruto.WebSocket.git
haiboi
Naruto.WebSocket
Naruto.WebSocket
master

搜索帮助