useWebSocket.ts 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. // noinspection JSUnusedGlobalSymbols
  2. import { computed, reactive, ref, unref } from 'vue';
  3. import { useWebSocket as $useWebSocket, WebSocketResult } from '@vueuse/core';
  4. import { getToken } from '/@/utils/auth';
  5. const state = reactive({
  6. server: '',
  7. sendValue: '',
  8. recordList: [] as { id: number; time: number; res: string }[],
  9. });
  10. const result = ref<WebSocketResult<any>>();
  11. const listeners = new Map();
  12. /**
  13. * 开启 WebSocket 链接,全局只需执行一次
  14. * @param url
  15. */
  16. export function connectWebSocket(url: string) {
  17. if (!unref(getIsOpen)) {
  18. state.server = url;
  19. //update-begin-author:taoyan date:2022-4-24 for: v2.4.6 的 websocket 服务端,存在性能和安全问题。 #3278
  20. let token = (getToken() || '') as string;
  21. result.value = $useWebSocket(state.server, {
  22. // 自动重连
  23. autoReconnect: true,
  24. // 心跳检测
  25. heartbeat: false,
  26. protocols: [token],
  27. });
  28. //update-end-author:taoyan date:2022-4-24 for: v2.4.6 的 websocket 服务端,存在性能和安全问题。 #3278
  29. result.value.open();
  30. const ws = unref(result.value.ws);
  31. if (ws) {
  32. ws.onopen = onOpen;
  33. ws.onclose = onClose;
  34. ws.onerror = onError;
  35. ws.onmessage = onMessage;
  36. }
  37. }
  38. }
  39. function onOpen() {
  40. console.log('[WebSocket] 连接成功');
  41. }
  42. function onClose(e) {
  43. console.log('[WebSocket] 连接断开:', e);
  44. }
  45. function onError(e) {
  46. console.log('[WebSocket] 连接发生错误: ', e);
  47. }
  48. function onMessage(e) {
  49. if (e.data === 'ping') {
  50. return;
  51. }
  52. console.debug('[WebSocket] -----接收消息-------', e.data);
  53. try {
  54. const data = JSON.parse(e.data);
  55. for (const callback of listeners.keys()) {
  56. try {
  57. callback(data);
  58. } catch (err) {
  59. console.error(err);
  60. }
  61. }
  62. } catch (err) {
  63. console.error('[WebSocket] data解析失败:', err);
  64. }
  65. }
  66. /**
  67. * 判断 WebSocket 是否是开启状态
  68. */
  69. export const getIsOpen = computed(() => result.value?.status.value === 'OPEN');
  70. /**
  71. * 添加 WebSocket 消息监听
  72. * @param callback
  73. */
  74. export function onWebSocket(callback: (data: object) => any) {
  75. if (!listeners.has(callback)) {
  76. if (typeof callback === 'function') {
  77. listeners.set(callback, null);
  78. } else {
  79. console.debug('[WebSocket] 添加 WebSocket 消息监听失败:传入的参数不是一个方法');
  80. }
  81. }
  82. }
  83. /**
  84. * 解除 WebSocket 消息监听
  85. *
  86. * @param callback
  87. */
  88. export function offWebSocket(callback: (data: object) => any) {
  89. listeners.delete(callback);
  90. }
  91. export function useWebSocket() {
  92. return unref(result);
  93. }