一、快捷目录
1.1、理论资料
1.2、相关资料
1.3、产品案例
1.4、Demo安装
- 客户端Demo安装和使用帮助(Android)
- 客户端Demo安装和使用帮助(iOS)
- 客户端Demo安装和使用帮助(Java)
- 客户端Demo演示和说明(H5)
- 客户端Demo演示和说明(微信小程序)
🆕 - 客户端Demo演示和说明(Uniapp)
🆕 - 服务端Demo部署和使用帮助
1.5、开发指南
1.6、API文档
- 客户端SDK API文档(Android)：TCP版、UDP版
- 客户端SDK API文档(iOS)：TCP版、UDP版
- 客户端SDK API文档(Java)：TCP版、UDP版
- 客户端SDK API文档(H5)：点此进入
- 客户端SDK API文档(微信小程序)：点此进入
- 客户端SDK API文档(Uniapp)：点此进入
- 服务端SDK API文档
1.7、打包下载
- MobileIMSDK最新版打包下载
👈 - 国外地址：MobileIMSDK的Github地址
- 国内地址：MobileIMSDK的码云gitee地址（访问速度快！）
1.8、学习交流
二、项目简介
MobileIMSDK是一套专为移动端开发的原创IM通信层框架：
- 历经8年、久经考验；
- 超轻量级、高度提炼，lib包50KB以内；
- 精心封装，一套API优雅支持UDP 、TCP 、WebSocket 三种协议（可能是全网唯一开源的）；
- 客户端支持iOS、Android、标准Java、H5(暂未开源)、小程序(暂未开源)、Uniap(暂未开源)；
- 服务端基于Netty，性能卓越、易于扩展；
👈 - 可与姊妹工程 MobileIMSDK-Web 无缝互通实现网页端聊天或推送等；
👈 - 可应用于跨设备、跨网络的聊天APP、企业OA、消息推送等各种场景。
MobileIMSDK工程自2013年10月起持续升级至今（当前最新版是v6.3，版本更新日志点此查看 ），起初用作某自用产品的即时通讯底层，完全从零开发。
2023年5月10日，最新Uniapp端已开发完成，希望对需要的人有所启发和帮助。
三、代码托管同步更新
GitHub.com
- 代码托管： https://github.com/JackJiang2011/MobileIMSDK
- 技术社区： 点击查看更多资料
码云gitee
- 代码托管： https://gitee.com/jackjiang/MobileIMSDK
- 技术社区： 点击查看更多资料
MobileIMSDK版本更新日志：点此查看
四、设计目标
让开发者专注于应用逻辑的开发，底层复杂的即时通讯算法交由SDK开发人员，从而解偶即时通讯应用开发的复杂性。
五、框架组成
整套MobileIMSDK框架由以下6部分组成：
- Android客户端SDK：用于Android版即时通讯客户端，支持Android 2.3及以上，查看API文档；
- iOS客户端SDK：用于开发iOS版即时通讯客户端，支持iOS 9.0及以上，查看API文档；
- Java客户端SDK：用于开发跨平台的PC端即时通讯客户端，支持Java 1.6及以上，查看API文档；
- H5客户端SDK：暂无开源版，查看精编注释版；
- 微信小程序端SDK：暂无开源版，查看精编注释版；
- Uniapp端SDK：暂无开源版，查看精编注释版；
- 服务端SDK：用于开发即时通讯服务端，支持Java 1.7及以上版本，查看API文档。
整套MobileIMSDK框架的架构组成：
MobileIMSDK一直在持续开发和升级中，Uniapp客户端 是MobileIMSDK工程的最新成果。
六、技术特征
- 久经考验：历经8年，从Andriod 2.3、iOS 5.0 时代持续升级至今（绝不烂尾）；
- 超轻量级：高度提炼，lib包50KB以内；
- 多种协议：可能是全网唯一开源可一套API同时支持UDP、TCP、WebSocket三种协议的同类框架
🆕 ； - 多种网络：精心优化的TCP、UDP、WebSocket协议实现，可应用于卫星网、移动网、嵌入式物联网等场景；
- 多端覆盖：客户端支持iOS、Android、标准Java、H5、微信小程序、Uniap；
- 高效费比：独有的UDP协议实现，无连接特性，同等条件下可实现更高的网络负载和吞吐能力；
- 消息走向：支持即时通讯技术中消息的所有可能走向，共3种（即C2C、C2S、S2C）；
- 粘包半包：优雅解决各端的TCP经典粘包和半包问题，底层封装，应用层完全无感知；
- QoS机制：完善的消息送达保证机制（自动重传、消息去重、状态反馈等），不漏过每一条消息；
- 健壮可靠：实践表明，非常适于在高延迟、跨洲际、不同网络制式环境中稳定、可靠地运行；
- 断网恢复：拥有网络状况自动检测、断网自动治愈的能力；
- 原创算法：核心算法和实现均为原创，保证了持续改进和提升的空间；
- 多种模式：预设多种实时灵敏度模式，可根据不同场景控制即时性、流量和客户端电量消耗；
- 数据压缩：自有协议实现，未来可自主定制数据压缩，灵活控制客户端的流量、服务端网络吞吐；
- 高度封装：高度封装的API接口，保证了调用的简易性，也使得可应用于更多的应用场景；
- Web支持：可与姊妹工程 MobileIMSDK-Web 无缝互通实现网页端聊天或推送等；
👈 - 扩展性好：服务端基于Netty，继承了Netty的优秀高可扩展性；
- 性能优异：服务端继承了Netty高性能、高吞吐特性，适用于高性能服务端场景。
MobileIMSDK 所支持的全部3种即时通讯消息走向分别是：
(1) Client to Client (C2C)：即由某客户端主动发起，接收者是另一客户端；
(2) Client to Server (C2S)：即由某客户端主动发起，接收者是服务端；
(3) Server to Client (S2C)：即由服务端主动发起，接收者是某客户端。
七、性能测试
压力测试表明，MobileIMSDK用于推送场景时，理论单机负载可接近千万级。用于聊天应用时，单机负载也可达数十万。
当然，每款应用都有各自的特点和差异，请视具体场景具体评估之，测试数据仅供参考。
八、演示程序
- Android客户端 Demo：点此安装和使用；
- iOS客户端 Demo：点此安装和使用；
- Java客户端 Demo：点此安装和使用；
- H5客户端 Demo：点此查看介绍；
- 微信小程序端 Demo：点此查看介绍
🆕 ； - Uniapp端 Demo：点此查看介绍
🆕 ； - 服务端 Demo：点此安装和使用。
九、应用案例
① 基于MobileIMSDK的产品级聊天APP：
② MobileIMSDK在高网络延迟下的案例：
某款基于MobileIMSDK的商业商品，曾运营于跨洲际的复杂网络环境下，端到端通信延迟在洲际网络繁忙时可高达600ms以上（与服务端的单向延迟约为300ms左右，而通常大家访问国内主流门户的延迟约为20~50ms），某段时期的非敏感运营数据 点此查看。
十、打包下载（all in one）
说明：最新发布版打包内容中，已包含完整的demo源码、sdk源码、api文档、编译后的分发包等。
十一、典型应用场景
🚩 场景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要简单的多。
十二、开发指南
- Android客户端开发指南：点此查看；
- iOS客户端开发指南：点此查看；
- Java客户端开发指南：点此查看；
- H5客户端开发指南：点此查看；
- 微信小程序端开发指南：点此查看；
- Uniapp端开发指南：点此查看；
- Server端开发指南：点此查看。
十三、授权方式
你可永久免费且自由地使用MobileIMSDK，如：用于研究、学习、甚至商业用途， 但禁止在超越License约束内容的情况下用于商业用途等，请尊重知识产权。 更详细的授权说明，请见MobileIMSDK社区介绍贴中的“十二、授权方式”一节。
补充说明：如您还需获得更多技术支持或技术合作请联系作者，QQ：
413980957（👉 关于作者）。
十四、联系方式
- 讨论学习和资料区：
🌎 点此进入； - 即时通讯技术交流群：
185926912（更多QQ群点此进入）；
- bug和建议请发送至：
💌 [email protected]； - 技术培训/转让/合作/咨询等欢迎联系作者QQ：
🐧 413980957、微信：hellojackjiang（👉 关于作者）。
十五、捐助作者
优秀的开源需要您的支持才能走的更远，衷心感谢您的支持与理解，也希望您能从开源中收益。
- 捐助链接： 点此进入。
十六、关注作者
- 关于作者：点击进入
👈 - 推荐关注：BeautyEye工程
- 博客地址：点击入进
- Github主页：点击进入
- 我的公众号：
👇 👇
附录1：Demo运行截图
🚩 MobileIMSDK Demo在Android端、iOS端运行效果：
安装和使用：进入Android版Demo帮助页、进入iOS版Demo帮助页。
🚩 MobileIMSDK Demo在H5端运行效果：
🚩 MobileIMSDK Demo在微信小程序端运行效果：
🚩 MobileIMSDK Demo在Uniapp端运行效果：
🚩 MobileIMSDK Demo在Windows 运行效果：
安装和使用：进入Java版Demo帮助页。
🚩 MobileIMSDK Demo在Mac OS X 运行效果：
安装和使用：进入Java版Demo帮助页。
🚩 MobileIMSDK-Web版客户端Demo运行效果：
1）MobileIMSDK-Web Demo在手机端浏览器运行效果：查看MobileIMSDK-Web版详情。
2）MobileIMSDK-Web Demo在PC端多种主流浏览器的运行效果：查看MobileIMSDK-Web版详情。
附录2：基于MobileIMSDK的全功能IM产品【案例】
关于RainbowChat产品的更多资料请见：RainbowChat产品的全部功能截图 （真机实拍视频：Andriod端、iOS端）。
更多清晰运行截图请见：RainbowCha产品的全部功能截图。
附录3：基于MobileIMSDK-Web的网页端IM系统【案例】
🚩 RainbowChat-Web产品主界面：
更多截图和视频：更多截图点此进入、更多演示视频点此进入。
🚩 RainbowChat-Web产品主界面(聊天窗全屏时)：
更多截图和视频：更多截图点此进入、更多演示视频点此进入。
🚩 RainbowChat-Web产品主界面(独立UI效果)：
更多截图和视频：更多截图点此进入、更多演示视频点此进入。
