23 Star 216 Fork 90

yueya / yue-im

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

yue-im

介绍

YUE-IM 是使用java开发,基于netty,akka 实现的即时通讯服务。并且提供极简的api,极大的降低开发难度,方便使用者二次开发。

主要特点:

  1. 支持websocket,tcp协议进行通信,消息类型代码,消息内容格式自定义
  2. 支持单机部署,集群部署
  3. 提供极简api,方便开发者二次开发
  4. 得益于akka提供的能力,集群模式只需要简单配置(依赖zookeeper,用于种子节点发现),支持自组建,集群间消息通信不依赖其他消息队列及其他中间件
  5. 支持同一账号,多终端连接,多终端同时接收消息
  6. 支持rest-api推送私聊和群聊消息

软件架构

image

系统选择基于使用netty作为接入服务器,主要是考虑netty作为java里最知名的网络服务器框架,性能,对多种协议的支持,以及开发资料都有保证

集群间通信: 系统集群间通信选择基于Akka来实现,即时通讯集群要解决的最大的问题就是如何把消息投递到目的客户端连接的节点上,目前大部分开源的即时通讯项目基本上都是基于消息队列或者redis的发布订阅来实现跨节点的通信, 或者是维护一个总的路由缓存系统来实现跨节点的通信,本系统基于Akka,通过广播,消息应答及各节点缓存路由来实现集群各节点的通信,不依赖其他系统或中间件,尽量减少不必要的设备资源消耗及网络传输次数, Akka是一套开源工具和运行时,便于构建JVM上的并发应用和分布式应用,自从了解Akka后就一直想基于Akka开发 一个程序,无奈平时并没有什么应用场景用得到,Akka本身的特性是很适合做这种消息服务的,所以选择了Akka,并且集群节点间通信使用protobuf,提高数据传输效率

代码结构

├── imui #示例项目前端测试demo
├── yueim-common # 接口定义,通用配置,依赖
├── yueim-manager # 示例项目,检测端,可部署启动
├── push-sample # 示例项目:即时通讯服务器节点,需部署启动
├── push-server # 即时通讯服务框架,依赖

默认协议结构

  • tcp连接: image

  • websocket连接 websocket连接协议实现的比较简单,走的文本帧

       消息类型代码 + "#" + json文本消息体

使用说明

  yueim-sample : 本地启动ImApplication,访问imui下的index.html页面即可使用demo,完整项目开发完成后放到其他仓库
    示例项目完成了 私聊,群聊,(多媒体,历史消息属于业务范畴,需要自行实现)

示例工程截图

image

image

简易检测端截图

访问manageui下的manage.html即可查看 image 如果开发者想基于本系统开发自己的即时通讯服务,大部分时间只需要实现消息处理器CmdHandler的回调接口即可:

   /**
    * 处理消息前的回调,比如敏感词检测
    * @param msgType 消息类型代码
    * @param message 消息体
    * @param msgId 系统生成的唯一消息id,雪花算法生成
    * @return 如果返回false,后续的回调函数将不会执行
    */
    boolean preMessage(int msgType, byte[] message, long msgId);

   /**
    *  服务器处理消息的回调,处理消息
    * @param ctx 消息服务上下文
    * @param msgType 消息类型代码
    * @param message 消息体
    * @param msgId 系统生成的唯一消息id,雪花算法生成
    */
   void onMessage(ImContext ctx, int msgType, byte[] message, long msgId);

  /**
   * 处理完消息后的回调(响应客户端后触发),比如保存消息到数据库(该回调方法在异步线程内被执行,不会影响消息处理)
   * @param ctx 消息服务上下文
   * @param msgType 消息类型代码
   * @param message 消息体
   * @param msgId 系统生成的唯一消息id,雪花算法生成
  */
   void postMessage(ImContext ctx, int msgType, byte[] message,long msgId);

