+0
日增长
9,491
stars
2,856
forks
385
watchers
89
prs
98
issues
9
releases
README
📘介绍 |📽视频演示 | 🏖TODO LIST | 🌈系统架构 |💡流程图|🌁快速启动|👨🏻✈️内置命令|🎤通信|❓QA|💌联系作者 English V2.0 - [x] 升级至 JDK17 & springboot3.0 - [x] Client SDK - [ ] 客户端使用 picocli 替代 springboot - [x] 支持集成测试 - [ ] 集成 OpenTelemetry - [ ] 支持单节点启动(不依赖外部组件) - [ ] 第三方组件支持替换(Redis/Zookeeper 等) - [ ] 支持 Web 客户端(websocket) - [x] 支持 Docker 容器 - [ ] 支持 Kubernetes 部署 - [ ] 支持二进制客户端(使用 golang 构建) 介绍 CIM(CROSS-IM) 是面向开发者的 IM(即时通讯) 系统;同时提供了一些组件帮助开发者构建自己可扩展的 IM。 借助 CIM 你可以实现以下需求: - IM 即时通讯系统。 - APP 消息推送中间件。 - IOT 海量连接场景中的消息中间件。 如果在使用或开发过程中有任何问题,可以联系作者。 视频演示 点击下方链接可以查看视频版 Demo。 | YouTube | Bilibili| | :------:| :------: | | 群聊 私聊 | 群聊 私聊 | | | !demo.gif TODO LIST [x] 群聊 [x] 私聊 [x] 内置命令 [x] 聊天记录查询 [x] 一键开启 AI 模式 [x] 使用 Google Protocol Buffer 高效编解码 [x] 根据实际情况灵活的水平扩容、缩容 [x] 服务端自动剔除离线客户端 [x] 客户端自动重连 [x] 延时消息 [x] SDK 开发包 [ ] 分组群聊 [ ] 离线消息 [ ] 消息加密 系统架构 ! - CIM 中的各个组件均采用 SpringBoot 构建 - 客户端基于 cim-client-sdk 构建 - 采用 Netty 构建底层通信 - MetaStore 用于 IM-server 服务的注册与发现 cim-server IM 服务端,用于接收客户端连接、消息转发、消息推送等功能。 支持集群部署。 cim-route 路由服务器;用于处理消息路由、消息转发、用户登录、用户下线以及一些运维工具(获取在线用户数等)。 cim-client IM 客户端终端,一个命令即可启动并与其他人进行通信(群聊、私聊)。 流程图 ! - Server 注册到 MetaStore - Route 订阅 MetaStore - Client 登录到 Route - Route 从 MetaStore 获取 Server 信息 - Client 与 Server 建立连接 - Client1 发送消息到 Route - Route 选择 Server 并将消息转发给 Server - Server 将消息推送给 Client2 快速启动 Docker allin1 镜像内置了 Zookeeper、Redis、cim-server、cim-forward-route 四个服务,使用 Supervisor 统一管理,开箱即用。 支持平台: linux/amd64, linux/arm64, linux/arm/v7 端口说明: | 端口 | 服务 | 说明 | |------|---------|-------------| | 2181 | Zookeeper | 服务注册与发现 | | 6379 | Redis | 数据缓存 | | 8083 | Route Server | HTTP API 路由服务 | 拉取镜像并启动: shell docker pull ghcr.io/crossoverjie/allin1-ubuntu:latest docker run -p 2181:2181 -p 6379:6379 -p 8083:8083 --rm --name cim-allin1 ghcr.io/crossoverjie/allin1-ubuntu:latest 容器启动后,可参考下方 注册账号 和 启动客户端 章节快速体验完整的 IM 流程。 本地构建 Docker 镜像 如果需要从源码构建镜像: shell 在项目根目录执行 docker build -t cim-allin1:latest -f docker/allin1-ubuntu.Dockerfile . docker run -p 2181:2181 -p 6379:6379 -p 8083:8083 --rm --name cim-allin1 cim-allin1:latest 本地编译 首先需要安装 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 install -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-SNAPSHO
Top issues
#10Mobile iOS Android 13 comments · 2019-01-03#65为什么server转发消息给目的client的时候要走netty而不是直接http调用呢11 comments · 2019-10-31#19其他组件启动都没有问题,就是client启动报错了11 comments · 2019-01-16#135Help wanted! Here are some simple tasks that can be handled🎉.10 comments · 2024-07-26#56netty 路由发消息通过http服务实现,性能怎么样6 comments · 2019-09-20#117数据是如何存储的呢?5 comments · 2021-03-17#97为什么发送消息走http5 comments · 2020-06-14#24画了个简易的实现原理图 ^_^5 comments · 2019-01-18
Latest release
v2.1.0 v2.1.0 2025-06-09What's Changed Upgrade to protocol3 by @crossoverJie in https://github.com/crossoverJie/cim/pull/163 Protocol add properties by @crossoverJie in https://github.com/crossoverJie/cim/pull/164 [fix] Cross-platform compilation by @chenqwwq in https://github.com/crossoverJie/cim/pull/165 feat: Support allin1 docker image by @crossoverJie in https://github.com/crossoverJie/cim/pull/169 feat: Enhance messaging system with batch message support by @crossoverJie in https://github.com/crossoverJie/cim/pull/171 Feat/offline msg by @Zdanquxunhuan in https://github.com/crossoverJie/cim/pull/170