golang写的IM服务器(服务组件形式)

简要介绍

im是一个即时通讯服务器,代码全部使用golang完成。主要功能
1.支持tcp,websocket接入
2.离线消息同步
3.单用户多设备同时在线
4.单聊,群聊,以及房间聊天场景
5.支持服务水平扩展
gim和im有什么区别?im可以作为一个im中台提供给业务方使用,而gim可以作为以业务服务器的一个组件,为业务服务器提供im的能力,业务服务器的user服务只需要实现user.int.proto协议中定义的GRPC接口,为im服务提供基本的用户功能即可,其实以我目前的认知,我更推荐这种方式,这种模式相比于im,我认为最大好处在于一下两点:
1.gim不需要考虑多个app的场景,相比im,业务复杂度降低了一个维度
2.各个业务服务可以互不影响,可以做到风险隔离

使用技术:

数据库:MySQL+Redis
通讯框架:GRPC
长连接通讯协议:Protocol Buffers
日志框架:Zap
ORM框架:GORM

安装部署

1.首先安装MySQL,Redis
2.创建数据库gim,执行sql/create_table.sql,完成初始化表的创建(数据库包含提供测试的一些初始数据)
3.修改config下配置文件,使之和你本地配置一致
4.分别切换到cmd的connect,logic,business目录下,执行go run main.go,启动TCP连接层服务器,WebSocket连接层服务器,逻辑层服务器,用户服务器
(注意:tcp_conn只能在linux下启动,如果想在其他平台下启动,请安装docker,执行run.sh)

项目目录简介

项目结构遵循 https://github.com/golang-standards/project-layout

cmd:          服务启动入口
config:       服务配置
internal:     每个服务私有代码
pkg:          服务共有代码
sql:          项目sql文件
test:         长连接测试脚本

服务简介

1.connect
维持与客户端的TCP和WebSocket长连接,心跳,以及TCP拆包粘包,消息编解码
2.logic
设备信息,好友信息,群组信息管理,消息转发逻辑
3.business
一个简单的业务服务器服务,可以根据自己的业务需求,进行扩展,但是前提是,你的业务服务器实现了user.int.proto接口

客户端接入流程

1.调用LogicExt.RegisterDevice接口,完成设备注册,获取设备ID(device_id),注意,一个设备只需完成一次注册即可,后续如果本地有device_id,就不需要注册了,举个例子,如果是APP第一次安装,就需要调用这个接口,后面即便是换账号登录,也不需要重新注册。
2.调用UserExt.SignIn接口,完成账户登录,获取账户登录的token。
3.建立长连接,使用步骤2拿到的token,完成长连接登录。
如果是web端,需要调用建立WebSocket时,如果是APP端,就需要建立TCP长连接。
在完成建立TCP长连接时,第一个包应该是长连接登录包(SignInInput),如果信息无误,客户端就会成功建立长连接。
4.使用长连接发送消息同步包(SyncInput),完成离线消息同步,注意:seq字段是客户端接收到消息的最大同步序列号,如果用户是换设备登录或者第一次登录,seq应该传0。
接下来,用户可以使用LogicExt.SendMessage接口来发送消息,消息接收方可以使用长连接接收到对应的消息。

网络模型

TCP的网络层使用linux的epoll实现,相比golang原生,能减少goroutine使用,从而节省系统资源占用

单用户多设备支持,离线消息同步

每个用户都会维护一个自增的序列号,当用户A给用户B发送消息是,首先会获取A的最大序列号,设置为这条消息的seq,持久化到用户A的消息列表, 再通过长连接下发到用户A账号登录的所有设备,再获取用户B的最大序列号,设置为这条消息的seq,持久化到用户B的消息列表,再通过长连接下发 到用户B账号登录的所有设备。
假如用户的某个设备不在线,在设备长连接登录时,用本地收到消息的最大序列号,到服务器做消息同步,这样就可以保证离线消息不丢失。

读扩散和写扩散

首先解释一下,什么是读扩散,什么是写扩散

读扩散

