test/j-im: Migrated repository - j-im - Gitea: Git with a cup of tea

test/j-im

mirror of https://gitee.com/xchao/j-im.git synced 2024-12-02 20:08:23 +08:00

Migrated repository

Go to file

talent-tan 7d152d5362 更新 README.md		2018-04-15 20:08:45 +08:00
jim-client	将tio-im正式更名为jim,同时发布1.0.0版本	2018-04-13 19:17:07 +08:00
jim-common	将tio-im正式更名为jim,同时发布1.0.0版本	2018-04-13 19:17:07 +08:00
jim-parent	将tio-im正式更名为jim,同时发布1.0.0版本	2018-04-13 19:17:07 +08:00
jim-server	添加获取用户消息是否开启持久化校验	2018-04-15 18:14:36 +08:00
jim-server-demo	将tio-im正式更名为jim,同时发布1.0.0版本	2018-04-13 19:17:07 +08:00
.gitignore	更新 .gitignore	2017-08-31 09:05:31 +08:00
LICENSE	修改协议为Apache协议	2018-04-04 11:48:05 +08:00
README.md	更新 README.md	2018-04-15 20:08:45 +08:00

README.md

J-IM简介

J-IM(原名tio-im)是基于t-io写的轻量、高性能、(可能)支持百万在线用户IM，主要目标降低即时通讯门槛，快速打造低成本接入在线IM系统，通过极简洁的消息格式就可以实现多端不同协议间的消息发送如内置(http、websocket、tcp自定义im协议)等，并提供通过http协议的api接口进行消息发送无需关心接收端属于什么协议，一个消息格式搞定一切！

主要特点

    1、高性能(单机可支持上万人同时在线)
    2、轻量、可扩展性极强
    3、支持多种协议(Socket自定义IM协议、Websocket、Http),可分别独立部署。
    4、内置消息持久化，消息可靠性，高性能存储
    5、各种丰富的API接口。
    6、零成本部署，一键启动。

消息格式

1.聊天请求消息结构

{
   "from": "来源ID",
   "to": "目标ID",
   "cmd":"命令码(11)int类型",
   "createTime": "消息创建时间long类型",
   "msgType": "消息类型int类型(0:text、1:image、2:voice、3:vedio、4:music、5:news)",
   "chatType":"聊天类型int类型(0:未知,1:公聊,2:私聊)",
   "group_id":"群组id仅在chatType为(1)时需要,String类型",
   "content": "内容"
}

请求:COMMAND_CHAT_REQ(11) 响应:COMMAND_CHAT_RESP(12)

2.鉴权请求消息结构

{
    "cmd":"命令码(3)int类型",
    "token": "校验码"
}

请求:COMMAND_AUTH_REQ(3) 响应:COMMAND_AUTH_RESP(4)

3.握手请求消息结构

{
    "cmd":"命令码(1)int类型",
    "hbyte":"握手1个字节"
}

说明:请求:COMMAND_HANDSHAKE_REQ(1) 响应:COMMAND_HANDSHAKE_RESP(2)

4.登录请求消息结构

{
    "cmd":"命令码(5)int类型",
    "loginname": "用户名",
    "password": "密码",
    "token": "校验码(此字段可与logingname、password共存,也可只选一种方式)"
}

请求:COMMAND_LOGIN_REQ(5) 响应:COMMAND_LOGIN_RESP(6)

5.心跳请求消息结构

{
    "cmd":"命令码(13)int类型",
    "hbbyte":"心跳1个字节"
}

请求:COMMAND_HEARTBEAT_REQ(13) 响应:无

6.关闭、退出请求消息结构

{
    "cmd":"命令码(14)int类型",
    "userid":"用户id"
}

请求:COMMAND_CLOSE_REQ(14) 响应:无

7.获取用户信息请求消息结构

{
     "cmd":"命令码(17)int类型",
     "userid":"用户id(只在type为0或是无的时候需要)",
     "type":"获取类型(0:指定用户,1:所有在线用户,2:所有用户[在线+离线])"
}

请求:COMMAND_GET_USER_REQ(17) 响应:COMMAND_GET_USER_RESP(18)

8.获取用户消息请求结构

{
     "cmd":"命令码(19)int类型",
     "fromUserId":"消息发送用户id(此字段必须与userId一起使用,获取双方聊天消息),非必填",
     "userId":"当前用户id(必填字段),当只有此字段时,type必须为0，意思是获取当前用户所有离线消息(好友+群组)",
     "groupId":"群组id(此字段必须与userId一起使用,获取当前用户指定群组聊天消息),非必填",
     "beginTime":"消息区间开始时间Date毫秒数double类型,非必填",
     "endTime":"消息区间结束时间Date毫秒数double类型,非必填",
     "offset":"分页偏移量int类型，类似Limit 0,10 中的0,非必填",
     "count":"显示消息数量,类似Limit 0,10 中的10,非必填",
     "type":"消息类型(0:离线消息,1:历史消息)"
}

请求:COMMAND_GET_MESSAGE_REQ(19) 响应:COMMAND_GET_MESSAGE_RESP(20)