V2.0

介绍

CIM(CROSS-IM)是一款面向开发者的即时通讯系统；同时提供了一些组件帮助开发者构建一款属于自己的可水平扩展的即时通讯系统。

借助CIM你可以实现以下需求：

即时通讯系统
适用于APP的消息推送中间件
物联网海量连接场景中的消息透传中间件

在使用或开发过程中有任何疑问都可以联系我。

视频演示

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

YouTube	Bilibili
群聊私聊	群聊私聊

待办事项

系统架构

CIM中的各个组件均采用SpringBoot构建。
采用Netty构建底层通信。
Redis存放各个客户端的路由信息、账号信息、在线状态等。
Zookeeper用于IM-server服务的注册与发现。

cim-server

IM服务端；用于接收客户端连接、消息透传、消息推送等功能。

支持集群部署。

cim-forward-route

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

cim-client

IM客户端；给用户使用的消息终端，一个命令即可启动并向其他人发起通讯（群聊、私聊）。

流程图

客户端向route发起登录。
登录成功从Zookeeper中选择可用IM-server返回给客户端，并保存登录、路由信息到Redis。
客户端向IM-server发起长连接，成功后保持心跳。
客户端下线时通过route清除状态信息。

快速启动

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

docker run --name zookeeper -d -p 2181:2181 zookeeper
docker run --rm --name redis -d -p 6379:6379 redis

git clone https://github.com/crossoverJie/cim.git
cd cim
mvn -Dmaven.test.skip=true clean package

部署IM-server(cim-server)

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)

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代理即可。

启动客户端

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/

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

本地启动客户端

注册账号

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

从返回结果中获取userId

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

启动本地客户端

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