简介:群组成员发送消息时,先建立一个会话,都将这个消息写入这个会话中,同步离线消息时,需要同步这个会话的未同步消息
优点:每个消息只需要写入数据库一次就行,减少数据库访问次数,节省数据库空间
缺点:一个用户有n个群组,客户端每次同步消息时,要上传n个序列号,服务器要对这n个群组分别做消息同步

写扩散

简介:在群组中,每个用户维持一个自己的消息列表,当群组中有人发送消息时,给群组的每个用户的消息列表插入一条消息即可
优点:每个用户只需要维护一个序列号和消息列表
缺点:一个群组有多少人,就要插入多少条消息,当群组成员很多时,DB的压力会增大

消息转发逻辑选型以及特点

群组:

采用写扩散,群组成员信息持久化到数据库保存。支持消息离线同步。

房间:

采用读扩散,会将消息短暂的保存到Redis,长连接登录消息同步不会同步离线消息。

核心流程时序图

长连接登录

eaf3a08af9c64bbd.png

离线消息同步

ef9c9452e65be3ced63573164fec7ed5.png

心跳

6ea6acf2cd4b956e.png

消息单发

c1.d1和c1.d2分别表示c1用户的两个设备d1和d2,c2.d3和c2.d4同理 e000fda2f18e86f3.png

群组消息群发

c1,c2.c3表示一个群组中的三个用户 749fc468746055a8ecf3fba913b66885.png

APP

基于Flutter写了一个简单的客户端
GitHub地址:https://github.com/alberliu/fim
APP下载:https://github.com/alberliu/fim/releases/download/v1.0.1/FIM.apk
APP截图:
8a3937b2c4a53b568fea418ff6f0ee4a.md.png dd47b5027e4983a068ca91b2ef1b8b1c.md.png 8be32a9ab20de799a2e2d53d5c23eddb.md.png 2fa211eb51022831c21da470a2d87330.md.png 8d3b9dfa3b022c727c640e8938b34105.md.png 63c839904f676c69892ef54946094684.md.png

联系方式

my.png

赞赏支持

如果觉得项目对你有帮助,请支持一下
WechatIMG9.md.jpg

github

https://github.com/alberliu/gim

