cim 📲cim(cross IM) 适用于开发者的即时通讯系统 @codeKK AndroidOpen Source Website

cim

Project Url: crossoverJie/cim

Introduction: 📲cim(cross IM) 适用于开发者的即时通讯系统

More: Author ReportBugs OfficialWebsite

Tags:

# V2.0 - [x] Upgrade to JDK17 & springboot3.0 - [x] Client SDK - [ ] Client use picocli instead of springboot. - [x] Support integration testing. - [ ] Integrate OpenTelemetry . - [ ] Support single node startup(Contains no components). - [ ] Third-party components support replacement(Redis/Zookeeper, etc.). - [ ] Support web client(websocket). - [ ] Support docker container. - [ ] Support kubernetes operation. - [ ] Supports binary client(build with golang). ## Introduction CIM(CROSS-IM) is an IM (instant messaging) system for developers; it also provides some components to help developers build their own scalable IM. Using CIM, you can achieve the following requirements: - IM instant messaging system. - Message push middleware for APP. - Message middleware for IOT massive connection scenarios. > If you have any questions during use or development, you can contact me. ## 视频演示 > 点击下方链接可以查看视频版 Demo。 | YouTube | Bilibili| | :------:| :------: | | 群聊私聊 | 群聊私聊 | |

## TODO LIST [x] 群聊 [x] 私聊 [x] 内置命令 [x] 聊天记录查询。 [x] 一键开启价值 2 亿的 AI 模式 [x] 使用 Google Protocol Buffer 高效编解码 [x] 根据实际情况灵活的水平扩容、缩容 [x] 服务端自动剔除离线客户端 [x] 客户端自动重连 [x] 延时消息 [x] SDK 开发包 [ ] 分组群聊 [ ] 离线消息 [ ] 消息加密 ## Architecture

- Each component in CIM is built using SpringBoot - Client build with cim-client-sdk - Use Netty to build the underlying communication. - MetaStore is used for registration and discovery of IM-server services. ### cim-server IM server is used to receive client connections, message forwarding, message push, etc. Support cluster deployment. ### cim-route Route server; used to process message routing, message forwarding, user login, user offline, and some operation tools (get the number of online users, etc.). ### cim-client IM client terminal, a command can be started and initiated to communicate with others (group chat, private chat). ## Flow Chart

- Server register to MetaStore - Route subscribe MetaStore - Client login to Route - Route get Server info from MetaStore - Client open connection to Server - Client1 send message to Route - Route select Server and forward message to Server - Server push message to Client2 ## 快速启动首先需要安装 Zookeeper、Redis 并保证网络通畅。

shell
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
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
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
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
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
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{
  "reqNo": "1234567890",
  "timeStamp": 0,
  "userName": "zhangsan"
}' 'http://路由服务器:8083/registerAccount'

从返回结果中获取 userId

json
{
    "code":"9000",
    "message":"成功",
    "reqNo":null,
    "dataBody":{
        "userId":1547028929407,
        "userName":"test"
    }
}

#### 启动本地客户端

shell
# 启动本地客户端
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] | 发送延时消息 | | : | 更多命令正在开发中。。 |