IM 开源系列

IM

https://github.com/crossoverJie/cim

CIM

V2.0

[x] 升级至 JDK17 和 Spring Boot 3.0 [x] 客户端 SDK [ ] 客户端使用 picocli 替代 Spring Boot。 [x] 支持集成测试。 [ ] 集成 OpenTelemetry。 [ ] 支持单节点启动（不含任何组件）。 [ ] 支持第三方组件替换（如 Redis/Zookeeper 等）。 [ ] 支持 Web 客户端（WebSocket）。 [ ] 支持 Docker 容器。 [ ] 支持 Kubernetes 运行。 [ ] 支持二进制客户端（使用 Golang 构建）。

介绍

CIM（CROSS-IM）是一个面向开发者的 IM（即时通讯）系统，同时也提供了一些组件，帮助开发者构建可扩展的 IM 系统。使用 CIM，您可以实现以下需求：实现 IM 即时通讯系统。

为 APP 提供消息推送中间件。

为 IOT 大规模连接场景提供消息中间件。

如果在使用或开发过程中有任何问题，您可以联系作者。

视频演示

点击下方链接可以查看视频版 Demo。

YouTube	Bilibili
群聊私聊	群聊私聊

TODO LIST

架构

CIM 中的每个组件都是使用 SpringBoot 构建的。

客户端使用 cim-client-sdk 构建。

使用 Netty 构建底层通信。

使用 MetaStore 用于 IM-server 服务的注册与发现。

cim-server

IM 服务器用于接收客户端连接、消息转发、消息推送等功能，支持集群部署。

cim-route

路由服务器，用于处理消息路由、消息转发、用户登录、用户离线以及一些运维工具（如获取在线用户数量等）。

cim-client

IM 客户端终端，可以通过命令启动并与他人进行通信（群聊、私聊）。

流程图

服务器向 MetaStore 注册。
路由服务器订阅 MetaStore。
客户端登录到路由服务器。
路由服务器从 MetaStore 获取服务器信息。
客户端与服务器建立连接。
客户端 1 向路由服务器发送消息。
路由服务器选择服务器并将消息转发到服务器。
服务器将消息推送至客户端 2。

快速启动

首先需要安装 Zookeeper、Redis 并保证网络通畅。

  [shell]
1
2
docker run --rm --name zookeeper -d -p 2181:2181 zookeeper:3.9.2
docker run --rm --name redis -d -p 6379:6379 redis:7.4.0

  [shell]
1
2
3
4
5
git clone https://github.com/crossoverJie/cim.git
cd cim
mvn clean package -DskipTests=true
cd cim-server && cim-client && cim-forward-route
mvn clean package spring-boot:repackage -DskipTests=true

部署 IM-server(cim-server)

  [shell]
1
2
3
cp /cim/cim-server/target/cim-server-1.0.0-SNAPSHOT.jar /xx/work/server0/
cd /xx/work/server0/
nohup java -jar  /root/work/server0/cim-server-1.0.0-SNAPSHOT.jar --cim.server.port=9000 --app.zk.addr=zk地址  > /root/work/server0/log.file 2>&1 &

cim-server 集群部署同理，只要保证 Zookeeper 地址相同即可。

部署路由服务器(cim-forward-route)

  [shell]
1
2
3
cp /cim/cim-server/cim-forward-route/target/cim-forward-route-1.0.0-SNAPSHOT.jar /xx/work/route0/
cd /xx/work/route0/
nohup java -jar  /root/work/route0/cim-forward-route-1.0.0-SNAPSHOT.jar --app.zk.addr=zk地址 --spring.redis.host=redis地址 --spring.redis.port=6379  > /root/work/route/log.file 2>&1 &

cim-forward-route 本身就是无状态，可以部署多台；使用 Nginx 代理即可。

启动客户端

  [shell]
1
2
3
cp /cim/cim-client/target/cim-client-1.0.0-SNAPSHOT.jar /xx/work/route0/
cd /xx/work/route0/
java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=唯一客户端ID --cim.user.userName=用户名 --cim.route.url=http://路由服务器:8083/

如上图，启动两个客户端可以互相通信即可。

本地启动客户端

注册账号

  [shell]
1
2
3
4
5
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
  "reqNo": "1234567890",
  "timeStamp": 0,
  "userName": "zhangsan"
}' 'http://路由服务器:8083/registerAccount'

从返回结果中获取 userId

  [json]
1
2
3
4
5
6
7
8
9
{
    "code":"9000",
    "message":"成功",
    "reqNo":null,
    "dataBody":{
        "userId":1547028929407,
        "userName":"test"
    }
}

启动本地客户端

  [shell]
1
2
3
4
# 启动本地客户端
cp /cim/cim-client/target/cim-client-1.0.0-SNAPSHOT.jar /xx/work/route0/
cd /xx/work/route0/
java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=上方返回的userId --cim.user.userName=用户名 --cim.route.url=http://路由服务器:8083/

客户端内置命令

命令	描述
`:q!`	退出客户端
`:olu`	获取所有在线用户信息
`:all`	获取所有命令
`:q [option]`	【:q 关键字】查询聊天记录
`:ai`	开启 AI 模式
`:qai`	关闭 AI 模式
`:pu`	模糊匹配用户
`:info`	获取客户端信息
`:emoji [option]`	查询表情包 [option:页码]
`:delay [msg] [delayTime]`	发送延时消息
`:`	更多命令正在开发中。。