Owner
Alber
My code is mostly simple
Alber
Comments
  • 关于test/test_conn中登录用户后,不能实时接收消息的问题

    关于test/test_conn中登录用户后,不能实时接收消息的问题

    您好,目前我按照文档用logic_ext_test.go里的TestLogicExtServer_SendMessage函数给模拟的user发消息,同时登录了test/test_conn的用户,发现登录的user只能读取到之前的所有消息,心跳响应和receive函数一直在运行着,却读不到最新的消息。请问这是怎么回事呢?期待您的解答~

  • 今天更新后,又收不到实时消息了

    今天更新后,又收不到实时消息了

    今天更新了后,又收不到实时消息了。。只能收离线消息了。。

    2020-12-07 20:26:13.868	ERROR	service/message.go:338	rpc error: code = Canceled desc = context canceled {context canceled 23 0  {1 1 1 huawei huawei P30 1.0.0 1.0.0 1 127.0.0.1:50200 0 localhost:8081 2020-11-25 03:10:22 +0000 UTC 2020-12-07 20:21:40 +0000 UTC}}
    2020-12-07 20:26:38.803	DEBUG	service/message.go:262	SendToUser{"request_id": 1607343998756493000, "to_user_id": 1}
    2020-12-07 20:26:38.818	DEBUG	service/message.go:262	SendToUser{"request_id": 1607343998756493000, "to_user_id": 2}
    2020-12-07 20:26:38.827	DEBUG	api/interceptor.go:37	logic_ext_interceptor	{"info": {"Server":{},"FullMethod":"/pb.LogicExt/SendMessage"}, "ctx": "context.Background.WithCancel.WithValue(type peer.peerKey, val <not Stringer>).WithValue(type metadata.mdIncomingKey, val <not Stringer>).WithValue(type grpc.streamKey, val <not Stringer>)", "req": "receiver_type:RT_USER receiver_id:2 message_type:MT_TEXT message_content:\"\\n\\037\\344\\275\\240\\350\\203\\275\\346\\224\\266\\345\\210\\260\\345\\220\\227\\357\\274\\214\\346\\210\\221\\346\\230\\2572\\345\\217\\267\\345\\221\\200\" is_persist:true ", "resp": "seq:20 "}
    
  • Mac上logic这个module运行不起来了

    Mac上logic这个module运行不起来了

    gim/cmd/logic这个module 之前的版本(20201130),是可以运行起来的 更新后,运行失败了

    ➜  logic git:(master_test) ✗ go run main.go
    # github.com/alberliu/gn
    ../../../../pkg/mod/github.com/alberliu/[email protected]/server.go:137:18: undefined: epoll
    

    tcp_conn这个module只能在Linux上运行,logic这个module应该可以在mac上跑吧

  • 请问为什么需要发送两份消息呢?谢谢。

    请问为什么需要发送两份消息呢?谢谢。

    // SendToFriend 消息发送至好友
    func (*friendService) SendToFriend(ctx context.Context, sender *pb.Sender, req *pb.SendMessageReq) (int64, error) {
    	// 发给发送者
    	seq, err := proxy.MessageProxy.SendToUser(ctx, sender, sender.SenderId, req)
    	if err != nil {
    		return 0, err
    	}
    
    	// 发给接收者
    	_, err = proxy.MessageProxy.SendToUser(ctx, sender, req.ReceiverId, req)
    	if err != nil {
    		return 0, err
    	}
    
    	return seq, nil
    }
    

    发送消息给好友时,为什么给接收者发送了一份,还要给发送者(就是自己)发送一份消息呢? 我理解的是,你使用的是写扩散的方式,每个用户都拥有与自己有关的收发的所有消息记录,聊天记录就很完整,那这样存储起来是不是很冗余?谢谢。

  • tcp_conn测试脚本报not found in conns错误

    tcp_conn测试脚本报not found in conns错误

    test/tcp_conn目录下执行测试脚本 go run main.go,在调用SignIn函数后,会偶发报错:

    2020-09-27 17:26:26.598	INFO	[email protected]/server.go:81	ge server init,listener port:8381
    2020-09-27 17:26:26.598	INFO	[email protected]/server.go:109	ge server run
    2020-09-27 17:26:26.599	INFO	[email protected]/server.go:142	consumer run by 1000 goroutine
    2020-09-27 17:26:26.599	INFO	[email protected]/server.go:204	check timeout goroutine run
    2020-09-27 17:26:43.574	ERROR	[email protected]/server.go:169	not found in conns,11
    2020-09-27 17:26:43.573	DEBUG	tcp_conn/handler.go:24	connect:	{"fd": 11, "addr": "127.0.0.1:51369"}
    

    在conns.Store和conns.Load,貌似会有读写顺序问题。 https://github.com/alberliu/gn/blob/master/server.go#L169 https://github.com/alberliu/gn/blob/master/server.go#L175

  •  之前关注的时候记得sendmessage 是在 connect层可以做的,现在是没有了吗?

    之前关注的时候记得sendmessage 是在 connect层可以做的,现在是没有了吗?

    我不是很懂im 所以有几个地方不是很懂,可以的话,麻烦大概解答一下,或者分享一些文档,十分感谢。 我看的是没有grpc的情况(没学过grpc,所以先看没有grpc的版本了解逻辑), 现在看起来是 connect 暴露tcp端口50000,然后logic暴露8000端口主要是做用户注册创建组群等curd数据管理,然后http 还有一个sendmessage的接口,那么看起来 消息是由 service 这个模块来处理的 比起我之前看的版本 logic 处理http 业务 connect处理tcp长连接 发送消息。现在多了一个app 和service的改了有点蒙圈了, 那么引入 server 和app 是为了让启动 应用也能注册app 来使用im server的吗? 以及我能力有限 暂时只能先看一下 logic 处理 设备组群,connect来完成 消息收发的版本 该退回来那个git 提交。 按照之前的描述 应该是都可以用的吧,但是 service这块能否做一些更多的说明,十分感谢