MobileIMSDK

Project Url: JackJiang2011/MobileIMSDK

Introduction: 一个专为移动端开发的开源原创即时通讯框架，超轻量级、高度提炼，完全基于 UDP 协议，支持 iOS、Android、标准 Java 平台，服务端基于 Mina 和 Netty 编写。

Tags:

:warning: 特别提示：如 Github 下载慢，请往：https://gitee.com/jackjiang/MobileIMSDK，代码完全同步，请放心下载 :warning:

:heart: 最新动态：MobileIMSDK 的微信小程序端、Uniapp 端已发布 :heart:

1.1、理论资料

网络编程理论经典《TCP/IP 详解》（在线阅读版） :triangular_flag_on_post:

1.2、相关资料

MobileIMSDK 版本更新日志

MobileIMSDK 常见问题解答 :point_left:

MobileIMSDK 性能测试报告

1.3、产品案例

RainbowChat 体验版 :point_left:

RainbowChat 体验版截图预览

某 Chat 的部分非敏感运营数据

1.4、Demo 安装

客户端 Demo 安装和使用帮助(Android)

客户端 Demo 安装和使用帮助(iOS)

客户端 Demo 安装和使用帮助(Java)

客户端 Demo 演示和说明(H5)

客户端 Demo 演示和说明(微信小程序) :new:

客户端 Demo 演示和说明(Uniapp) :new:

服务端 Demo 部署和使用帮助

1.5、开发指南

客户端开发指南(Android)

客户端开发指南(iOS)

客户端开发指南(Java)

客户端开发指南(H5)

客户端开发指南(微信小程序)

客户端开发指南(Uniapp)

服务端开发指南

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 最新版打包下载 :point_left:

国外地址：MobileIMSDK 的 Github 地址

国内地址：MobileIMSDK 的码云 gitee 地址（访问速度快！）

1.8、学习交流

技术交流社区：点此进入

常见问题讨论：点此进入 :point_left:

技术交流 Q 群： 215477170 :point_left:

技术支持/合作/咨询请联系作者 QQ：413980957 （关于作者 :point_left:）

关注我的公众号：:point_down: :point_down:

二、项目简介

MobileIMSDK 是一套专为移动端开发的原创 IM 通信层框架：

历经 10 年、久经考验；
超轻量级、高度提炼，lib 包 50KB 以内；
精心封装，一套 API 优雅支持UDP 、TCP 、WebSocket 三种协议（可能是全网唯一开源的）；
客户端支持 iOS、Android、标准 Java、H5(暂未开源)、小程序(暂未开源)、Uniapp(暂未开源)；
服务端基于 Netty，性能卓越、易于扩展；:point_left:
可与姊妹工程 MobileIMSDK-Web 无缝互通实现网页端聊天或推送等；:point_left:
可应用于跨设备、跨网络的聊天 APP、企业 OA、消息推送等各种场景。

MobileIMSDK 工程自 2013 年 10 月起持续升级至今（当前最新版是 v6.5，版本更新日志点此查看），历经 10 年，起初用作某自用产品的即时通讯底层，完全从零开发。
目前，最新Uniapp 端已开发完成，希望对需要的人有所启发和帮助。

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

:point_right: 另一姊妹工程：轻量级 Web 端即时通讯框架：MobileIMSDK-Web 也在持续更新中，专用于手机或 PC 端的网页聊天和消息推送等。

三、代码托管同步更新

GitHub.com

代码托管： https://github.com/JackJiang2011/MobileIMSDK
技术社区：点击查看更多资料

码云 gitee

代码托管： https://gitee.com/jackjiang/MobileIMSDK
技术社区：点击查看更多资料

MobileIMSDK 版本更新日志：点此查看 :point_left:

四、设计目标

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

五、框架组成

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

Android 客户端 SDK：用于 Android 版即时通讯客户端，支持 Android 4.0 及以上，查看 API 文档；
iOS 客户端 SDK：用于开发 iOS 版即时通讯客户端，支持 iOS 12.0 及以上，查看 API 文档；
Java 客户端 SDK：用于开发跨平台的 PC 端即时通讯客户端，支持 Java 1.6 及以上，查看 API 文档；
H5 客户端 SDK：暂无开源版，查看精编注释版；
微信小程序端 SDK：暂无开源版，查看精编注释版；
Uniapp 端 SDK：暂无开源版，查看精编注释版；
服务端 SDK：用于开发即时通讯服务端，支持 Java 1.7 及以上版本，查看 API 文档。

