@ives_xxz/framework 1.0.3 → 1.0.5

package/FW.d.ts

@@ -79,30 +79,41 @@ declare namespace FW {
     node: cc.Node;
   };
 
-  type Sender = {
+  type SocketSender = {
     readonly entry: FW.Entry;
     initialize?();
     onDestroy?();
+    /** 发送消息 */
     send(msg: any);
+    /** 获取协议Key值 */
+    getProtocolKey?(msg: any): string;
+    /** 消息发送前回调函数*/
+    onBeforeSendingMessage?(msg: any): string;
+    /** 是否是心跳消息 */
+    onHeart?(msg: any): Promise<boolean>;
   };
-  type Handle = {
+  type SocketHandle = {
     readonly entry: FW.Entry;
     initialize?();
     onDestroy?();
     /** 消息处理 */
     onMessage(msg: any);
     /** 超时处理 */
-    onTimeout();
+    onTimeout?();
     /** 错误处理 */
-    onError(msg: any);
+    onError?(msg: any);
     /** 连接打开 */
-    onOpen();
+    onOpen?();
     /** 连接关闭 */
-    onClose();
+    onClose?();
     /** 心跳 */
     onHeart?(msg: any): Promise<boolean>;
     /** 弱网 */
     onWeakNetWork?(): void;
+    /** 获取协议Key值 */
+    getProtocolKey?(msg: any): string;
+    /** 消息收到前回调函数 */
+    onBeforeReceivingMessage?(msg: any): Promise<object>;
   };
 
   type ObjectManager = {
@@ -157,19 +168,14 @@ declare namespace FW {
     put(uniqueId: number);
     onDestroy();
   };
+
   type SocketManager = {
     createSocket(
       tag: string,
       address: string,
       sender: SocketSender,
       handle: SocketHandle,
-      config: {
-        heartTimeout?: number;
-        heartWeakTime?: number;
-        heartInternal?: number;
-        maxReconnectTimes?: number;
-        reconnectInternal?: number;
-      },
+      config: SocketConfig,
     ): Promise<Socket>;
     /**
      * 获取socket
@@ -251,17 +257,21 @@ declare namespace FW {
     createSocket(
       address: string,
       tag: string,
-      sender: FWSocketSender,
-      handle: FWSocketHandle,
-      config: {
-        heartInternal: number;
-        heartTimeout: number;
-        heartWeakTime: number;
-        maxReconnectTimes: number;
-      },
+      sender: SocketSender,
+      handle: SocketHandle,
+      config: SocketConfig,
     ): SocketPromiseProxy;
   };
 
+  type SocketConfig = {
+    heartInternal: number;
+    heartTimeout: number;
+    heartWeakTime: number;
+    maxReconnectTimes: number;
+    reconnectInternal: number;
+    protocolSymbol: Symbol;
+  };
+
   /**
    * 观察者
    */
@@ -303,6 +313,8 @@ declare namespace FW {
 
   type TargetType = cc.Component | Record<string, any> | cc.Node;
 
+  type Symbol = string | number;
+
   type UiManager = {
     registerButtonEvent(args: FW.RegisterEventArgs | FW.RegisterEventArgs[]);
     pauseEvent<T extends TargetType>(target: T);
@@ -1378,11 +1390,11 @@ declare namespace FW {
     /**
      * socket发送者
      */
-    sender?: Newable<Sender>;
+    sender?: Newable<SocketSender>;
     /**
      * socket处理者
      */
-    handle?: Newable<Handle>;
+    handle?: Newable<SocketHandle>;
   };
 
   /**

package/config/FWSystemConfig.ts

@@ -0,0 +1,10 @@
+export namespace FWSystemConfig {
+  export const SocketDefaultConfig = {
+    heartInternal: 3000,
+    heartTimeout: 30000,
+    heartWeakTime: 1000,
+    maxReconnectTimes: 10,
+    reconnectInternal: 3000,
+    protocolSymbol: null,
+  };
+}

package/config/FWSystemConfig.ts.meta

@@ -0,0 +1,10 @@
+{
+  "ver": "1.1.0",
+  "uuid": "de945287-2149-4870-b846-761e79868e93",
+  "importer": "typescript",
+  "isPlugin": false,
+  "loadPluginInWeb": true,
+  "loadPluginInNative": true,
+  "loadPluginInEditor": false,
+  "subMetas": {}
+}

package/manager/FWSocketManager.ts

@@ -25,22 +25,17 @@ export default class FWSocketManager extends FWManager implements FW.SocketManag
   async createSocket(
     tag: string,
     address: string,
-    sender: FWSocketSender,
-    handle: FWSocketHandle,
-    config: {
-      heartTimeout: number;
-      heartWeakTime: number;
-      heartInternal: number;
-      maxReconnectTimes: number;
-      reconnectInternal: number;
-    },
+    sender: FW.SocketSender,
+    handle: FW.SocketHandle,
+    config: FW.SocketConfig,
   ) {
     const proxy = new FWSocket().createSocket(address, tag, sender, handle, {
-      heartTimeout: config?.heartTimeout,
-      heartWeakTime: config?.heartWeakTime,
-      heartInternal: config?.heartInternal,
-      maxReconnectTimes: config?.maxReconnectTimes,
-      reconnectInternal: config?.reconnectInternal,
+      heartTimeout: config.heartTimeout,
+      heartWeakTime: config.heartWeakTime,
+      heartInternal: config.heartInternal,
+      maxReconnectTimes: config.maxReconnectTimes,
+      reconnectInternal: config.reconnectInternal,
+      protocolSymbol: config.protocolSymbol,
     });
     this.socketMap.set(tag, proxy.socket);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ives_xxz/framework",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "cocoscreator 2.x mvc framework",
   "main": "index.js",
   "keywords": [

package/service/socket/FWSocket.ts

@@ -1,7 +1,7 @@
-import Framework from '../../Framework';
-import FWLog from '../../log/FWLog';
-import FWSocketHandle from './FWSocketHandle';
-import FWSocketSender from './FWSocketSender';
+import { FWSystemConfig } from "../../config/FWSystemConfig";
+import FWLog from "../../log/FWLog";
+import FWSocketHandle from "./FWSocketHandle";
+import FWSocketSender from "./FWSocketSender";
 
 /**
  * TODO 犹豫socket没有改版暂时已老的cmd字符串映射方式做,后期优化
@@ -37,8 +37,15 @@ export default class FWSocket implements FW.Socket {
   protected isPausedMessageHandle: boolean = false;
   /** 是否正在重连 */
   private isReconnect: boolean = false;
-
+  /** 代理 */
   private promiseProxy: FW.SocketPromiseProxy;
+  /** 协议符号 */
+  private protocolSymbol: FW.Symbol;
+  /** 协议注册表 */
+  private protocolRegistry: Map<string, Set<Symbol>>;
+  /** 协议符号容器 */
+  private protocolContainer: Map<Symbol, string>;
+
   /**
    *  消息事件列表
    * TODO 目前没有消息协议号,暂时无用
@@ -51,24 +58,29 @@ export default class FWSocket implements FW.Socket {
 
   public initialize(): void {
     this.messageEvents = cc.js.createMap();
+    this.protocolContainer = new Map<Symbol, string>();
+    this.protocolRegistry = new Map<string, Set<Symbol>>();
   }
 
   createSocket(
     address: string,
     tag: string,
-    sender: FWSocketSender,
-    handle: FWSocketHandle,
-    config: {
-      heartInternal: number;
-      heartTimeout: number;
-      heartWeakTime: number;
-      maxReconnectTimes: number;
-      reconnectInternal: number;
-    },
+    sender: FW.SocketSender,
+    handle: FW.SocketHandle,
+    config: FW.SocketConfig
   ): FW.SocketPromiseProxy {
     FW.Entry.timeMgr.unSchedule(this);
+
     this.tag = tag;
     this.address = address;
+
+    this.messageEvents = {};
+    this.protocolContainer.clear();
+    this.protocolRegistry.clear();
+    this.isReconnect = true;
+    this.sendHeartTimestamp = 0;
+    this.receiveTimeStamp = new Date().getTime();
+
     this.socket = new WebSocket(address);
     this.socket.onopen = this.onSocketOpen.bind(this);
     this.socket.onclose = this.onSocketClose.bind(this);
@@ -78,15 +90,22 @@ export default class FWSocket implements FW.Socket {
     this.sender = sender;
     this.handle = handle;
 
-    this.heartInternal = config?.heartInternal;
-    this.heartTimeout = config?.heartTimeout;
-    this.heartWeakTime = config?.heartWeakTime;
-    this.maxReconnectTimes = config?.maxReconnectTimes;
+    const defaultConfig = FWSystemConfig.SocketDefaultConfig;
+    this.heartInternal = config?.heartInternal || defaultConfig.heartInternal;
+    this.heartTimeout = config?.heartTimeout || defaultConfig.heartTimeout;
+    this.heartWeakTime = config?.heartWeakTime || defaultConfig.heartWeakTime;
+    this.maxReconnectTimes =
+      config?.maxReconnectTimes || defaultConfig.maxReconnectTimes;
+    this.reconnectInternal =
+      config?.reconnectInternal || defaultConfig.reconnectInternal;
+    this.protocolSymbol =
+      config?.protocolSymbol || defaultConfig.protocolSymbol;
 
     this.promiseProxy = {
       promise: undefined,
       socket: this,
     };
+
     new Promise<FWSocket>((resolve) => {
       this.promiseProxy.promise = resolve;
     });
@@ -146,16 +165,13 @@ export default class FWSocket implements FW.Socket {
     }
 
     FWLog.debug(
-      `socket reconnect : reconnectTimes->${this.reconnectTimes},maxReconnectTimes->${this.maxReconnectTimes}`,
+      `socket reconnect : reconnectTimes->${this.reconnectTimes},maxReconnectTimes->${this.maxReconnectTimes}`
     );
     if (++this.reconnectTimes >= this.maxReconnectTimes) {
       this.handle?.onTimeout?.();
       return;
     }
-    FW.Entry.timeMgr.unSchedule(this);
-    this.isReconnect = true;
-    this.sendHeartTimestamp = 0;
-    this.receiveTimeStamp = 0;
+
     this.socket.close();
     this.socket = null;
 
@@ -165,16 +181,33 @@ export default class FWSocket implements FW.Socket {
       heartWeakTime: this.heartWeakTime,
       maxReconnectTimes: this.maxReconnectTimes,
       reconnectInternal: this.reconnectInternal,
+      protocolSymbol: this.protocolSymbol,
     });
   }
 
+  async send(msg: any) {
+    if (this.getReadyState() != WebSocket.OPEN) return;
+    if (this.isPausedMessageHandle) return;
+    if (!(await this.sender.onHeart?.(msg))) {
+      const protocolKey = this.sender.getProtocolKey?.(msg);
+      if (protocolKey) {
+        const symbol = Symbol(protocolKey);
+        const registry =
+          this.protocolRegistry.get(protocolKey) || new Set<Symbol>();
+        this.protocolRegistry.set(protocolKey, registry.add(symbol));
+        this.protocolContainer.set(symbol, msg);
+      }
+    }
+    this.sendMessage(msg);
+  }
+
   /** 连接打开 */
   private onSocketOpen() {
-    FWLog.debug('on open!');
+    FWLog.debug("on open!");
     FW.Entry.timeMgr.unSchedule(this);
     this.reconnectTimes = 0;
     this.sendHeartTimestamp = 0;
-    this.receiveTimeStamp = 0;
+    this.receiveTimeStamp = new Date().getTime();
     this.isReconnect = false;
     this.handle?.onOpen?.();
     this.heartHandle();
@@ -193,10 +226,16 @@ export default class FWSocket implements FW.Socket {
           }
         }
         this.sendHeart();
+
+        if (this.protocolContainer.size > 0) {
+          this.protocolContainer?.forEach((msg) => {
+            this.sendMessage(msg);
+          });
+        }
       },
       this.heartInternal / 1000,
       cc.macro.REPEAT_FOREVER,
-      this,
+      this
     );
   }
 
@@ -205,10 +244,12 @@ export default class FWSocket implements FW.Socket {
     this.sender?.sendHeart?.();
   }
 
-  send(msg: any) {
-    if (this.getReadyState() != WebSocket.OPEN) return;
-    if (this.isPausedMessageHandle) return;
-    this.socket?.send(msg);
+  private sendMessage(msg: any) {
+    try {
+      this.socket?.send(this.sender.onBeforeSendingMessage?.(msg) || msg);
+    } catch (e) {
+      this.socket?.send(msg);
+    }
   }
 
   /** socket关闭 */
@@ -217,24 +258,50 @@ export default class FWSocket implements FW.Socket {
     FW.Entry.timeMgr.scheduleOnce(
       () => {
         if (!this.isReconnect) return;
-        FWLog.debug('on close!');
+        FWLog.debug("on close!");
         this.reconnect();
       },
-      3,
-      this,
+      this.reconnectInternal,
+      this
     );
   }
   /** 消息处理 */
-  private async onSocketMessage(msg: any) {
+  private async onSocketMessage(originalMsg: any) {
+    const msg = await this.handle.onBeforeReceivingMessage(originalMsg);
+
     if (await this.handle?.onHeart?.(msg)) {
       this.receiveTimeStamp = new Date().getTime();
-    } else {
-      if (this.isPausedMessageHandle) return;
-      this.handle?.onMessage?.(msg);
+      return;
     }
+
+    this.remoteProtocol(msg);
+
+    if (this.isPausedMessageHandle) return;
+
+    this.handle?.onMessage?.(msg);
   }
   /** 错误处理 */
-  private onSocketError(msg: any) {
+  private async onSocketError(msg: any) {
+    await this.remoteProtocol(msg);
     this.handle?.onError?.(msg);
   }
+
+  private async remoteProtocol(msg: any) {
+    const protocolKey = await this.handle.getProtocolKey?.(msg);
+    if (protocolKey && this.protocolRegistry.has(protocolKey)) {
+      const symbolSet = this.protocolRegistry.get(protocolKey);
+
+      if (symbolSet && symbolSet.size > 0) {
+        const [symbol] = symbolSet;
+
+        symbolSet.delete(symbol);
+
+        this.protocolContainer.delete(symbol);
+
+        if (symbolSet.size === 0) {
+          this.protocolRegistry.delete(protocolKey);
+        }
+      }
+    }
+  }
 }

package/service/socket/FWSocketHandle.ts

@@ -1,17 +1,19 @@
 import { injectable } from 'inversify';
 @injectable()
-export default abstract class FWSocketHandle implements FW.Handle {
+export default abstract class FWSocketHandle implements FW.SocketHandle {
   constructor() {
     this.initialize?.();
   }
   public readonly entry: FW.Entry = FW.Entry;
+  abstract onMessage(msg: any): void;
   initialize?();
   onDestroy?();
   onHeart?(msg: any): Promise<boolean>;
   onWeakNetWork?(): void;
-  abstract onClose(): void;
-  abstract onOpen(): void;
-  abstract onMessage(msg: any): void;
-  abstract onError(msg: any): void;
-  abstract onTimeout(): void;
+  onClose?(): void;
+  onOpen?(): void;
+  onError?(msg: any): void;
+  onTimeout?(): void;
+  getProtocolKey?(msg: any): string;
+  onBeforeReceivingMessage?(msg: any): Promise<object>;
 }

package/service/socket/FWSocketSender.ts

@@ -1,7 +1,7 @@
 import { injectable } from 'inversify';
 import FWLog from '../../log/FWLog';
 @injectable()
-export default class FWSocketSender implements FW.Sender {
+export default class FWSocketSender implements FW.SocketSender {
   constructor() {
     this.initialize?.();
   }
@@ -13,4 +13,7 @@ export default class FWSocketSender implements FW.Sender {
   send(msg: any) {
     FW.Entry.socketMgr.getSocket()?.send(msg);
   }
+  onHeart?(msg: any): Promise<boolean>;
+  onBeforeSendingMessage?(msg: any): string;
+  getProtocolKey?(msg: any): string;
 }