1 Star 7 Fork 6

lizhangjun / nim

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

nim

实时消息推送服务

code style

码云地址:https://gitee.com/Lihangjun/nim.git

项目介绍

qq:1185192813 邮箱:1185192813@qq.com

NIM项目是基于netty的实时消息推送系统,NIM已完成服务端1.0,其客户端web,Android,ios,flutter的SDK将在不久发布。 目前NIM服务端使用springboot搭建,NIM主要具备如下特点:

  • 集群扩展:nim支持横向扩展,更具自身需要,可任意增加服务数量
  • http消息发送:客户端通过API接口发送消息,方便权限控制且通过发布服务接口与其它系统集成
  • 消息持久化:使用mongodb进行持久化(也可自己实现持久化),持久化推送消息以及用户组信息
  • 推送监听:暂支持双通道(redis 订阅/rocketMQ)监听消息,保证消息推送及时性与可达性,使用者也可扩展以及选择监听模式,默认使用redis 订阅消息
  • 多模式推送:支持广播,组播和单播模式
  • 管理与监控(暂未完成):提供对nim连接的监控与管理(包括集群环境),且支持消息管理与拦截发送

架构设计图


使用说明

  1. 根据自身环境修改配置文件application.yml。例如mongo,redis,rocketMQ的配置
  2. netty服务与web服务端口不同,使用者可修改server/xxxxServer.java文件中的port和path来指定连接路径
    @ServerEndpoint(port = "8181", path = "/v1/im/broadcast")
  3. 集群部署可结合nginx代理提供统一连接地址
  4. 消息格式说明:
UNICAST("单播", 1),
MULTICAST("组播", 2),
BROADCAST("广播", 3);
TEXT("文本", 1),
IMAGE("图片", 2),
VOICE("声音", 3),
VIDEO("视频", 4);
AUTH("鉴权", 1),
HANDSHAKE("握手", 2),
HEARTBEAT("心跳", 3),
EXIT("离线", 4),
CLOSE("强制下线", 5),
CHAT("聊天", 6);
/**
 * 消息标识id
 */
private String messageId;
/**
 * 消息时间戳
 */
private Long timestamp;
/**
 * 来源用户id
 */
private String fromUserId;
/**
 * 目标用户id
 */
private String toUserId;
/**
 * 用户组id
 */
private String toGroupId;
/**
 * 数据类型
 */
private Integer mineType;
/**
 * 聊天类型
 */
private Integer chatType;
/**
 * 消息类型
 */
private Integer msgType;
/**
 * 消息标志
 */
private String flag;
/**
 * 消息内容
 */
private String content;
/**
 * 携带数据
 */
private Object extras;

使用示例

design/wobsocket.html提供了web连接测试页面,连接成功后根据api接口发送消息。

  • 发送广播消息
请求地址:http://127.0.0.1:8080/api/v1/common/send
请求头:Content-Type = application/json
请求方法:POST
请求参数:
    {
        "content": "hello,有人吗",
        "extras": null
    }
  • 发送组播消息
请求地址:http://127.0.0.1:8080/v1/im/send
请求头:Content-Type = application/json
请求方法:POST
注意:fromUserId本应在用户鉴权信息中解析而得,这里为了方便测试,由使用者自己设置,如需要使用者可自己添加接口权限控制
请求参数:
    {
        "fromUserId": "123456",
        "content": "hello,有人吗",
        "toGroupId": "11111",
        "extras": null
    }
  • 发送单播消息
请求地址:http://127.0.0.1:8080/v1/im/send
请求头:Content-Type = application/json
请求方法:POST
注意:fromUserId本应在用户鉴权信息中解析而得,这里为了方便测试,由使用者自己设置,如需要使用者可自己添加接口权限控制。若消息发送目标有多个特定用户,可以逗号分隔多个用户id传参
请求参数:
    {
        "fromUserId": "123456",
        "content": "hello,有人吗",
        "toUserId": "1111,2222,3333",
        "extras": null
    }
  • 获取netty服务连接信息
请求地址:http://127.0.0.1:8080/v1/api/count
请求头:Content-Type = application/json
请求方法:GET
响应示例:{"flag":true,"code":2000,"message":"success","data":"广播用户数:0,单播用户数:0,组播用户数:0"}
  • 连接netty服务
广播连接地址:ws://192.168.1.21:8181/v1/im/broadcast
广播连接示例:ws://192.168.1.21:8181/v1/im/broadcast

组播连接地址:ws://192.168.1.21:8181/v1/im/multicast/{userId}/{groupId}
组播连接示例:ws://192.168.1.21:8181/v1/im/multicast/123456/1111

单播连接地址:ws://192.168.1.21:8181/v1/im/unicast/{userId}
单播连接示例:ws://192.168.1.21:8181/v1/im/unicast/123456

下一步计划

  1. 发布SDK及其文档
  2. 提供netty服务监控
  3. 提供容器化一键部署脚本
  4. 增强可扩展性和灵活性
  5. 降低耦合性,提供独立的im中间件以及二次开发接口
  6. 提供更加灵活的配置,使用者根据自己选择组装im服务(多种持久化方案,多种监听通道,多种网络通信服务模式等)

开源许可协议

Apache License 2.0

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

NIM项目是基于netty的实时消息推送系统,支持集群扩展、http消息发送、消息持久化、推送监听、多模式推送以及管理与监控等。 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/Lihangjun/nim.git
git@gitee.com:Lihangjun/nim.git
Lihangjun
nim
nim
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891