5 Star 10 Fork 3

/ Mimo

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

背景

  • 原先所属项目使用第三方IM服务,随着业务增长,用户量与消息量增长较快,一年光IM这一块的第三方服务费用就超过了100W。

  • 由于项目是直播平台,每次平台有相应营销活动,对应的消息分发量、用户同时在线数、接口调用频次、单个房间内最大成员数量等都会大幅度提升,而此时第三方服务本身的服务规则和成本控制就会对调用方有很大的约束,包括限流、限频次调用等,进而影响正常业务推进。

  • 直播平台本身主要是面向海外东南亚市场,而海外的基础网络设施往往比较波动,容易对业务产生影响。而依赖于第三方服务,对于服务质量响应以及问题处理,也是滞后,且被动性太大。

基于以上原由,综合服务成本、服务质量等多方面因素,决定研发基于直播场景的IM解决方案。

应用协议制定

认证与授权

  • 登入消息

  • 登出消息

房间操作集

  • 创建、加入、离开、销毁、基于用户罗列已加入的所有房间

上行指令

  • 点对点消息

  • 点对房间消息

  • 心跳消息

  • 查询待确认消息

下行响应指令(对应于上行指令)

  • 接收确认消息(发送方需要根据该消息以确认服务端是否已经收到)

  • 登陆成功消息

  • 用户所加房间列表消息

  • 待确认列表消息

  • 指令错误响应消息(上行指令错误或者受限制时,服务端返回错误详情)

下行分发消息

  • 分发到客户端接收的业务消息,一般客户端会收到点对点消息、房间分发消息。

服务端响应码定义

分组 响应码 消息描述 备注
系统 0 代码正常的业务响应
系统 -1 未知错误 比如NPE,网络异常,数据异常等
用户模块 1000 登陆授权失败 有可能是账户密码错误,也有可能是账户不存在
用户模块 1001 用户被封禁
用户模块 1002 点对点消息时,目标用户不存在
用户模块 1003 当前用户在其他移动设备上登录,此设备被踢下线 同一账户在多处登录导致前一个已经登陆的人被强制下线
用户模块 1004 当前用户不在线 一般是服务间回写时,用户不可触
聊天室 2000 聊天室不存在 加入 聊天室时或者是往聊天室发消息时
聊天室 2001 加入聊天时,聊天室成员超限 聊天室有人数限制,由服务端调配
聊天室 2002 当前用户在聊天室中已被禁言 聊天室内被禁言
聊天室 2003 当前用户已被踢出并禁止加入聊天室 被禁止的时间取决于服务端调用踢出接口时传入的时间
聊天室 2004 尚未加入聊天室 一般指用户往聊天室发消息时,用户并没有保证自己已经加入了聊天室
内部服务 3000 用户locate不在本机 一般指向comet通讯时的用户不在本机上,目前服务间调用判断
消息 4000 私信拒绝 一般来说,点对点消息时,被对方加入了黑名单
消息 4001 基于用户维度上行指令过于频繁 一般来说,正常用户是不会发生的,主要是防止恶意狂刷消息(点对点和房间消息)
消息 4002 基于房间维度上行指令过于频繁 一般来说,聊天室的上行消息过多, 主要也是防止恶意狂刷消息(房间消息)

协议类图

  • 上行指令类图 UpstreamCommand

  • 下行响应指令类图

DownstreamEchoCommand

  • 下行分发消息类图

DispatchMessage

网络通讯协议

  • 对Client目前采用websocket,主要是兼顾H5和原生应用

  • 服务间通讯采用gRPC,一方面是为提高通讯效率,一方面是为了减少通讯时内部带宽压力。

    关于gRPC以及protobuf信息,请自行从官网学习。

  • IM系统对外部业务系统提供HTTP接口实现

技术架构

架构图

Technical Diagram

Gateway服务

  • 提供外部业务系统访问时的认证以及请求分发,且所有分发请求有且指向Logic服务

