20241024更新：最近换工作实在太忙，此项目先搁置，不过绝不代表停止！
与im结缘是在2022年，因为此类系统有足够大的挑战性，所以我对此如痴如醉，之前做过架构以及细节方面的设计，但是一直没有落地。不落地的设计不是好设计。所以有了这个项目。 目前项目处于前期阶段，后期一点点完善并将补上架构图和我能想到的所有设计细节！
想要设计一个好的im系统，是很有难度的，本项目将尽可能达到以下几点：
- 高并发
- 高可用
- 高性能
- 稳定可靠
- 灵活好扩展
- 可观测
下边我们了解下总体设计和一些详细情况。以便有兴趣的人员学习/参与进来，当然如何参与下边也会说到。
正在编写&画图中......
目前表结构详见：表结构，当然有的表会分库分表，脚本在这里：分库分表脚本
- 已集成
- SpringBoot【项目搭建】✅
- Netty【长连接服务器】✅
- Spring Cloud Alibaba Nacos【配置中心】✅
- Dubbo【rpc调用，利用长连接做消息转发】✅
- zookeeper【暂时用处只是dubbo注册，后期如果没有其他用处可能移除，让dubbo注册到nacos】
- Redis【缓存，分布式锁】✅
- RocketMQ【解耦、削峰】✅
- Mybatis Plus【ORM】✅
- Mysql【数据存储】✅
- Spring Cloud GateWay 【网关】✅
- Oauth2 + Spring Security 【认证&鉴权】✅
- 在雪花算法基础上 生成含有业务信息的 msgId，长连接获取批量消息id ✅
- prometheus + grafana【服务监控✅】
- Jenkins 持续集成与持续交付 ✅
- 待集成
- 序列化协议：protobuf
- Sentinel 【限流】
- docker ✅ +k8s【项目部署】
- SkyWalking 【链路追踪】
- ElasticSearch【聊天记录等搜索】
- Jmeter+python脚本【压测】
- redis集群部署
- elasticsearch集群部署
- canal 数据同步 mysql同步到es
- mysql分库分表 ✅(暂时只对消息记录表做了分库分表)
在此，我使用表格来总结，如果你对下边的未实现功能有兴趣 或者 对已实现功能有建议，欢迎提issues和PR，参与进来一起维护开源，共同成长。 如何参与？ 详见文档：CONTRIBUTING
图例：
- ⬜ ：未实现
- ⏳ ：正在进行中
- ✅ ：已实现
- ❌ ：取消
| 功能 | 当前进度 | 技术文档 | 实现者 | 备注 |
|---|---|---|---|---|
| 注册 | 后端⬜，前端⬜ | 登录&注册设计文档 | ||
| 登录 | 后端✅，前端⬜ | 登录&注册设计文档 | 后端（蝎子莱莱爱打怪），前端（） | 在登录成功后，按照算法选取出某一个可用长连接服务 |
| 功能 | 当前进度 | 技术文档 | 实现者 | 备注 |
|---|---|---|---|---|
| 单聊（发文字） | 后端✅，前端⏳ | 单聊设计文档 | 后端（蝎子莱莱爱打怪），前端（蝎子莱莱爱打怪） | |
| 单聊（发图片） | 后端⬜，前端⬜ | 单聊设计文档 | ||
| 单聊（发位置） | 后端⬜，前端⬜ | 单聊设计文档 | ||
| 单聊（发语音） | 后端⬜，前端⬜ | 单聊设计文档 | ||
| 单聊（音/视频） | 后端⬜，前端⬜ | 单聊设计文档 | ||
| 单聊（撤回） | 后端✅，前端⬜ | 单聊设计文档 | 后端（蝎子莱莱爱打怪），前端（） | |
| 单聊（送达服务端/客户端未读/客户端已读ack） | 后端✅，前端⬜ | 单聊设计文档 | 后端（蝎子莱莱爱打怪），前端（） |
| 功能 | 当前进度 | 技术文档 | 实现者 | 备注 |
|---|---|---|---|---|
| 群聊（方案/表设计） | ⬜ | 准备采用写扩散模型，不再像单聊一样基于dubbo做转发，直接rocketMq广播消费 | ||
| 群聊（发文字） | 后端⬜，前端⬜ | |||
| 群聊（发图片） | 后端⬜，前端⬜ | |||
| 群聊（发位置） | 后端⬜，前端⬜ | |||
| 群聊（发语音） | 后端⬜，前端⬜ | |||
| 群聊（音/视频） | 后端⬜，前端⬜ | |||
| 群聊（群管理） | 后端⬜，前端⬜ | 创建群聊/退出/解散/群成员角色添加/等 |
| 功能 | 当前进度 | 技术文档 | 实现者 | 备注 |
|---|---|---|---|---|
| 好友关系 | 后端⬜，前端⬜ |
| 功能 | 当前进度 | 技术文档 | 实现者 | 备注 |
|---|---|---|---|---|
| 置顶 | 后端⬜，前端⬜ | |||
| 不显示该聊天 | 后端⬜，前端⬜ | |||
| 删除会话 | 后端⬜，前端⬜ | |||
| 最近会话列表⏳ | 后端⏳，前端⏳ | 最近会话列表设计文档 | 后端（蝎子莱莱爱打怪），前端（蝎子莱莱爱打怪） | 此逻辑不需要后端参加 |
| 功能 | 当前进度 | 技术文档 | 实现者 | 备注 |
|---|---|---|---|---|
| 消息id设计 | 后端✅ | xzll-im消息id设计文档 | 蝎子莱莱爱打怪 | 此逻辑不需要前端参加，前端只管通过长连接批量获取msgId就可以了 |
| 离线消息 | 后端✅，前端⬜ | 离线消息实现概要 | 后端（蝎子莱莱爱打怪），前端（） | （push✅+pull⬜） |
| 服务端心跳检测（超时自动剔除客户端连接） | 后端✅ | （服务端）超时断连设计文档.md | 后端（蝎子莱莱爱打怪） | 此逻辑不需要前端参加 |
| 客户端断线重连 | 前端⬜ | 此逻辑不需要后端参加 | ||
| 聊天消息搜索 | 后端⬜，前端⬜ | |||
| 消息失败重试 | 后端✅，前端⬜ | 后端（蝎子莱莱爱打怪） | ||
| 消息顺序性 | 前端⬜ | 此功能依赖客户端，服务端不作处理 | ||
| 消息防重处理 | 前端⬜ | 此功能依赖客户端，服务端不作处理 | ||
| 直播 | 后端⬜，前端⬜ | 规划中 |
详见文档：CONTRIBUTING
注意：因为此项目目前还在开发中，多数情况下，都是在idea（xzll-im-server）和 Android Studio（xzll-im-client） 中写完代码并调试自测。所以着重看这个就行。
首先需要安装依赖的环境，想运行服务端，以下几个是中间件和db是必不可少的
- RocketMQ：（docker部署）
- 包含（rocket_nameserver,rocket_broker,rocket_console）
- Redis （docker部署）
- Zookeeper（docker部署）
- Nacos（docker部署）
- MySQL（虚拟机部署）详见：Centos7安装mysql8.0.35（亲测）
- ElasticSearch（虚拟机部署）详见：Centos7安装Elasticsearch和Kibana 记录（无坑版）
为了方便，其中docker部署的，写了个脚本（脚本内容 戳这里（注意运行脚本时需要指定你的ip）），启动脚本的命令是：
sudo sh dev_start_dependencies_script.sh 172.30.128.65
启动后的效果如下:
在启动之后，接下来，需要配置nacos相关，首先我们先建一个命名空间，此命名空间用于区分环境，如下：
接下来 导入nacos配置（nacos 配置文件戳这里）：
导入后的结果：
编写中.....
参考我在掘金的文章：使用Jenkins 部署我的 xzll-im-server 项目
提示：在开发阶段，基本不需要这样做。到了测试环境，生产环境，那再来看这个指南。不过随着项目迭代，此指南是不断更新的。
微信 ：
邮箱 ： [email protected]