gomicroim / gomicroim

a microservice architecture im(chat) server with golang, suport docker & k8s.

gomicroim

opensource distributed microservice im server write by golang（开源分布式微服务IM服务端）.

特性：

• 分布式微服务架构。基于 kratos v2框架实现
• 同时支持读写扩散。针对 web 使用读扩散模式，针对 app 使用写扩散
• 离线消息同步使用 time-line模型，配合mongo实现高性能离线消息同步
• 在线消息漫游使用 mysql 存储，满足审计和任意时间回溯消息的需求
• BFF 层设计 + kong api网关设计，更贴合实战
• 简化私有协议设计，除了消息推送(websocket协议)之外，发消息、拉聊天列表等等都使用HTTP+JSON方式实现，简化私有协议开发成本
• websocket gateway 网关之间通信使用 kafka assign模式，解决高吞吐量下的消息跨服路由性能问题和可用性问题
• 支持docker compose 和 k8s 部署
• 支持百万级并发用户在线。建议使用 k8s 部署，配合动态扩容，实现高峰期的资源自适应分配和调整

architecture:

物理架构图

所有IM关键服务都运行在k8s容器集群上。

逻辑架构图

• 负载均衡层：物理机部署使用ngix，k8s则使用ingress
• 网关层：包含长连接网关(WebSocket)和API网关，API网关这里使用的kong
• BFF层（Backend for Frontend）：提供http接口，聚合后端接口，为前端写的后端服务层，单向依赖 Service 层。
• Service（RPC）：真正的服务实现层，对外提供各个模块的grpc接口
• 存储：存储层，主要是分布式缓存和分布式文档数据库，以及传统关系型mysql数据库。mongo主要用来扩散写存离线消息，mysql用来持久化存储历史消息，供消息漫游使用。

模块交互图

Client

• Android: 基于android 7.0 + java实现，目前正在开发中（2022年8月），适用于 V2版本 服务端。

Preview

to do.

Features

See: FEATURE.md

Quick Start

PS：请切换到master分支，编译和运行！

启动Server（要求安装docker desktop >= 4.0.1）:

$ git clone https://github.com/gomicroim/gomicroim.git
$ cd gomicroim
# 启动 redis kafka mongo mysql etcd等依赖
$ docker-compose up -d -f docker-compose.dep.yml
# 启动 kong api 网关相关依赖
$ docker-compose up -d -f docker-compose.kong.yml
# 启动 gomicroim 所有的服务
$ docker-compose up -d -f docker-compose.yml

停止：

$ cd gomicroim
$ docker-compose down -v

Build

see: build.md

Thinks

• mattermost：主要学习其go工程实践方面的一些技巧，目前还处在研究阶段。
• Open-IM-Server：通过分析它的架构和代码，理解了收件箱机制和im 微服务(go)的划分实践。
• goim：学习到百万级架构下kafka是如何应用在聊天室场景的。
• Terry-Ye/im：结合goim，理解了所谓的job含义，看懂了goim的架构。
• gim：一个简单的写扩散项目，可以更深入理解写扩散的架构和原理。

更多开源im，请移步：史上最全开源IM盘点

Contact

email：[email protected]
微信交流：xuyc1992（请备注：im）

喜欢的话，关注下公众号吧😊
《Go和分布式IM》👈👈

LICENSE

gomicroim is provided under the mit license.