Skip to content

原创全平台IM通信层框架,轻量级、高度提炼,历经10年、久经考验。可能是市面上唯一同时支持UDP+TCP+WebSocket三种协议的同类开源框架,支持 iOS、Android、Java、H5、小程序、Uniapp、鸿蒙Next,服务端基于Netty。

License

Notifications You must be signed in to change notification settings

JackJiang2011/MobileIMSDK

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MobileIMSDK logo

GitHub stars Gitee star star GitHub Release License

文档手册技术社区更新日志产品案例❶产品案例❷产品案例❸

MobileIMSDK | Trendshift

❤️ 最新动态:鸿蒙Next端已发布。基于MobileIMSDK的鸿蒙Next端IM产品RainbowTalk已发布。 ❤️

一、快捷目录

二、项目简介

MobileIMSDK是一套全平台原创IM通信层框架:

  • 历经10年、久经考验;
  • 超轻量级、高度提炼,lib包50KB以内;
  • 精心封装,一套API优雅支持UDPTCPWebSocket 三种协议(可能是全网唯一开源的);
  • 客户端支持iOS、Android、标准Java、H5(精编注释版)、小程序(精编注释版)、Uniapp(精编注释版)、鸿蒙Next(SDK精编注释版Demo完整源码);
  • 服务端基于Netty,性能卓越、易于扩展; 👈
  • 可与姊妹工程 MobileIMSDK-Web 无缝互通实现网页端聊天或推送等; 👈
  • 可应用于跨设备、跨网络的聊天APP、企业OA、消息推送等各种场景。

💡 特别说明:目前H5、小程序、Uniapp、鸿蒙暂无免费的开源版,只有精编注释版(相当于少量的知识付费价),原因是有一点点私心,希望从开源中获得一点点收益。感恩你的谅解 🤝。

三、源码仓库同步更新

当前源码仓库:

仓库文件目录:

目录名 目录用途说明
1 💎 /demo_binary 🌟 内含编译好的Demo程序(含移动端和服务端),可直接安装到手机或电脑运行。
2 💎 /demo_src 🌟 内含MobileIMSDK的所有Demo源码。
3 💎 /sdk_binary 🌟 内含编译好的MobileIMSDK核心库lib,可直接引用到自已的工程中。
4 💎 /sdk_src 🌟 内含MobileIMSDK核心库源码。
5 💎 /docs 🌟 内含API文档。
6 💎 /preview 🌟 内含Demo和产品案例的运行截图,供参考。
7 💎 /release_notes 🌟 内含历次版本更新日志(也可从网页查看)。

四、设计目标

让开发者专注于应用逻辑的开发,底层复杂的即时通讯算法交由SDK开发人员,从而解偶即时通讯应用开发的复杂性

五、框架组成

整套MobileIMSDK框架由以下部分组成:

平台 完成度 Demo演示 开发指南 源码位置 参考应用案例
1 Android 安装和使用 查看 源码目录 查看 🔥
2 iOS 安装和使用 查看 源码目录 查看 🔥
3 Java 安装和使用 查看 源码目录
4 HTML5 运行演示 查看 精编注释版 查看 🔥
5 微信小程序 运行演示 查看 精编注释版
6 Uniapp 运行演示 查看 精编注释版
7 鸿蒙Next ⭐️ HarmonyChat 🔥 查看 精编注释版 查看 🔥
8 Flutter ☑️ 社区版本
9 Server ⭐️⭐️ 安装和使用 查看 源码目录

整套MobileIMSDK框架的架构原理图:

💡 补充说明:MobileIMSDK一直在持续开发和升级中,鸿蒙Next客户端 是MobileIMSDK工程的最新成果。另外:MobileIMSDK可与姊妹工程 MobileIMSDK-Web 无缝互通,从而实现Web网页端聊天或推送等。

六、技术特征

  • 久经考验:历经10年,从Andriod 2.3、iOS 5.0 时代持续升级至今(绝不烂尾);
  • 超轻量级:高度提炼,lib包50KB以内;
  • 多种协议:可能是全网唯一开源可一套API同时支持UDP、TCP、WebSocket三种协议的同类框架 🆕;
  • 多种网络:精心优化的TCP、UDP、WebSocket协议实现,可应用于卫星网、移动网、嵌入式物联网等场景;
  • 多端覆盖:客户端支持iOS、Android、标准Java、H5微信小程序Uniap鸿蒙Next
  • 高效费比:独有的UDP协议实现,无连接特性,同等条件下可实现更高的网络负载和吞吐能力;
  • 消息走向:支持即时通讯技术中消息的所有可能走向,共3种(即C2C、C2S、S2C);
  • 粘包半包:优雅解决各端的TCP经典粘包和半包问题,底层封装,应用层完全无感知;
  • QoS机制:完善的消息送达保证机制(自动重传、消息去重、状态反馈等),不漏过每一条消息;
  • 健壮可靠:实践表明,非常适于在高延迟、跨洲际、不同网络制式环境中稳定、可靠地运行;
  • 断网恢复:拥有网络状况自动检测、断网自动治愈的能力;
  • 原创算法:核心算法和实现均为原创,保证了持续改进和提升的空间;
  • 多种模式:预设多种实时灵敏度模式,可根据不同场景控制即时性、流量和客户端电量消耗;
  • 数据压缩:自有协议实现,未来可自主定制数据压缩,灵活控制客户端的流量、服务端网络吞吐;
  • 高度封装:高度封装的API接口,保证了调用的简易性,也使得可应用于更多的应用场景;
  • Web支持:可与姊妹工程 MobileIMSDK-Web 无缝互通实现网页端聊天或推送等;:point_left:
  • 扩展性好:服务端基于Netty,继承了Netty的优秀高可扩展性;
  • 性能优异:服务端继承了Netty高性能、高吞吐特性,适用于高性能服务端场景。