消息服务context

  在回调里可以调用 ImContext 提供的几个方法发送消息
  /**
      * 客户端与服务器正式建立连接,可在登录成功时调用
      * @param userId 用户id
      * @param device 终端id
      */
     public void connect(String userId,String device);
     
   /**
       *  发送单点消息
       * @param msgId  系统生成的唯一消息id
       * @param msg 消息内容
       * @param msgType 消息类型码
       * @param to  接收者id
       */
      public void sendPointMsg(long msgId,String msg,int msgType,String to);
   
    /**
        *  发送群组消息
        * @param msgId 系统生成的唯一消息id
        * @param msg 消息内容
        * @param msgType 消息类型码
        * @param groupId 群组id
        */
       public void sendGroupMessage(long msgId,String msg,int msgType,String groupId);
       
    /**
    * 服务器给连接的终端发送消息
    * @param msgType 消息类型
    * @param msg 消息内容
    */
      public void sendToClient(int msgType,String msg)

可以按照以下的步骤实现:

  1. 新建一个自己的maven项目
  2. 依赖yueim-server模块,实现自己的消息处理器
    <dependency>
                <groupId>com.yueya</groupId>
                <artifactId>yueim-server</artifactId>
                <version>1.0-SNAPSHOT</version>
    </dependency>
  1. 初始化并启动服务(集群模式记得启动zookeeper) ClusterNodeApp.start("akka.conf",setting); 在启动服务前,需要初始化设置 其中akka.conf是节点配置文件,拷贝示例工程yueim-node里的即可 setting为业务配置类: 开发者需要实现以下几个接口:
    1. BusinessInfoProvider接口,开发者需要实现 提供好友id,群组成员id查询服务的接口
    2. setting.setHandlerMap(Map<String, CmdHandler>) 设置消息类型码(注意:0-10为系统保留的消息类型码,请不要使用)及对应消息类型的处理器类实例
    3. 关键配置说明,详情见示例工程yueim-node
    akka {
      remote {
        netty.tcp {
          hostname = "127.0.0.1"  //  节点IP地址
          port = 2551  //节点集群通信端口
        }
      }
      cluster {
      	roles = ["worker"]
      }
      netty{
        port = 8088  // 终端连接端口
        mode = websocket  //服务模式,tcp:tcp协议节点;websocket:websocket协议节点
        heart_beat = true //是否启用心跳检测,心跳检测间隔20s,心跳超时超过3次,则断开该客户端连接
      }
      zookeeper{
        ip = 127.0.0.1  // zookeeper ip地址
      }
    
      # cluster,single
      node{
        mode = cluster  // 节点运行模式,cluster:集群模式; single:单机模式
      }
    }
     
  2. 如果需要修改消息协议结构,需要修改yueim-server中的相应类

tcp协议修改:TcpMsgDecoder类

websocket协议修改:WebSocketServerHandler类

  1. rest-api发送消息, 请实现RestMsgListener(可对收到的rest-api消息做处理),并在在初始化时传入imsetting中,接口服务在websocket节点提供服务

restapi服务

私聊消息发送地址为ip:port/api/sendPoint post请求 消息内容自定义;
群聊消息发送地址为ip:port/api/sendGroup post请求 消息内容自定义;

示例项目

体验地址的项目 和sample不一样(前端写比较简陋,请不要在意) :http://47.102.218.172:8099/im/login.html 测试账号 admin/123456;test/123456, 需要更多账号测试的话 可以使用admin/123456 登录 http://47.102.218.172:8099/#/user/login 用户管理里添加用户

安装教程

  1. 参考yueim-node 项目的pom.xml配置,运行package命令后,打包出相应的tar.gz
  2. 解压xxx.tar.gz
  3. 根据相应的操作系统,运行bin目录下的相应的启动脚本

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request
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.

简介

YUE-IM 是使用java开发,基于netty,akka 实现的全异步即时通讯服务开发框架。支持单机,分布式部署,并且提供极简的api,极大的降低开发难度,方便使用者二次开发。 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/yueyakk/yue-im.git
git@gitee.com:yueyakk/yue-im.git
yueyakk
yue-im
yue-im
master

搜索帮助