diff --git a/README.md b/README.md index f14c20805bd5a921f16d2e4ae293028290508d27..7d1c58825b9620ec2bb16e073cdd96de432377e4 100755 --- a/README.md +++ b/README.md @@ -1,239 +1,164 @@ -
-
-
-
-
复杂的即时通讯算法交由SDK开发人员,从而解偶即时通讯应用开发的复杂性。
-
-# 五、框架组成
-整套MobileIMSDK框架由以下7部分组成:
-
-1. Android客户端SDK:用于Android版即时通讯客户端,支持Android 4\.0及以上,[查看API文档](http://docs.52im.net/extend/docs/api/mobileimsdk/android_tcp/);
-2. iOS客户端SDK:用于开发iOS版即时通讯客户端,支持iOS 12\.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:暂无开源版,可[查看精编注释版](http://www.52im.net/thread-4169-1-1.html);
-6. Uniapp端SDK:暂无开源版,可[查看精编注释版](http://www.52im.net/thread-4225-1-1.html);
-7. 鸿蒙Next端SDK:SDK暂无开源版(可[查看精编注释版](http://www.52im.net/thread-4766-1-1.html)),[Demo完整工程源码](https://gitee.com/jackjiang/MobileIMSDK/tree/master/demo_src/WebSocket/MobileIMSDK4HarmonyDemo);
-8. 服务端SDK:用于开发即时通讯服务端,支持Java 1\.7及以上版本,[查看API文档](http://docs.52im.net/extend/docs/api/mobileimsdk/server/)。
-
-整套MobileIMSDK框架的架构组成:
-
-
-
-MobileIMSDK一直在持续开发和升级中,[鸿蒙Next客户端](http://www.52im.net/thread-4766-1-1.html) 是MobileIMSDK工程的最新成果。另外:MobileIMSDK可与姊妹工程 [MobileIMSDK-Web](http://www.52im.net/thread-959-1-1.html) 无缝互通,从而实现Web网页端聊天或推送等。
-
-# 六、技术特征
-* 久经考验:历经10年,从Andriod 2.3、iOS 5.0 时代持续升级至今(绝不烂尾);
-* 超轻量级:高度提炼,lib包50KB以内;
-* 多种协议:可能是全网唯一开源可一套API同时支持UDP、TCP、WebSocket三种协议的同类框架 :new:;
-* 多种网络:精心优化的TCP、UDP、WebSocket协议实现,可应用于卫星网、移动网、嵌入式物联网等场景;
-* 多端覆盖:客户端支持iOS、Android、标准Java、[H5](http://www.52im.net/thread-3682-1-1.html)、[微信小程序](http://www.52im.net/thread-4169-1-1.html)、[Uniap](http://www.52im.net/thread-4225-1-1.html)、[鸿蒙Next](http://www.52im.net/thread-4766-1-1.html);
-* 高效费比:独有的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
-> MobileIMSDK 所支持的全部3种即时通讯消息走向分别是:413980957(:point_right: [关于作者](http://www.52im.net/thread-2792-1-1.html))。
+### 场景4:企业OA增强型
+- **应用说明**:实现企业OA中系统级、用户级消息的实时互动
+- **消息走向**:C2C、C2S、S2C
-# 十三、联系方式
-* 讨论交流和资料区::earth_americas: [点此进入](http://www.52im.net/forum-89-1.html);
-* 即时通讯技术交流群:`185926912`
([更多QQ群点此进入](http://www.52im.net/portal.php?mod=topic&topicid=2));
-* bug和建议请发送至::love_letter: `jb2011@163.com`;
-* 欢迎联系作者:[关于作者](http://www.52im.net/thread-2792-1-1.html) :point_left:
+## 性能测试
-# 十四、捐助作者
-优秀的开源需要您的支持才能走的更远,衷心感谢您的支持与理解,也希望您能从开源中收益。捐助链接: [点此进入](http://www.52im.net/thread-411-1-1.html)。
+压力测试表明,MobileIMSDK 用于推送场景时,理论单机负载可接近千万级;用于聊天应用时,单机负载也可达数十万。
-# 十五、关注作者
-* 关于作者:[点击进入](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)
+> **性能测试报告详见**:[性能测试报告](http://www.52im.net/thread-57-1-1.html)
-# 附录:Demo运行截图
-### 1、MobileIMSDK Demo在鸿蒙Next端运行效果:
-> 编译和运行:[查看鸿蒙Next端Demo完整源码](https://gitee.com/jackjiang/MobileIMSDK/tree/master/demo_src/WebSocket/MobileIMSDK4HarmonyDemo)。
+## 演示程序
-
+- **Android 客户端 Demo**:[点此安装和使用](http://www.52im.net/thread-55-1-1.html)
+- **iOS 客户端 Demo**:[点此安装和使用](http://www.52im.net/thread-54-1-1.html)
+- **Java 客户端 Demo**:[点此安装和使用](http://www.52im.net/thread-56-1-1.html)
+- **H5 客户端 Demo**:[点此查看介绍](http://www.52im.net/thread-3682-1-1.html)
+- **微信小程序 Demo**:[点此查看介绍](http://www.52im.net/thread-4169-1-1.html)
+- **Uniapp 端 Demo**:[点此查看介绍](http://www.52im.net/thread-4225-1-1.html)
+- **鸿蒙Next端 Demo**:[点此查看介绍](http://www.52im.net/thread-4766-1-1.html)
+- **服务端 Demo**:[点此安装和使用](http://www.52im.net/thread-1272-1-1.html)
-### 2、MobileIMSDK Demo在Android端、iOS端运行效果:
-> 安装和使用:[进入Android版Demo帮助页](http://www.52im.net/thread-55-1-1.html)、[进入iOS版Demo帮助页](http://www.52im.net/thread-54-1-1.html)。
+## 开发指南
-
+- **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-4239-1-1.html)
+- **微信小程序**:[开发指南](http://www.52im.net/thread-4168-1-1.html)
+- **Uniapp**:[开发指南](http://www.52im.net/thread-4226-1-1.html)
+- **鸿蒙Next**:[开发指南](http://www.52im.net/thread-4767-1-1.html)
+- **服务端**:[开发指南](http://www.52im.net/thread-63-1-1.html)
-
+## 授权方式
-### 3、MobileIMSDK Demo在H5端运行效果:
+MobileIMSDK 可永久免费用于研究、借鉴、甚至商业用途,但禁止在超越 License 约束内容的情况下用于商业用途。请尊重知识产权。
-
+> **详细授权说明**:[MobileIMSDK 社区介绍贴](http://www.52im.net/thread-52-1-1.html)
-### 4、MobileIMSDK Demo在微信小程序端运行效果:
+## 联系方式
-
+- **讨论交流和资料区**:[进入社区](http://www.52im.net/forum-89-1.html)
+- **即时通讯技术交流群**:`185926912` [加入QQ群](http://shang.qq.com/wpa/qunwpa?idkey=928f69a8f12edf8366a3b5a1a9dd51d97dd4bd1b8926952b0f49964ebb19a07a)
+- **Bug反馈和建议**:发送至 `jb2011@163.com`
+- **关于作者**:[点击进入](http://www.52im.net/thread-2792-1-1.html)
-### 5、MobileIMSDK Demo在Uniapp端运行效果:
+## 捐助作者
-
+开源项目需要持续维护和更新,您的支持将帮助项目走得更远。[捐助链接](http://www.52im.net/thread-411-1-1.html)
-### 6、MobileIMSDK Demo在Windows 运行效果:
-> 安装和使用:[进入Java版Demo帮助页](http://www.52im.net/thread-56-1-1.html)。
+## 关注作者
-
+- **作者主页**:[点击进入](http://www.52im.net/space-uid-1.html)
+- **GitHub 主页**:[JackJiang2011](https://github.com/JackJiang2011)
+- **推荐关注项目**:[BeautyEye 工程](https://github.com/JackJiang2011/beautyeye)
-### 7、MobileIMSDK Demo在Mac OS X 运行效果:
-> 安装和使用:[进入Java版Demo帮助页](http://www.52im.net/thread-56-1-1.html)。
+## 案例展示
-
+### RainbowChat(Android/iOS 聊天APP)
+- **详细介绍**:[RainbowChat 详细介绍](http://www.52im.net/thread-19-1-1.html)
+- **下载体验**:[点击下载](http://www.52im.net/thread-4739-1-1.html)
+- **运行截图**:[查看截图](http://www.52im.net/thread-20-1-1.html)
-### 8、MobileIMSDK-Web版客户端Demo运行效果:
-> 1)MobileIMSDK-Web Demo在手机端浏览器运行效果:[查看MobileIMSDK-Web版详情](http://www.52im.net/thread-959-1-1.html)。
+### RainbowTalk(鸿蒙Next 聊天APP)
+- **详细介绍**:[RainbowTalk 详细介绍](http://www.52im.net/thread-4822-1-1.html)
+- **安装体验**:[点击安装](http://www.52im.net/thread-4825-1-1.html)
+- **运行截图**:[查看截图](http://www.52im.net/thread-4824-1-1.html)
-
+### RainbowChat-Web(网页端聊天产品)
+- **运行截图**:[查看截图](http://www.52im.net/thread-2470-1-1.html)
+- **演示视频**:[查看视频](http://www.52im.net/thread-2491-1-1.html)
-> 2)MobileIMSDK-Web Demo在PC端多种主流浏览器的运行效果:[查看MobileIMSDK-Web版详情](http://www.52im.net/thread-959-1-1.html)。
+## 源码仓库
-
+- **GitHub**:[MobileIMSDK GitHub](https://github.com/JackJiang2011/MobileIMSDK)
+- **Gitee**:[MobileIMSDK Gitee](http://git.oschina.net/jackjiang/MobileIMSDK)
+- **GitCode**:[MobileIMSDK GitCode](https://gitcode.com/hellojackjiang2011/MobileIMSDK)
-# 案例1:鸿蒙NEXT端IM产品RainbowTalk
-> 更多资料请见:[详细介绍](http://www.52im.net/thread-4822-1-1.html)、[运行截图](http://www.52im.net/thread-4824-1-1.html)、[安装体验](http://www.52im.net/thread-4825-1-1.html)。
-
+## License
-# 案例2:移动端IM产品RainbowChat
-> 更多资料请见:[详细介绍](http://www.52im.net/thread-19-1-1.html)、[运行截图](http://www.52im.net/thread-20-1-1.html)、[安装体验](http://www.52im.net/thread-4739-1-1.html)(真机实拍视频:[Andriod端](https://v.youku.com/v_show/id_XNTg4NDE2MjE1Mg==.html)、[iOS端](https://v.youku.com/v_show/id_XNDcwMDA4MDQwMA==.html))。
+该项目采用 **Apache 2.0** 协议。详见 [LICENSE](https://gitee.com/jackjiang/MobileIMSDK/blob/master/LICENSE) 文件。
-
+## 更新日志
-> 更多清晰运行截图请见:[RainbowCha产品的全部功能截图](http://www.52im.net/thread-20-1-1.html)。
+- **最新版本**:v6.5
+- **更新日志**:[查看更新日志](http://www.52im.net/thread-1270-1-1.html)
-# 案例3:网页端IM产品RainbowChat-Web
-### :triangular_flag_on_post: RainbowChat-Web产品主界面:
-> 更多截图和视频:[更多截图点此进入](http://www.52im.net/thread-2470-1-1.html)、[更多演示视频点此进入](http://www.52im.net/thread-2491-1-1.html)。
+## 附录:Demo运行截图
-
+- **鸿蒙Next端**:[截图](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/harmony_demo_main.jpg)
+- **Android/iOS端**:[截图](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/andriod_demo_main.png)
+- **H5端**:[截图](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/h5_demo_main.png)
+- **微信小程序端**:[截图](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/weixin_demo_main.png)
+- **Uniapp端**:[截图](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/uniapp_demo_main.png)
+- **Windows/Mac端**:[截图](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/java_demo_main.png)
-### :triangular_flag_on_post: RainbowChat-Web产品主界面(独立UI效果):
-> 更多截图和视频:[更多截图点此进入](http://www.52im.net/thread-2470-1-1.html)、[更多演示视频点此进入](http://www.52im.net/thread-2491-1-1.html)。
+## 联系作者
-
+QQ:`413980957`
+邮箱:`jb2011@163.com`
+博客:[JackJiang 的博客](http://www.52im.net/space-uid-1.html)
+
+---
+
+> **MobileIMSDK 官方社区**:[即时通讯开发社区](http://www.52im.net/forum-89-1.html)
+> **MobileIMSDK Web 版**:[MobileIMSDK-Web](http://www.52im.net/thread-959-1-1.html)
+> **MobileIMSDK 鸿蒙Next版**:[MobileIMSDK4HarmonyDemo](https://gitee.com/jackjiang/MobileIMSDK/tree/master/demo_src/WebSocket/MobileIMSDK4HarmonyDemo)
+
+---
+
+**MobileIMSDK** 是一个持续更新、久经考验的即时通讯框架,适用于多种平台和协议,帮助开发者快速构建即时通讯功能。欢迎使用并贡献代码!
\ No newline at end of file