https://github.com/mxsm/im
IM 基于Netty的即时通讯
https://github.com/mxsm/im
im netty protobuf3
Last synced: 14 days ago
JSON representation
IM 基于Netty的即时通讯
- Host: GitHub
- URL: https://github.com/mxsm/im
- Owner: mxsm
- Created: 2018-09-13T12:59:27.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-20T07:07:07.000Z (about 3 years ago)
- Last Synced: 2025-02-01T21:41:20.287Z (12 months ago)
- Topics: im, netty, protobuf3
- Language: Java
- Homepage: https://blog.ljbmxsm.com
- Size: 473 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 即时通讯-IM
[](https://codecov.io/gh/mxsm/IM)
[](https://coveralls.io/github/mxsm/IM?branch=develop)
[](http://isitmaintained.com/project/mxsm/IM "Average time to resolve an issue")
[](http://isitmaintained.com/project/mxsm/IM "Percentage of issues still open")
### 模块
IM 基于Netty的即时通讯
消息的转发模块叫鹊桥(取自中国航天探月工程的鹊桥中继卫星)
### 线程模型
### 从源码构建
```shell
git clone https://github.com/mxsm/IM.git
cd IM
mvn -Prelease-all -DskipTests clean install -U
cd distribution/target/im-0.1-SNAPSHOT/im-0.1-SNAPSHOT
```
### 鹊桥(MagpieBridge)
在鹊桥的集群中，只有一个Master,多个SLAVE。一个集群名称唯一，集群中的节点的名称可以相同。节点ID集群内必须唯一。
- 节点ID最小的为MASTER，当Master掉线或者失去作用的时候回将节点ID最小的为MASTER。
- 一个集群内节点名称必须相同。不同的节点名称可以不相同
### 工程目录结构说明
- **common** 包含了工程的通用工具类
- **container** 包含了启动容器(当前只有spring容器的实现)
- **core** 处理消息的逻辑
- **distribute** 服务器分发消息(当前只有akka的实现)
- **protocols** IM的消息协议(当前用的protobuf)
- **server** IM通讯协议的服务(现在就实现了TCP)
### 协议文件结构
结构的设计参考了HTTP的方式
```
syntax = "proto3";
package com.github.mxsm.protocol.protobuf;
option java_package = "com.github.mxsm.protocol.protobuf";
option java_outer_classname = "Message";
message MessageProtobuf{
Header header = 1;
message Header{
string protocol = 1; //协议
string version = 2; //协议版本号
string sender = 3; //消息发送者
string receiver = 4; //消息接收者
string messageType = 5; //消息类型
string contentType = 6; //参照http content-type类型
string terminalType = 7; //发送消息的终端
string deviceToken = 8; //发送消息的终端设备号
}
Auth auth = 2;
message Auth{
string token = 1;
}
string messageUnique = 3; //消息唯一值
int64 messageTime = 4; //消息的创建时间
bytes payload = 5;//消息体
}
```
### 编译protobuf.proto文件命令
```
protoc -I=$SRC_DIR --java_out=$DST_DIR $SRC_DIR/addressbook.proto
```
### 消息类型
及时通讯中消息类型大致在这里为两类
#### **1. 功能控制类型**
主要用来控制与服务器之前的消息确认和服务器与客户端的连接关系
```
CONN //用户连接服务消息类型
ACK //服务器收到消息和客户端收到消息的确认消息类型
DISCONN // 断开与服务器的消息类型
```
#### **2. 数据传输类型**
对于聊天来说就只是单聊和群聊
```
SINGLE //单聊
GROUP //群聊
```