README.md · 仪表盘开发小队/MobileIMSDK

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

# 一、快捷目录

> #### 1.1、理论资料
* [网络编程理论经典《TCP/IP详解》（在线阅读版）](http://www.52im.net/topic-tcpipvol1.html) :triangular_flag_on_post:

> #### 1.2、相关资料
* [MobileIMSDK版本更新日志](http://www.52im.net/thread-1270-1-1.html)
* [MobileIMSDK常见问题解答](http://www.52im.net/thread-60-1-1.html) :point_left:
* [MobileIMSDK性能测试报告](http://www.52im.net/thread-57-1-1.html)

> #### 1.3、产品案例
* [RainbowChat体验版](http://www.52im.net/thread-19-1-1.html) :point_left:
* [RainbowChat体验版截图预览](http://www.52im.net/thread-20-1-1.html)
* [某Chat的部分非敏感运营数据](http://www.52im.net/thread-21-1-1.html)

> #### 1.4、Demo安装
* [客户端Demo安装和使用帮助(Android)](http://www.52im.net/thread-55-1-1.html)
* [客户端Demo安装和使用帮助(iOS)](http://www.52im.net/thread-54-1-1.html)
* [客户端Demo安装和使用帮助(Java)](http://www.52im.net/thread-56-1-1.html)
* [客户端Demo演示和说明(H5)](http://www.52im.net/thread-3682-1-1.html)
* [服务端Demo安装和使用帮助](http://www.52im.net/thread-1272-1-1.html) :new:

> #### 1.5、开发指南
* [客户端开发指南(Android)](http://www.52im.net/thread-61-1-1.html)
* [客户端开发指南(iOS)](http://www.52im.net/thread-62-1-1.html)
* [客户端开发指南(Java)](http://www.52im.net/thread-59-1-1.html)
* [客户端开发指南(H5)](http://www.52im.net/thread-3686-1-1.html)
* [服务端开发指南](http://www.52im.net/thread-63-1-1.html)

> #### 1.6、API文档
* 客户端SDK API文档(Android)：[TCP版](http://docs.52im.net/extend/docs/api/mobileimsdk/android_tcp/)、[UDP版](http://docs.52im.net/extend/docs/api/mobileimsdk/android/)
* 客户端SDK API文档(iOS)：[TCP版](http://docs.52im.net/extend/docs/api/mobileimsdk/ios_tcp/)、[UDP版](http://docs.52im.net/extend/docs/api/mobileimsdk/ios/)
* 客户端SDK API文档(Java)：[TCP版](http://docs.52im.net/extend/docs/api/mobileimsdk/java_tcp/)、[UDP版](http://docs.52im.net/extend/docs/api/mobileimsdk/java/)
* 客户端SDK API文档(H5)：[点此进入](http://www.52im.net/thread-3682-1-1.html)
* [服务端SDK API文档](http://docs.52im.net/extend/docs/api/mobileimsdk/server/)

> #### 1.7、打包下载
* [MobileIMSDK最新版打包下载](https://github.com/JackJiang2011/MobileIMSDK/releases/latest) :point_left:
* 国外地址：[MobileIMSDK的Github地址](https://github.com/JackJiang2011/MobileIMSDK)
* 国内地址：[MobileIMSDK的码云gitee地址](https://gitee.com/jackjiang/MobileIMSDK )（访问速度快！）

> #### 1.8、学习交流
* 技术交流社区：[点此进入](http://www.52im.net/forum-89-1.html)
* 常见问题讨论：[点此进入](http://www.52im.net/forum.php?mod=collection&action=view&ctid=2&fromop=all) :point_left:
* 技术交流Q群：![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_screenshots/others/qq_group_icon_16-16.png) `215477170` :point_left:
* 技术支持/合作/咨询请联系作者QQ：`413980957` （[关于作者](http://www.52im.net/thread-2792-1-1.html) :point_left:）
* 关注我的公众号：:point_down: :point_down:

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_screenshots/others/my_mp_qr_400_b.png)

# 二、项目简介
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_screenshots/others/github_header_logo_h.png)

MobileIMSDK是一套专为移动端开发的原创IM通信层框架： 
* 历经8年、久经考验；
* 超轻量级、高度提炼，lib包50KB以内；
* 精心封装，一套API优雅支持UDP 、TCP 、WebSocket 三种协议（可能是全网唯一开源的）；
* 客户端支持iOS、Android、标准Java、H5([暂未开源](http://www.52im.net/thread-3682-1-1.html))、小程序(开发中..)、Uniap(开发中..)；
* 服务端基于Netty，性能卓越、易于扩展；:point_left:
* 可与姊妹工程 [MobileIMSDK-Web](http://www.52im.net/thread-959-1-1.html) 无缝互通实现网页端聊天或推送等；:point_left:
* 可应用于跨设备、跨网络的聊天APP、企业OA、消息推送等各种场景。

> MobileIMSDK工程始于2013年10月（当前最新版是v6.1.2，[版本更新日志点此查看](http://www.52im.net/thread-1270-1-1.html) ），起初用作某自用产品的即时通讯底层，完全从零开发。 
MobileIMSDK现已完全开源，希望对需要的人有所启发和帮助。

:point_right: 您可能需要：[查看更多关于MobileIMSDK的疑问及解答](http://www.52im.net/thread-60-1-1.html)。

:point_right: 另一姊妹工程：[轻量级Web端即时通讯框架：MobileIMSDK-Web](http://www.52im.net/thread-959-1-1.html) 也在持续更新中，专用于手机或PC端的网页聊天和消息推送等。

# 三、代码托管同步更新

**GitHub.com**

* 代码托管：  https://github.com/JackJiang2011/MobileIMSDK 
* 技术社区：  [点击查看更多资料](http://www.52im.net/forum-89-1.html)

**码云gitee**

* 代码托管：  https://gitee.com/jackjiang/MobileIMSDK 
* 技术社区：  [点击查看更多资料](http://www.52im.net/forum-89-1.html)

MobileIMSDK版本更新日志：[点此查看](http://www.52im.net/thread-1270-1-1.html) :point_left:

# 四、设计目标
让开发者专注于应用逻辑的开发，底层<code>复杂的即时通讯算法交由SDK开发人员</code>，从而<code>解偶即时通讯应用开发的复杂性</code>。

# 五、框架组成
整套MobileIMSDK框架由以下6部分组成：

1. Android客户端SDK：用于Android版即时通讯客户端，支持Android 2\.3及以上，[查看API文档](http://docs.52im.net/extend/docs/api/mobileimsdk/android_tcp/)；
2. iOS客户端SDK：用于开发iOS版即时通讯客户端，支持iOS 8\.0及以上，[查看API文档](http://docs.52im.net/extend/docs/api/mobileimsdk/ios_tcp/)；
3. Java客户端SDK：用于开发跨平台的PC端即时通讯客户端，支持Java 1\.6及以上，[查看API文档](http://docs.52im.net/extend/docs/api/mobileimsdk/java_tcp/)；
4. H5客户端SDK：暂无开源版，[查看精编注释版](http://www.52im.net/thread-3682-1-1.html)；
5. 小程序端SDK：持续开发中，敬请关注；
6. 服务端SDK：用于开发即时通讯服务端，支持Java 1\.7及以上版本，[查看API文档](http://docs.52im.net/extend/docs/api/mobileimsdk/server/)。

整套MobileIMSDK框架的架构组成：

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/mibileimsdk_framework.png)

:point_right: 另外：MobileIMSDK可与姊妹工程 [MobileIMSDK-Web](http://www.52im.net/thread-959-1-1.html) 无缝互通，从而实现Web网页端聊天或推送等。

# 六、技术特征
* 久经考验：历经8年，从Andriod 2.3、iOS 5.0 时代持续升级至今（绝不烂尾）；
* 超轻量级：高度提炼，lib包50KB以内；
* 多种协议：可能是全网唯一开源可一套API同时支持UDP、TCP、WebSocket三种协议的同类框架 :new:；
* 多种网络：精心优化的TCP、UDP、WebSocket协议实现，可应用于卫星网、移动网、嵌入式物联网等场景；
* 高效费比：独有的UDP协议实现，无连接特性，同等条件下可实现更高的网络负载和吞吐能力；
* 消息走向：支持即时通讯技术中消息的所有可能走向，共3种（即C2C、C2S、S2C）；
* 粘包半包：优雅解决各端的TCP经典粘包和半包问题，底层封装，应用层完全无感知；
* QoS机制：完善的消息送达保证机制（多重保障），不漏过每一条消息；
* 健壮可靠：实践表明，非常适于在高延迟、跨洲际、不同网络制式环境中稳定、可靠地运行；
* 断网恢复：拥有网络状况自动检测、断网自动治愈的能力；
* 原创算法：核心算法和实现均为原创，保证了持续改进和提升的空间；
* 多种模式：预设多种实时灵敏度模式，可根据不同场景控制即时性、流量和客户端电量消耗；
* 数据压缩：自有协议实现，未来可自主定制数据压缩，灵活控制客户端的流量、服务端网络吞吐；
* 高度封装：高度封装的API接口，保证了调用的简易性，也使得可应用于更多的应用场景；
* Web支持：可与姊妹工程 [MobileIMSDK-Web](http://www.52im.net/thread-959-1-1.html) 无缝互通实现网页端聊天或推送等；: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的疑问及解答](http://www.52im.net/thread-60-1-1.html)。

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

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

:point_right: 性能测试报告：[点此查看](http://www.52im.net/thread-57-1-1.html)。

# 八、演示程序
1. Android客户端 Demo：[点此安装和使用](http://www.52im.net/thread-55-1-1.html)；
2. iOS客户端 Demo：[点此安装和使用](http://www.52im.net/thread-54-1-1.html)；
3. Java客户端 Demo：[点此安装和使用](http://www.52im.net/thread-56-1-1.html)；
4. H5客户端 Demo：[点此查看介绍](http://www.52im.net/thread-3682-1-1.html)；
5. 服务端 Demo：[点此安装和使用](http://www.52im.net/thread-1272-1-1.html) :new:。

# 九、应用案例
#### ① 基于MobileIMSDK的产品级聊天APP：
> [详细介绍](http://www.52im.net/thread-19-1-1.html)、[下载体验](http://www.52im.net/thread-19-1-1.html) 或 [查看运行截图](http://www.52im.net/thread-20-1-1.html)。

#### ② MobileIMSDK在高网络延迟下的案例：
> 某款基于MobileIMSDK的商业商品，曾运营于跨洲际的复杂网络环境下，端到端通信延迟在洲际网络繁忙时可高达600ms以上（与服务端的单向延迟约为300ms左右，而通常大家访问国内主流门户的延迟约为20~50ms），某段时期的非敏感运营数据 [点此查看](http://www.52im.net/forum.php?mod=viewthread&tid=21&page=1&extra=#pid35)。

# 十、打包下载（all in one）
:paperclip: ① 最新发布版（国外地址）：[Github打包下载](https://github.com/JackJiang2011/MobileIMSDK/releases/latest)

:paperclip: ② 最新发布版（国内地址）：[码云gitee打包下载](https://gitee.com/jackjiang/MobileIMSDK/releases)（访问速度快！ :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要简单的多。

# 十二、开发指南
1. Android客户端开发指南：[点此查看](http://www.52im.net/thread-61-1-1.html)；
2. iOS客户端开发指南：[点此查看](http://www.52im.net/thread-62-1-1.html)；
3. Java客户端开发指南：[点此查看](http://www.52im.net/thread-59-1-1.html)；
4. H5客户端开发指南：[点此查看](http://www.52im.net/thread-3686-1-1.html)；
5. Server端开发指南：[点此查看](http://www.52im.net/thread-63-1-1.html)。

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

> 补充说明：如您还需获得更多技术支持或技术合作请联系作者，QQ：<code>413980957</code>（:point_right: [关于作者](http://www.52im.net/thread-2792-1-1.html)）。

# 十四、联系方式
* 讨论学习和资料区：:earth_americas: [点此进入](http://www.52im.net/forum-89-1.html)；
* 即时通讯技术交流群：`215477170` <a target="_blank" href="http://shang.qq.com/wpa/qunwpa?idkey=b05cf91f7b0aa8f00159793feb080c75f4fe0778b5b5385c5b8485905a2d8a4a"><img border="0" src="http://pub.idqqimg.com/wpa/images/group.png" alt="即时通讯(IM/推送)开发2" title="即时通讯(IM/推送)开发2"></a> （[更多QQ群点此进入](http://www.52im.net/portal.php?mod=topic&topicid=2)）；
* bug和建议请发送至：:love_letter: `jb2011@163.com`；
* 技术培训/转让/合作/咨询等欢迎联系作者QQ：:penguin: `413980957`、微信：`hellojackjiang` （:point_right: [关于作者](http://www.52im.net/thread-2792-1-1.html)）。

# 十五、捐助作者
优秀的开源需要您的支持才能走的更远，衷心感谢您的支持与理解，也希望您能从开源中收益。
* 捐助链接： [点此进入](http://www.52im.net/thread-411-1-1.html)。

# 十六、关注作者
* 关于作者：[点击进入](http://www.52im.net/thread-2792-1-1.html) :point_left:
* 推荐关注：[BeautyEye工程](https://github.com/JackJiang2011/beautyeye)
* 博客地址：[点击入进](http://www.52im.net/space-uid-1.html)
* Github主页：[点击进入](https://github.com/JackJiang2011)
* 我的公众号：:point_down: :point_down:

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_screenshots/others/my_mp_qr_400_b.png)

# 附录1：Demo运行截图
### :triangular_flag_on_post: MobileIMSDK Demo在Android和iOS 运行效果：
> <code>安装和使用：</code>[进入Android版Demo帮助页](http://www.52im.net/thread-55-1-1.html)、[进入iOS版Demo帮助页](http://www.52im.net/thread-54-1-1.html)。

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/andriod_demo_main.png)

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/ios_demo_main.png)

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_screenshots/others/ios_android_real_run2.jpg)

### :triangular_flag_on_post: MobileIMSDK Demo在Windows 运行效果：
> <code>安装和使用：</code>[进入Java版Demo帮助页](http://www.52im.net/thread-56-1-1.html)。

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/java_demo_main.png)

### :triangular_flag_on_post: MobileIMSDK Demo在Mac OS X 运行效果：
> <code>安装和使用：</code>[进入Java版Demo帮助页](http://www.52im.net/thread-56-1-1.html)。

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_screenshots/others/mac_real_run.png)

### :triangular_flag_on_post: MobileIMSDK-Web版客户端Demo运行效果：
> <code>1）MobileIMSDK-Web Demo在手机端浏览器运行效果：</code>[查看MobileIMSDK-Web版详情](http://www.52im.net/thread-959-1-1.html)。

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/mibileimsdk_web_demo_on_mobile_browsers.jpg)

> <code>2）MobileIMSDK-Web Demo在PC端多种主流浏览器的运行效果：</code>[查看MobileIMSDK-Web版详情](http://www.52im.net/thread-959-1-1.html)。

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/mibileimsdk_web_demo_on_pc_browsers.jpg)

# 附录2：基于MobileIMSDK的全功能IM产品【案例】
> <code>关于RainbowChat产品的更多资料请见：</code>[RainbowChat产品的全部功能截图](http://www.52im.net/thread-20-1-1.html) （真机实拍视频：[Andriod端](https://v.youku.com/v_show/id_XNDIzMzM4MzA3Mg==.html)、[iOS端](https://v.youku.com/v_show/id_XNDcwMDA4MDQwMA==.html)）。

:point_right: :point_right:【特别说明】：因github图片被墙，图未同步成功，请从 [RainbowChat产品的全部功能截图](http://www.52im.net/thread-20-1-1.html) 中查看！:point_left: :point_left:

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_v4_1.jpg)
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_v4_2.jpg)
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_v4_03.jpg)
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_v4_04.jpg)
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_v4_05.jpg)
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_v4_6.jpg)

> <code>更多清晰运行截图请见：</code>[RainbowCha产品的全部功能截图](http://www.52im.net/thread-20-1-1.html)。

# 附录3：基于MobileIMSDK的某客服系统【案例】
### :triangular_flag_on_post: 下图为某客服产品Web访客端：
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/cs-im-visitor-web.jpg)

### :triangular_flag_on_post: 下图为某客服产品Web客服端：
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/cs_im_servicer_web_20161227.jpg)

### :triangular_flag_on_post: 下图为某客服产品iOS客服端：
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/cs-im-servicer-ios_20170509.jpg)

# 附录4：基于MobileIMSDK-Web的网页端IM系统【案例】
### :triangular_flag_on_post: RainbowChat-Web产品主界面：
> <code>更多截图和视频：</code>[更多截图点此进入](http://www.52im.net/thread-2470-1-1.html)、[更多演示视频点此进入](http://www.52im.net/thread-2491-1-1.html)。

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_web/rbchat_web_main_1.jpg)

### :triangular_flag_on_post: RainbowChat-Web产品主界面(聊天窗全屏时)：
> <code>更多截图和视频：</code>[更多截图点此进入](http://www.52im.net/thread-2470-1-1.html)、[更多演示视频点此进入](http://www.52im.net/thread-2491-1-1.html)。

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_web/rbchat_web_main_2.jpg)

### :triangular_flag_on_post: RainbowChat-Web产品主界面(独立UI效果)：
> <code>更多截图和视频：</code>[更多截图点此进入](http://www.52im.net/thread-2470-1-1.html)、[更多演示视频点此进入](http://www.52im.net/thread-2491-1-1.html)。

![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_web/rbchat_web_main_0.jpg)

仪表盘开发小队/MobileIMSDK

简介

发行版

贡献者

近期动态

仪表盘开发小队/MobileIMSDK .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

仪表盘开发小队/MobileIMSDK