MobileIMSDK 所支持的全部3种即时通讯消息走向分别是:
(1) Client to Client (C2C):即由某客户端主动发起,接收者是另一客户端;
(2) Client to Server (C2S):即由某客户端主动发起,接收者是服务端;
(3) Server to Client (S2C):即由服务端主动发起,接收者是某客户端。

👉 您可能需要:查看更多关于MobileIMSDK的疑问及解答

七、性能测试

压力测试表明,MobileIMSDK用于推送场景时,理论单机负载可接近千万级。用于聊天应用时,单机负载也可达数十万( 👉 性能测试报告:点此查看)。

当然,每款应用都有各自的特点和差异,请视具体场景具体评估之,测试数据仅供参考。

八、应用案例

案例名 用途说明 详细介绍 安装体验 运行演示
1 RainbowChat 产品级Android和iOS聊天APP 点击查看 下载安装 🔥 全功能截图
2 RainbowChat-Web Web网页端产品级聊天系统 点击查看 运行视频 全功能截图
3 RainbowTalk ⭐️ 纯血鸿蒙NEXT产品级聊天APP 点击查看 下载安装 🔥 全功能截图

九、典型应用场景

🚩 场景1:聊天APP

  • 应用说明:可用于开发类似于微信、QQ等聊天工具。
  • 消息走向:需使用C2C、C2S、S2C全部类型。
  • 特别说明:MobileIMSDK并未定义聊天应用的应用层逻辑和协议,开发者可自行定义并实现之。

🚩 场景2:消息推送

  • 应用说明:可用于需要向客户端实时推送信息的各种类型APP。
  • 消息走向:仅需使用S2C 1种消息走向,属MobileIMSDK的最简单应用场景。

🚩 场景3:企业OA

  • 应用说明:可用于实现企业OA的指令、公文、申请等各种消息实时推送,极大提升用户体验,并可延伸至移动设备。
  • 消息走向:仅需使用S2C 1种消息走向,属MobileIMSDK的最简单应用场景。

🚩 场景4:企业OA的增强型

  • 应用说明:可用于实现企业OA中各种系统级、用户级消息的实时互动,充分利用即时通讯技术提升传统OA的价值。
  • 消息走向:可使用C2C、C2S、S2C全部类型,这与聊天APP在很多方面已无差别,但企业OA有自已的用户关系管理模型和逻辑,较之全功能聊天APP要简单的多。

十、授权方式

你可永久免费且自由地使用MobileIMSDK,如:用于研究、借鉴、甚至商业用途,但禁止在超越License约束内容的情况下用于商业用途等,请尊重知识产权。更详细的授权说明,请见MobileIMSDK社区介绍贴中的“十二、授权方式”一节。如您还需获得更多技术支持或技术合作请联系作者。

十一、捐助作者

优秀的开源需要您的支持才能走的更远,衷心感谢您的支持与理解,也希望您能从开源中收益。❤️ 捐助链接点此进入

💚 如您恰好需要,也可以支持作者的其它工程 RainbowChatRainbowChat-WebRainbowTalk

十二、联系方式

🔥 技术和资料专区技术交流群个人博客Github主页联系作者 🔥

我的公众号: 👇 👇

附录:Demo运行截图

1、MobileIMSDK Demo在鸿蒙Next端运行效果:

编译和运行:查看鸿蒙Next端Demo完整源码

2、MobileIMSDK Demo在Android端、iOS端运行效果:

安装和使用:进入Android版Demo帮助页进入iOS版Demo帮助页

3、MobileIMSDK Demo在H5端运行效果:

4、MobileIMSDK Demo在微信小程序端运行效果:

5、MobileIMSDK Demo在Uniapp端运行效果:

6、MobileIMSDK Demo在Windows 运行效果:

安装和使用:进入Java版Demo帮助页

7、MobileIMSDK Demo在Mac OS X 运行效果:

安装和使用:进入Java版Demo帮助页

8、MobileIMSDK-Web版客户端Demo运行效果:

1)MobileIMSDK-Web Demo在手机端浏览器运行效果:查看MobileIMSDK-Web版详情

2)MobileIMSDK-Web Demo在PC端多种主流浏览器的运行效果:查看MobileIMSDK-Web版详情

案例1:鸿蒙NEXT端IM产品RainbowTalk

更多资料请见:详细介绍运行截图安装体验

案例2:移动端IM产品RainbowChat

关于RainbowChat产品的更多资料请见:详细介绍运行截图安装体验(真机实拍视频:Andriod端iOS端)。

更多清晰运行截图请见:RainbowCha产品的全部功能截图

案例3:网页端IM产品RainbowChat-Web

🚩 RainbowChat-Web产品主界面:

更多截图和视频:更多截图点此进入更多演示视频点此进入

🚩 RainbowChat-Web产品主界面(独立UI效果):

更多截图和视频:更多截图点此进入更多演示视频点此进入

About

原创全平台IM通信层框架,轻量级、高度提炼,历经10年、久经考验。可能是市面上唯一同时支持UDP+TCP+WebSocket三种协议的同类开源框架,支持 iOS、Android、Java、H5、小程序、Uniapp、鸿蒙Next,服务端基于Netty。

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published