Comet服务

  • 维护物理连接的管理,包括read、write、idle等

  • 维护集群环境下,同一账户信息多次连接下的会话唯一性

  • 维护所有上行指令到Logic服务的透传

Logic服务

  • 无状态化所有的处理上下文

  • 用户有效性认证以及客户端SDK采集信息的处理

  • 对连接会话引入逻辑会话,并统一基于逻辑会话的active管理

  • 维护房间功能以及房间成员功能

  • 维护消息的接收与分发功能,包括点对点消息、点对房间消息

  • 维护消息的接收确认机制以及离线消息消费机制

  • 维护用户访问权限功能,包括基于房间维度的禁言和禁入、基于平台维度的全局禁言和禁入、基于用户维度的私信发送、基于用户和房间维度的交互频次限制

  • 对外部业务系统提供HTTP接口服务

  • 基于系统级,提供不同日期维度的metric信息。比如点对点上行消息数量、点对点下行消息数量、房间上行消息数量、房间下行消息数量、房间创建数量、新增用户数量、登陆用户数、活跃用户数等

Push服务

  • 维护消息分发的管理,包括分发重试等

Admin服务

  • 提供接入端信息查询、多维度Metric查询的操作界面

实现方案的选择与思考

连接路由

业内的做法,大多是有二种:

  1. 业务上存在一个“路由”服务(模块)。该 “路由” 能够自身有效的感知后端的具体连接管理服务(比如ServerA、ServerB),当新的client接入时,先经过“路由”并按照业务或者资源规则,引导client跳转连接到serverA或者ServerB。

    • 优点:可控性强,全由业务代码决定。

    • 缺点:一方面需要额外的功能设计成本,一方面,client是先到"路由",之后再连接到对应的Server,相当于连接了两次。

    • 图示如下: connection_routing_solution_1

  2. 整个接入层由CometA、CometB等组成,该层的接入前端依赖于LVS(对于LVS更多的信息,可以查看阿里云官网),既第三方组件服务,依据其相关的“路由规则”,对连接分发至后端CometA、Comet等。

    • 优点就是:系统本身不用考虑路由分发问题,对于自定义需求不高的项目,可以有效的降低自身的设计复杂度。

    • 图示如下: connection_routing_solution_2

对于当前项目来说,连接路由方案使用的是后者。

具体实现可查看Commet服务的WebSocketServer以及Login服务的UserServiceImpl#login

连接会话管理

由于所有的Commet实例,都是对等存在,而业务上需要保证任一用户信息的连接唯一性。

当任意的client接入comet时,对应的comet实例依赖于redis的pub/sub机制,向集群中的其他comet广播。

图示如下: 连接会话唯一性

其中对于每个comet实例,为了做自我区别,当其启动时,以uuid的方式为每个comet生成一个唯一性编号。以便于当“登陆事件”广播时,每个实例能够区分client所连接的目标“comet”是否落在当前实例。如果不是,则各个实例遍历本机寻找client的连接信息,若存在,则断开并清除。配置类信息大体如下:

@Validated
@ConfigurationProperties(prefix = "mimo.comet.server")
public class LocalCometServerConfig {

    /**
     * 每个应用实例的ID需保持唯一性
     */
    private String applicationId = RandomStringUtils.uniqueRandom();

    /**
     * Redis pub/sub 监听本地新的会话连接
     */
    @NotEmpty
    private String clusterChannel;

    /**
     * Redis pub/sub 监听logic session 过期时的强制断开信息
     */
    @NotEmpty
    private String logicExpiredChannel;

    /**
     * 用于获取本机的配置信息
     */
    @NotNull
    @Valid
    private ZoneDTO zone;

    private com.mimo.common.rpc.proto.UserProto.ZoneDTO protoZone;
GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License.

简介

针对直播场景的IM实现方案 展开 收起
Java 等 5 种语言
GPL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/44346460/Mimo.git
git@gitee.com:44346460/Mimo.git
44346460
Mimo
Mimo
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891