整套 MobileIMSDK 框架的架构组成：

MobileIMSDK 一直在持续开发和升级中，Uniapp 客户端是 MobileIMSDK 工程的最新成果。

:point_right: 另外：MobileIMSDK 可与姊妹工程 MobileIMSDK-Web 无缝互通，从而实现 Web 网页端聊天或推送等。

六、技术特征

久经考验：历经 10 年，从 Andriod 2.3、iOS 5.0 时代持续升级至今（绝不烂尾）；
超轻量级：高度提炼，lib 包 50KB 以内；
多种协议：可能是全网唯一开源可一套 API 同时支持 UDP、TCP、WebSocket 三种协议的同类框架 :new:；
多种网络：精心优化的 TCP、UDP、WebSocket 协议实现，可应用于卫星网、移动网、嵌入式物联网等场景；
多端覆盖：客户端支持 iOS、Android、标准 Java、H5、微信小程序、Uniap；
高效费比：独有的 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)：即由服务端主动发起，接收者是某客户端。

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

七、性能测试

压力测试表明，MobileIMSDK 用于推送场景时，理论单机负载可接近千万级。用于聊天应用时，单机负载也可达数十万。

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

:point_right: 性能测试报告：点此查看。

八、演示程序

Android 客户端 Demo：点此安装和使用；
iOS 客户端 Demo：点此安装和使用；
Java 客户端 Demo：点此安装和使用；
H5 客户端 Demo：点此查看介绍；
微信小程序端 Demo：点此查看介绍 :new:；
Uniapp 端 Demo：点此查看介绍 :new:；
服务端 Demo：点此安装和使用。

九、应用案例

① 基于 MobileIMSDK 的产品级聊天 APP：

详细介绍、下载体验或查看运行截图。

② MobileIMSDK 在高网络延迟下的案例：

某款基于 MobileIMSDK 的商业商品，曾运营于跨洲际的复杂网络环境下，端到端通信延迟在洲际网络繁忙时可高达 600ms 以上（与服务端的单向延迟约为 300ms 左右，而通常大家访问国内主流门户的延迟约为 20~50ms），某段时期的非敏感运营数据点此查看。

十、打包下载（all in one）

:paperclip: ① 最新发布版（国外地址）：Github 打包下载

:paperclip: ② 最新发布版（国内地址）：码云 gitee 打包下载（访问速度快！ :point_left:）

说明：最新发布版打包内容中，已包含完整的 demo 源码、sdk 源码、api 文档、编译后的分发包等。

十一、典型应用场景

:triangular_flag_on_post: 场景 1：聊天 APP

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

:triangular_flag_on_post: 场景 2：消息推送

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

:triangular_flag_on_post: 场景 3：企业 OA

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

:triangular_flag_on_post: 场景 4：企业 OA 的增强型

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

十二、开发指南

Android 客户端开发指南：点此查看；
iOS 客户端开发指南：点此查看；
Java 客户端开发指南：点此查看；
H5 客户端开发指南：点此查看；
微信小程序端开发指南：点此查看；
Uniapp 端开发指南：点此查看；
Server 端开发指南：点此查看。

十三、授权方式

你可永久免费且自由地使用 MobileIMSDK，如：用于研究、学习、甚至商业用途，但禁止在超越 License 约束内容的情况下用于商业用途等，请尊重知识产权。更详细的授权说明，请见MobileIMSDK 社区介绍贴中的“十二、授权方式”一节。

补充说明：如您还需获得更多技术支持或技术合作请联系作者，QQ：413980957（:point_right: 关于作者）。

十四、联系方式

讨论学习和资料区：:earth_americas: 点此进入；
即时通讯技术交流群：185926912 （更多 QQ 群点此进入）；
bug 和建议请发送至：:love_letter: jb2011@163.com；
技术培训/转让/合作/咨询等欢迎联系作者 QQ：:penguin: 413980957、微信：hellojackjiang （:point_right: 关于作者）。