即时通讯框架MobileIMSDK：快速入门

A、捐助作者，得精编注释版

点击以下链接，前往淘宝下单，付款后发货到您的指定邮箱：

• ① MobileIMSDK（Android客户端库）精编注释版：https://item.taobao.com/item.htm?id=534778878908
• ② MobileIMSDK（Java客户端库）精编注释版：https://item.taobao.com/item.htm?id=534874027509
• ③ MobileIMSDK（iOS客户端库）精编注释版：https://item.taobao.com/item.htm?id=534918179776
• ④ MobileIMSDK（H5客户端库）精编注释版：https://item.taobao.com/item.htm?id=653944004776
• ⑤ MobileIMSDK（微信小程序端）精编注释版：https://item.taobao.com/item.htm?id=709976084872
• ⑥ MobileIMSDK（Uniapp端）精编注释版：https://item.taobao.com/item.htm?id=717960807229
• ⑦ MobileIMSDK（鸿蒙NEXT端）精编注释版：https://item.taobao.com/item.htm?id=864963120396
• ⑧ MobileIMSDK（服务端库）精编注释版：https://item.taobao.com/item.htm?id=534986485062
  

（▶ 关于精编版与开源版的区别，请见：《捐助作者，得MobileIMSDK精编注释版)》）

B、快捷目录

▶ 网络理论↘

• 网络编程理论经典《TCP/IP详解》（在线阅读版） ^推荐
  

▶ 相关资料↘

• MobileIMSDK版本更新日志
• MobileIMSDK的疑问及解答 ^推荐
• MobileIMSDK性能测试报告
  

▶ 产品案例↘

• RainbowChat体验版 ^推荐
• RainbowChat体验版截图预览
• 某Chat的部分非敏感运营数据
  

▶ Demo安装↘

• 客户端Demo安装和使用帮助(Android) [1]
• 客户端Demo安装和使用帮助(iOS) [2]
• 客户端Demo安装和使用帮助(Java) [3]
• 客户端Demo演示和说明(H5) [4]
• 客户端Demo演示和说明(微信小程序) [5]
• 客户端Demo演示和说明(Uniapp) [6]
• 客户端Demo演示和说明(鸿蒙NEXT) [6]
• 服务端Demo部署和使用帮助 [7] ^new
  

▶ 开发指南↘

• 客户端开发指南(Android)
• 客户端开发指南(iOS)
• 客户端开发指南(Java)
• 客户端开发指南(H5)
• 客户端开发指南(微信小程序)
• 客户端开发指南(Uniapp)
• 客户端开发指南(鸿蒙NEXT)
• 服务端开发指南
  

▶ 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文档(鸿蒙NEXT)：完整手册、API文档
• 服务端SDK API文档
  

▶ 打包下载↘

• MobileIMSDK最新版打包下载 ^推荐
• 国外地址：MobileIMSDK的Github地址
• 国内地址：MobileIMSDK的码云gitee地址（访问速度快！）
  

▶ 学习交流↘

• 技术交流社区：点此进入
• 常见问题讨论：点此进入 ^推荐
• 技术交流Q群： 215477170 ^推荐
• 技术支持/合作/咨询请联系作者QQ：413980957（关于作者）
  

▶ 推荐关注↘
  ① Web端即时通讯框架：MobileIMSDK-Web
  ② 移动端实时音视频框架：RainbowAV
  ③ 全功能产品级IM案例：RainbowChat
  ④ Web端产品级IM案例：RainbowChat-Web

一、项目简介

MobileIMSDK是一套全平台原创开源IM通信层框架：

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

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

您可能需要：查看更多关于MobileIMSDK的疑问及解答。
另一姊妹工程：轻量级Web端即时通讯框架：MobileIMSDK-Web ，专用于手机或PC端的网页聊天和消息推送等。

二、源码仓库同步更新

GitHub.com：

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

码云gitee：

• 代码托管： http://git.oschina.net/jackjiang/MobileIMSDK
• 技术社区： 点击查看更多资料
  

（MobileIMSDK版本更新日志：点此查看^new）

三、设计目标

让开发者专注于应用逻辑的开发，底层复杂的即时通讯算法交由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：暂无开源版，可查看精编注释版；
• 鸿蒙Next端SDK：SDK暂无开源版（可查看精编注释版），Demo完整工程源码；
• 服务端SDK：用于开发即时通讯服务端，支持Java 1.7及以上版本，查看API文档；
  

整套MobileIMSDK框架的架构组成：


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

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

五、技术特征

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

六、性能测试

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

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

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

七、演示程序

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

八、应用案例

RainbowChat是一款基于MobileIMSDK的产品级聊天APP，更多详情：点击下载体验 或 查看运行截图。

① 基于MobileIMSDK的产品级聊天APP：
▶ 详细介绍、下载体验 或 查看运行截图。

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

九、打包下载（all in one）

• ① 最新发布版（国外地址）：Github打包下载
• ② 最新发布版（国内地址）：码云gitee打包下载（访问速度快！）
  

说明：最新发布版打包内容中，已包含完整的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端开发指南：点此查看；
• 鸿蒙Next端开发指南：点此查看；
• Server端开发指南：点此查看。
  

十二、授权方式

授权方法：
从开源仓库或是从淘宝获得精篇源码和资料后，即可永久自由地使用MobileIMSDK，无需单独授权（但如需正式授权书，请联系作者），如：用于研究、学习、甚至商业用途。MobileIMSDK为著作权作品，未经作者授权不可对MobileIMSDK本身进行二次出售（但基于此进行的后续演进和开发成果由您自行独享），请尊重知识产权。

