说明:这是一个websocket接口,登录或者唤醒的时候需要去请求建立连接或者判断当前是否已连接。目的是将客户端跟服务端建立联系!
1、基本信息
(1)请求方法: websocket
(2)请求地址: ws://{hostname}/suptruck/msg/ + userId
2、请求参数
| 名称 | 数据类型 | 说明 | 是否必填 |
|---|---|---|---|
| userId | Long | userId | 是 |
3、请求示例
ws://192.168.80.227:8612/suptruck/msg/110
4、响应参数
| 名称 | 数据类型 | 说明 |
|---|---|---|
| code | Integer | code |
| msg | String | 提示信息 |
| timestamp | String | 时间戳 |
5、响应示例
{"code": 100,"msg": "操作成功","timestamp": "2023-04-13 11:28:11"}
6、客户端示例代码
var socket = null;var userId = null;//强制关闭浏览器 调用websocket.close(),进行正常关闭window.onunload = function() {disconnect()}function connect(){userId = $("#userIdInput").val();var socketUrl="ws://localhost:8612/msg/" + userId;socket = new WebSocket(socketUrl);//打开事件socket.onopen = function() {console.log("websocket 已打开 userId: " + userId);};//获得消息事件socket.onmessage = function(msg) {var serverMsg = "收到服务端信息: " + msg.data;console.log(serverMsg);};//关闭事件socket.onclose = function() {console.log("websocket 已关闭 userId: " + userId);};//发生了错误事件socket.onerror = function() {console.log("websocket 发生了错误 userId : " + userId);}}
以下为消息接收部分
7、实时消息返回结构
| 名称 | 数据类型 | 说明 | 是否必填 |
|---|---|---|---|
| code | Integer | code | |
| msg | String | 提示信息 | |
| data | Object | JSON 对象 | |
| - type | String | 消息类型 | |
| - receiver | Long | 接收人id | |
| - msgNum | Integer | 未读消息数 |
8、实时消息返回示例
{"code": 100,"data": {"receiver": 1,"type": "SEND_MSG","msgNum": 10},"msg": "操作成功"}
