说明这是一个websocket接口,登录或者唤醒的时候需要去请求建立连接或者判断当前是否已连接。目的是将客户端跟服务端建立联系!

1、基本信息

  (1)请求方法: websocket

  (2)请求地址: ws://{hostname}/suptruck/msg/ + userId


2、请求参数

名称 数据类型 说明 是否必填
userId Long userId


3、请求示例

  1. ws://192.168.80.227:8612/suptruck/msg/110


4、响应参数

名称 数据类型 说明
code Integer code
msg String 提示信息
timestamp String 时间戳


5、响应示例

  1. {
  2. "code": 100,
  3. "msg": "操作成功",
  4. "timestamp": "2023-04-13 11:28:11"
  5. }


6、客户端示例代码

  1. var socket = null;
  2. var userId = null;
  3. //强制关闭浏览器 调用websocket.close(),进行正常关闭
  4. window.onunload = function() {
  5. disconnect()
  6. }
  7. function connect(){
  8. userId = $("#userIdInput").val();
  9. var socketUrl="ws://localhost:8612/msg/" + userId;
  10. socket = new WebSocket(socketUrl);
  11. //打开事件
  12. socket.onopen = function() {
  13. console.log("websocket 已打开 userId: " + userId);
  14. };
  15. //获得消息事件
  16. socket.onmessage = function(msg) {
  17. var serverMsg = "收到服务端信息: " + msg.data;
  18. console.log(serverMsg);
  19. };
  20. //关闭事件
  21. socket.onclose = function() {
  22. console.log("websocket 已关闭 userId: " + userId);
  23. };
  24. //发生了错误事件
  25. socket.onerror = function() {
  26. console.log("websocket 发生了错误 userId : " + userId);
  27. }
  28. }



以下为消息接收部分

7、实时消息返回结构

名称 数据类型 说明 是否必填
code Integer code
msg String 提示信息
data Object JSON 对象
- type String 消息类型
- receiver Long 接收人id
- msgNum Integer 未读消息数


8、实时消息返回示例

  1. {
  2. "code": 100,
  3. "data": {
  4. "receiver": 1,
  5. "type": "SEND_MSG",
  6. "msgNum": 10
  7. },
  8. "msg": "操作成功"
  9. }