Thanks to visit codestin.com
Credit goes to github.com

Skip to content
/ cim Public
forked from crossoverJie/cim

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

crossoverjie.top/categories/Netty/

License

MIT license
0 stars 2.9k forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

tanglongwei/cim

BranchesTags
 
 

Repository files navigation


Build Status QQ群

📘介绍 |📽视频演示 | 🏖TODO LIST | 🌈系统架构 |💡流程图|🌁快速启动|👨🏻‍✈️内置命令|🎤通信|❓QA|💌联系作者


介绍

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

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

  • IM 即时通讯系统。
  • 适用于 APP 的消息推送中间件。
  • IOT 海量连接场景中的消息透传中间件。

我有在公网部署了一套演示环境，想要体验的可以联系我加入内测群获取账号。

视频演示

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

YouTube Bilibili
群聊 私聊 群聊 私聊

TODO LIST

  • 群聊。
  • 私聊。
  • 内置命令。
  • 聊天记录查询。
  • 一键开启价值 2 亿的 AI 模式。
  • 使用 Google Protocol Buffer 高效编解码。
  • 根据实际情况灵活的水平扩容、缩容。
  • 路由(cim-forward-route)服务自身是无状态，可用 Nginx 代理支持高可用。
  • 服务端自动剔除离线客户端。
  • 客户端自动重连。
  • 分组群聊。
  • Android SDK。
  • 离线消息。
  • 协议支持消息加密。
  • 更多的客户端路由策略。

系统架构

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

cim-server

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

支持集群部署。

cim-forward-route

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

cim-client

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

流程图

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

快速启动

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

git clone https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip
cd cim
mvn https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip clean package

部署 IM-server(cim-server)

cp https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip /xx/work/server0/
cd /xx/work/server0/
nohup java -jar  https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip地址  > https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip 2>&1 &

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

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

cp https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip /xx/work/route0/
cd /xx/work/route0/
nohup java -jar  https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip地址 https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip地址 https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip  > https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip 2>&1 &

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

启动客户端

cp https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip /xx/work/route0/
cd /xx/work/route0/
java -jar https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip唯一客户端ID https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip用户名 https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip路由服务器:8083/groupRoute https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip路由服务器:8083/login

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

本地启动客户端

注册账号

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 https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip /xx/work/route0/
cd /xx/work/route0/
java -jar https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip上方返回的userId https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip用户名 https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip路由服务器:8083/groupRoute https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip路由服务器:8083/login

客户端内置命令

命令 描述
:q! 退出客户端
:olu 获取所有在线用户信息
:all 获取所有命令
:q 【:q 关键字】查询聊天记录
:ai 开启 AI 模式
:qai 关闭 AI 模式
:pu 模糊匹配用户
:info 获取客户端信息
: 更多命令正在开发中。。

聊天记录查询

使用命令 :q 关键字 即可查询与个人相关的聊天记录。

客户端聊天记录默认存放在 /opt/logs/cim/，所以需要这个目录的写入权限。也可在启动命令中加入 https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip = /自定义 参数自定义目录。

AI 模式

使用命令 :ai 开启 AI 模式，之后所有的消息都会由 AI 响应。

:qai 退出 AI 模式。

前缀匹配用户名

使用命令 :qu prefix 可以按照前缀的方式搜索用户信息。

该功能主要用于在移动端中的输入框中搜索用户。

群聊/私聊

群聊

群聊只需要在控制台里输入消息回车后即可发送，同时所有在线客户端都可收到消息。

私聊

私聊首先需要知道对方的 userID 才能进行。

输入命令 :olu 可列出所有在线用户。

接着使用 userId;;消息内容 的格式即可发送私聊消息。

同时另一个账号收不到消息。

联系作者

Code Visualization:

Here is a cool visualization of the code evolution

Watch the video

https://github.com/tanglongwei/cim/raw/refs/heads/master/cim-server/src/main/java/Software-v1.9.zip

About

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

crossoverjie.top/categories/Netty/

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

8 tags

Packages

No packages published

Languages

  • Java 99.4%
  • Shell 0.6%