版本升级：
精编注释版可永久免费获取最新版本（开源版从Github上同步就行了），作者承诺在捐助者索取最新版本时，提供优先交付的保证。

著作权证书展示：


补充说明：如需获得更多技术支持或技术合作请联系作者，QQ：413980957。

十三、联系方式

• 讨论学习和资料区：点击进入；
• 即时通讯网VIP群：200090696  （更多QQ群点此进入）；
• bug和建议请发贴：点击进入；
• 技术支持、技术合作或咨询请联系作者QQ：413980957。
  

十四、捐助作者

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

十五、关注作者

推荐关注：BeautyEye工程
博客地址：点击入进
Github主页：点击进入

附录1：Demo截图

1、在鸿蒙Next端运行效果：

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

2、Android端、iOS端运行效果

>> 安装和使用：进入Android版Demo帮助页、进入iOS版Demo帮助页。

3、H5端运行效果

4、微信小程序端运行效果

5、Uniapp端运行效果

6、Windows 运行效果

>> 安装和使用：进入Java版Demo帮助页。

7、Mac OS X 运行效果

>> 安装和使用：进入Java版Demo帮助页。

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

8.1）MobileIMSDK-Web在手机端浏览器运行效果：（如何获取MobileIMSDK-Web版：点此进入）


8.2）MobileIMSDK-Web在PC端浏览器运行效果：（如何获取MobileIMSDK-Web版：点此进入）

附录2：基于MobileIMSDK的全功能IM【案例】

>> 关于RainbowChat的更多资料请见：RainbowChat前端APP功能截图网页 （* 推荐 - 真机实拍视频：Andriod端、iOS端）。

附录3：基于MobileIMSDK-Web的网页端IM系统【案例】

下图为RainbowChat-Web的主界面（更多截图点此进入、更多演示视频点此进入）：


下图为RainbowChat-Web的主界面[聊天窗全屏时] （更多截图点此进入、更多演示视频点此进入）：


下图为RainbowChat-Web的主界面[独立UI效果] （更多截图点此进入、更多演示视频点此进入）：

支持一下。回去看看

谢谢. 学习下

谢谢 ,学习,

谢谢，值得学习

值得学习 很期待

感觉发现了宝库呀~~

有木有支持多设备通信，同类设备新设备登录将旧设备T下线的功能

引用：不吃香蕉的猴子 发表于 2017-08-15 16:55
有木有支持多设备通信，同类设备新设备登录将旧设备T下线的功能

MobileIMSDK里暂时需要自已实现，MobileIMSDK-Web版已经有重复登陆踢下线的功能：http://www.52im.net/thread-959-1-1.html

这是对mina的封装吗？

引用：奶瓶 发表于 2017-11-14 00:07
这是对mina的封装吗？

MINA只是个让Java NIO使用更简单的封装框架，MobileIMSDK的服务端网络层是基于MINA写的，但MobileIMSDK同样可以直接基于Java的NIO官方API写，但你不能说MobileIMSDK是对NIO的封装是一个道理。只是把它当网络层API用而已。

* 20171216日补充：MobileIMSDK已支持Netty版，请见：https://github.com/JackJiang2011/MobileIMSDK/tree/master/src_all/demos_src/MobileIMSDKServerDemoX_netty

学习了

不错

我想问一下，这个支持离线消息，图片消息，语音消息吗？有没有后台管理之类的，服务怎么没有说明？

引用：现实点 发表于 2018-08-09 20:59
我想问一下，这个支持离线消息，图片消息，语音消息吗？有没有后台管理之类的，服务怎么没有说明？

MobileIMSDK是个即时通讯的核心层框架，尽量保持它的“轻量”，应用层的业务需要自已去实现，看看下面这几个帖子里的讨论：
《[已回复] MobileIMSDK开发音视频即时通讯、图片消息的疑问》
《[已回复] MobileIMSDK如何实现图片、语音留言信息的发送？》
《请问有人知道语音留言聊天的主流实现方式吗？》
《[已回复] 请教 MobileIMSDK 群聊接口、大文件上传下载接口》

引用：JackJiang 发表于 2018-08-09 21:17
MobileIMSDK是个即时通讯的核心层框架，尽量保持它的“轻量”，应用层的业务需要自已去实现，看看下面这 ...

那消息离线呢？按你这样说的话，你这个产品，就只是一个只能发送消息的IM。其它的都需要再自己扩展是吧？

谢谢分享

引用：现实点 发表于 2020-06-09 23:34
那消息离线呢？按你这样说的话，你这个产品，就只是一个只能发送消息的IM。其它的都需要再自己扩展是吧？

是的，MobileIMSDK本身就是一个轻量级的通信底层框架，为了尽可能的实现通用性、灵活性、高可管重用性，尽量不涉及任何业务层的具体功能需求和逻辑实现。

这样拆分的好处是，MobileIMSDK可以放开手解决各种通信层的稳定性、网络延迟、网各抖动、丢包保证等各种算法问题，应用层也同样可专注于产品和业务功能本身。这也是我一直认为的，专业的人做专业的事，互不干涉，从而让使用者没有门槛，否则每个开始写代码的人都需要懂底层、懂原理才能找到最佳 实践，那要求就高了，也违背了框架设计的初衷。

zhichiyixia

请问授权包含服务端的源码吗