@kkarum/framework 2.3.17

package/manager/FWEventManager.ts

@@ -0,0 +1,361 @@
+/**
+ * 观察者
+ */
+class FWObserver implements FW.Observer {
+  private pause: boolean;
+  /**
+   * 构造函数
+   * @param eventName 事件名字
+   * @param cb 回调函数
+   * @param target 观察目标
+   */
+  constructor(
+    private readonly eventName: string | number,
+    private readonly cb: () => void,
+    private readonly target: FW.TargetType,
+    public readonly priority: number,
+    public readonly intercept: boolean,
+    public readonly once: boolean = false,
+  ) {
+    this.cb = cb;
+    this.target = target;
+    this.pause = false;
+  }
+
+  /**
+   * 消息通知
+   * @param args
+   */
+  public notify(
+    args1?: FW.EventManagerArgs,
+    args2?: FW.EventManagerArgs,
+    args3?: FW.EventManagerArgs,
+    args4?: FW.EventManagerArgs,
+    args5?: FW.EventManagerArgs,
+    args6?: FW.EventManagerArgs,
+    args7?: FW.EventManagerArgs,
+    args8?: FW.EventManagerArgs,
+    args9?: FW.EventManagerArgs,
+    args10?: FW.EventManagerArgs,
+  ) {
+    if (this.pause) return;
+    this.cb?.call(
+      this.target,
+      args1,
+      args2,
+      args3,
+      args4,
+      args5,
+      args6,
+      args7,
+      args8,
+      args9,
+      args10,
+    );
+  }
+
+  /**
+   * 目标比较
+   * @param target 目标对象
+   * @returns
+   */
+  public compar(target: FW.TargetType) {
+    return (
+      this.target === target || (this.target.uuid && target.uuid && this.target.uuid == target.uuid)
+    );
+  }
+
+  /**
+   * 获取当前绑定事件名字
+   * @returns
+   */
+  public getEventName() {
+    return this.eventName;
+  }
+
+  /** 暂停观察 */
+  public pauseObserver() {
+    this.pause = true;
+  }
+  /** 恢复观察 */
+  public resumeObserver() {
+    this.pause = false;
+  }
+}
+
+/**
+ * 事件管理器
+ */
+export default class FWEventManager implements FW.EventManager {
+  private listeners: { [key: string]: FW.Observer[] } = cc.js.createMap();
+
+  public initialize(): void {
+    this.listeners = cc.js.createMap();
+  }
+
+  /**
+   * 事件派发
+   * @param eventName 事件名
+   * @param args 参数列表
+   * @returns
+   */
+  public dispatch(
+    eventName: string | number,
+    args1?: FW.EventManagerArgs,
+    args2?: FW.EventManagerArgs,
+    args3?: FW.EventManagerArgs,
+    args4?: FW.EventManagerArgs,
+    args5?: FW.EventManagerArgs,
+    args6?: FW.EventManagerArgs,
+    args7?: FW.EventManagerArgs,
+    args8?: FW.EventManagerArgs,
+    args9?: FW.EventManagerArgs,
+    args10?: FW.EventManagerArgs,
+  ) {
+    const observers = this.listeners[eventName];
+    if (!observers) return;
+
+    let shouldStopPropagation = false;
+    const observersToRemove: FW.Observer[] = [];
+
+    const observersCopy = [...observers];
+
+    for (const observer of observersCopy) {
+      if (shouldStopPropagation) break;
+
+      if (observers.indexOf(observer) === -1) continue;
+
+      observer.notify(args1, args2, args3, args4, args5, args6, args7, args8, args9, args10);
+
+      if (observer.once) {
+        observersToRemove.push(observer);
+      }
+
+      if (observer.intercept) {
+        shouldStopPropagation = true;
+      }
+    }
+
+    if (observersToRemove.length > 0) {
+      this.removeObservers(eventName, observersToRemove);
+    }
+  }
+
+  /**
+   * 事件注册
+   * @param eventName 事件名
+   * @param cb 回调函数
+   * @param target 事件回调绑定目标
+   */
+  public register(
+    eventName: string | number,
+    cb: (
+      args1?: FW.EventManagerArgs,
+      args2?: FW.EventManagerArgs,
+      args3?: FW.EventManagerArgs,
+      args4?: FW.EventManagerArgs,
+      args5?: FW.EventManagerArgs,
+      args6?: FW.EventManagerArgs,
+      args7?: FW.EventManagerArgs,
+      args8?: FW.EventManagerArgs,
+      args9?: FW.EventManagerArgs,
+      args10?: FW.EventManagerArgs,
+    ) => void,
+    target: FW.TargetType,
+    options?: {
+      priority?: number;
+      intercept?: boolean;
+      once?: boolean;
+    },
+  ) {
+    const observers = this.listeners[eventName];
+    const define = FW.SystemDefine.FWPriorityOrder;
+    const priority = options?.priority === undefined ? define.NORMAL : options.priority;
+    const intercept = options?.intercept === undefined ? false : options.intercept;
+    const once = options?.once === undefined ? false : options.once;
+
+    const observer = new FWObserver(eventName, cb, target, priority, intercept, once);
+
+    if (!observers) {
+      this.listeners[eventName] = [];
+    }
+
+    const order = Object.values(define);
+    const insertIndex = this.listeners[eventName].findIndex(
+      (o) => order[o.priority] > order[priority],
+    );
+
+    if (insertIndex === -1) {
+      this.listeners[eventName].push(observer);
+    } else {
+      this.listeners[eventName].splice(insertIndex, 0, observer);
+    }
+  }
+
+  /**
+   * 注册一次性事件
+   * @param eventName 事件名
+   * @param cb 回调函数
+   * @param target 事件回调绑定目标
+   * @param options 选项
+   */
+  public registerOnce(
+    eventName: string | number,
+    cb: (
+      args1?: FW.EventManagerArgs,
+      args2?: FW.EventManagerArgs,
+      args3?: FW.EventManagerArgs,
+      args4?: FW.EventManagerArgs,
+      args5?: FW.EventManagerArgs,
+      args6?: FW.EventManagerArgs,
+      args7?: FW.EventManagerArgs,
+      args8?: FW.EventManagerArgs,
+      args9?: FW.EventManagerArgs,
+      args10?: FW.EventManagerArgs,
+    ) => void,
+    target: FW.TargetType,
+    options?: {
+      priority?: number;
+      intercept?: boolean;
+    },
+  ) {
+    this.register(eventName, cb, target, {
+      ...options,
+      once: true,
+    });
+  }
+
+  /**
+   * 注销事件
+   * @param eventName
+   * @param target
+   * @returns
+   */
+  public unRegister(eventName: string, target: Comment | Object) {
+    const observers = this.listeners[eventName];
+    if (!observers) return;
+    for (const observer of observers) {
+      if (observer.getEventName() === eventName && observer.compar(target)) {
+        observers.splice(observers.indexOf(observer), 1);
+        if (observers.length == 0) {
+          delete this.listeners[eventName];
+        }
+      }
+    }
+  }
+
+  /**
+   * 目标对象是否注册了指定事件
+   * @param eventName
+   * @param target
+   * @returns
+   */
+  has(eventName: string | number, target: Comment | Object): boolean {
+    const observers = this.listeners[eventName];
+    if (!observers) return false;
+    for (const observer of observers) {
+      if (observer.getEventName() === eventName && observer.compar(target)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  /** 关闭事件 */
+  public eventOff(eventName: string | number) {
+    const observers = this.listeners[eventName];
+    if (!observers) return;
+    for (const observer of observers) {
+      if (observer.getEventName() === eventName) {
+        observers.splice(observers.indexOf(observer), 1);
+        if (observers.length == 0) {
+          delete this.listeners[eventName];
+        }
+      }
+    }
+  }
+
+  /**
+   * 注销对象身上所有事件
+   * @param target
+   */
+  public targetOff(target: FW.TargetType) {
+    Object.keys(this.listeners).forEach((eventName) => {
+      const observers = this.listeners[eventName];
+      for (const observer of observers) {
+        if (observer.compar(target)) {
+          observers.splice(observers.indexOf(observer), 1);
+          if (observers.length == 0) {
+            delete this.listeners[eventName];
+          }
+        }
+      }
+    });
+  }
+
+  /**
+   * 暂停所有已注册事件
+   * @param target
+   */
+  public targetPause(target: Comment | Object | Node) {
+    Object.keys(this.listeners).forEach((eventName) => {
+      const observers = this.listeners[eventName];
+      for (const observer of observers) {
+        if (observer.compar(target)) {
+          observer.pauseObserver();
+        }
+      }
+    });
+  }
+
+  /**
+   * 恢复所有已注册事件
+   * @param target
+   */
+  public targetResume(target: Comment | Object | Node) {
+    Object.keys(this.listeners).forEach((eventName) => {
+      const observers = this.listeners[eventName];
+      for (const observer of observers) {
+        if (observer.compar(target)) {
+          observer.resumeObserver();
+        }
+      }
+    });
+  }
+
+  /**
+   * 移除指定的观察者列表
+   * @param eventName 事件名
+   * @param observersToRemove 待移除的观察者列表
+   */
+  private removeObservers(eventName: string | number, observersToRemove: FW.Observer[]): void {
+    const observers = this.listeners[eventName];
+    if (!observers) return;
+
+    for (const observerToRemove of observersToRemove) {
+      const index = observers.indexOf(observerToRemove);
+      if (index !== -1) {
+        observers.splice(index, 1);
+      }
+    }
+
+    if (observers.length === 0) {
+      delete this.listeners[eventName];
+    }
+  }
+
+  /**
+   * 获取事件监听器数量
+   * @param eventName 事件名
+   * @returns 监听器数量
+   */
+  public getListenerCount(eventName: string | number): number {
+    const observers = this.listeners[eventName];
+    return observers ? observers.length : 0;
+  }
+
+  /** 销毁 */
+  public onDestroy(): void {
+    this.listeners = cc.js.createMap();
+  }
+}

package/manager/FWEventManager.ts.meta

@@ -0,0 +1,10 @@
+{
+  "ver": "1.1.0",
+  "uuid": "38cc4633-8a5d-4f6f-ab3e-33a8202c65ad",
+  "importer": "typescript",
+  "isPlugin": false,
+  "loadPluginInWeb": true,
+  "loadPluginInNative": true,
+  "loadPluginInEditor": false,
+  "subMetas": {}
+}

package/manager/FWHotUpdateManager.ts

@@ -0,0 +1,344 @@
+import { FWManager } from "./FWManager";
+
+const TEMOTE_ASSET = "remote-asset";
+
+export default class FWHotUpdateManager
+  extends FWManager
+  implements FW.HotUpdateManager
+{
+  private listener: FW.HotUpdateListener;
+  private assetMgr: any;
+  private storePath: string;
+  private isUpdate: boolean;
+  private localManifest: cc.Asset;
+  private isRetry: boolean;
+  private currentVersion: string;
+  private newVersion: string;
+
+  setListener(listener: FW.HotUpdateListener): FW.HotUpdateManager {
+    this.listener = listener;
+    FW.Log.debug("热更新监听设置");
+    return this;
+  }
+
+  public update(localManifest: cc.Asset) {
+    if (!localManifest) {
+      FW.Log.error("没有找到本地Manifest文件!");
+      return;
+    }
+
+    const loadManifest = jsb.fileUtils.getStringFromFile(
+      localManifest.nativeUrl,
+    );
+    const manifestObject = JSON.parse(loadManifest);
+
+    FW.Log.debug("开始热更新流程:", manifestObject?.packageUrl);
+    this.localManifest = localManifest;
+    this.storePath = `${jsb.fileUtils ? jsb.fileUtils.getWritablePath() : "/"}${TEMOTE_ASSET}`;
+    this.assetMgr = new jsb.AssetsManager(
+      "",
+      this.storePath,
+      this.versionCompareHandle.bind(this),
+    );
+    this.assetMgr.setVerifyCallback(function (path: string, asset: any) {
+      const compressed = asset.compressed;
+      const expectedMD5 = asset.md5;
+      const relativePath = asset.path;
+      const size = asset.size;
+      if (compressed) {
+        return true;
+      } else {
+        return true;
+      }
+    });
+    this.checkHotUpdate();
+  }
+
+  private versionCompareHandle(
+    currentVersion: string,
+    newVersion: string,
+  ): number {
+    FW.Log.debug("版本比较", currentVersion, newVersion);
+    this.currentVersion = currentVersion;
+    this.newVersion = newVersion;
+    this.listener.versionCompareHandle(this.currentVersion, this.newVersion);
+    var vA = currentVersion.split(".");
+    var vB = newVersion.split(".");
+    for (var i = 0; i < vA.length; ++i) {
+      var a = parseInt(vA[i]);
+      var b = parseInt(vB[i] || "0");
+      if (a === b) {
+        continue;
+      } else {
+        return a - b;
+      }
+    }
+    if (vB.length > vA.length) {
+      return -1;
+    } else {
+      return 0;
+    }
+  }
+
+  private retry() {
+    if (!this.isUpdate && this.isRetry) {
+      this.isRetry = false;
+      this.assetMgr.downloadFailedAssets();
+      this.listener.retryHandle?.();
+    }
+  }
+
+  private checkHotUpdate() {
+    FW.Log.debug("checkHotUpdate1", this.isUpdate);
+    if (this.isUpdate) {
+      return;
+    }
+    if (this.assetMgr.getState() === jsb.AssetsManager.State.UNINITED) {
+      this.assetMgr.loadLocalManifest(this.localManifest.nativeUrl);
+    }
+
+    FW.Log.debug("checkHotUpdate3", this.assetMgr.getLocalManifest());
+
+    FW.Log.debug(
+      "checkHotUpdate4",
+      this.assetMgr.getLocalManifest().isLoaded(),
+    );
+
+    if (
+      !this.assetMgr.getLocalManifest() ||
+      !this.assetMgr.getLocalManifest().isLoaded()
+    ) {
+      FW.Log.debug("本地manifest未加载，尝试重新加载");
+      this.reloadLocalManifest();
+
+      // 如果仍然无法加载，则返回
+      if (
+        !this.assetMgr.getLocalManifest() ||
+        !this.assetMgr.getLocalManifest().isLoaded()
+      ) {
+        FW.Log.error("无法加载本地manifest文件");
+        return;
+      }
+    }
+
+    this.assetMgr.setEventCallback(this.checkEventHandle.bind(this));
+    this.assetMgr.checkUpdate();
+    this.isUpdate = true;
+  }
+
+  private reloadLocalManifest() {
+    try {
+      const updatedManifestPath = `${this.storePath}/project.manifest`;
+      if (jsb.fileUtils.isFileExist(updatedManifestPath)) {
+        this.assetMgr.loadLocalManifest(updatedManifestPath);
+
+        if (
+          this.assetMgr.getLocalManifest() &&
+          this.assetMgr.getLocalManifest().isLoaded()
+        ) {
+          FW.Log.debug("本地manifest重新加载成功");
+          this.localManifest = this.assetMgr.getLocalManifest();
+        } else {
+          FW.Log.error("本地manifest重新加载失败");
+        }
+      } else {
+        FW.Log.error("更新后的manifest文件不存在:", updatedManifestPath);
+      }
+    } catch (error) {
+      FW.Log.error("重新加载本地manifest时出错:", error);
+    }
+  }
+
+  private checkEventHandle(event: any) {
+    const code = event.getEventCode();
+    FW.Log.debug("checkEvent getEventCode -> ", code);
+    switch (code) {
+      case jsb.EventAssetsManager.ERROR_NO_LOCAL_MANIFEST:
+        FW.Log.debug("checkEvent getEventCode -> ", "ERROR_NO_LOCAL_MANIFEST");
+        break;
+      case jsb.EventAssetsManager.ERROR_DOWNLOAD_MANIFEST:
+        FW.Log.debug("checkEvent getEventCode -> ", "ERROR_DOWNLOAD_MANIFEST");
+        break;
+      case jsb.EventAssetsManager.ERROR_PARSE_MANIFEST:
+        FW.Log.debug("checkEvent getEventCode -> ", "ERROR_PARSE_MANIFEST");
+        break;
+      case jsb.EventAssetsManager.ALREADY_UP_TO_DATE:
+        FW.Log.debug("checkEvent getEventCode -> ", "ALREADY_UP_TO_DATE");
+        break;
+      case jsb.EventAssetsManager.NEW_VERSION_FOUND:
+        FW.Log.debug("checkEvent getEventCode -> ", "NEW_VERSION_FOUND");
+        break;
+      default:
+        return;
+    }
+
+    this.listener.checkHotUpdateHandle?.(code);
+    this.assetMgr.setEventCallback(null!);
+    this.isUpdate = false;
+    FW.Log.debug(
+      "isFind New Version -> ",
+      event.getEventCode() == jsb.EventAssetsManager.NEW_VERSION_FOUND,
+    );
+    if (event.getEventCode() == jsb.EventAssetsManager.NEW_VERSION_FOUND) {
+      this.hotUpdate();
+    }
+  }
+
+  private hotUpdate() {
+    FW.Log.debug("start hotUpdate ->", this.assetMgr, this.isUpdate);
+    if (this.assetMgr && !this.isUpdate) {
+      this.assetMgr.setEventCallback(this.updateEventHandle.bind(this));
+      FW.Log.debug(
+        "assetMgr state ->",
+        this.assetMgr.getState() === jsb.AssetsManager.State.UNINITED,
+      );
+      if (this.assetMgr.getState() === jsb.AssetsManager.State.UNINITED) {
+        this.assetMgr.loadLocalManifest(this.localManifest.nativeUrl);
+      }
+      this.isUpdate = true;
+      this.assetMgr.update();
+    }
+  }
+
+  private updateEventHandle(event: any) {
+    let needRestart = false;
+    let failed = false;
+    let percent: number = 0;
+    let downloadedFiles: number = 0;
+    let totalFiles: number = 0;
+    let downloadedBytes: number = 0;
+    let totalBytes: number = 0;
+    let convertDownloadedBytes: string = "";
+    let convertTotalBytes: string = "";
+    const code = event.getEventCode();
+    const msg = event.getMessage();
+    FW.Log.debug("updateEvent getEventCode -> ", code);
+    let str = "";
+    switch (code) {
+      case jsb.EventAssetsManager.ERROR_NO_LOCAL_MANIFEST:
+        failed = true;
+        str = "ERROR_NO_LOCAL_MANIFEST";
+        break;
+      case jsb.EventAssetsManager.UPDATE_PROGRESSION:
+        str = "UPDATE_PROGRESSION";
+        FW.Log.debug("updateEvent percent -> ", event.getPercent());
+        if (event.getPercent() > 0) {
+          downloadedFiles = event.getDownloadedFiles();
+          totalFiles = event.getTotalFiles();
+          downloadedBytes = event.getDownloadedBytes();
+          totalBytes = event.getTotalBytes();
+          convertDownloadedBytes = this.convertBytes(downloadedBytes);
+          convertTotalBytes = this.convertBytes(totalBytes);
+          percent = event.getPercent();
+          FW.Log.debug(
+            "正在更新中 -> ",
+            "下载文件数量:",
+            downloadedFiles,
+            ",下载文件总数量:",
+            totalFiles,
+            ",已下载大小:",
+            convertDownloadedBytes,
+            ",下载总大小:",
+            convertTotalBytes,
+          );
+        }
+        break;
+      case jsb.EventAssetsManager.ERROR_DOWNLOAD_MANIFEST:
+        str = "ERROR_DOWNLOAD_MANIFEST";
+        break;
+      case jsb.EventAssetsManager.ERROR_PARSE_MANIFEST:
+        str = "ERROR_PARSE_MANIFEST";
+        failed = true;
+        break;
+      case jsb.EventAssetsManager.ALREADY_UP_TO_DATE:
+        str = "ALREADY_UP_TO_DATE";
+        failed = true;
+        break;
+      case jsb.EventAssetsManager.UPDATE_FINISHED:
+        if (event.getPercent() > 0) {
+          downloadedFiles = event.getDownloadedFiles();
+          totalFiles = event.getTotalFiles();
+          downloadedBytes = event.getDownloadedBytes();
+          totalBytes = event.getTotalBytes();
+          convertDownloadedBytes = this.convertBytes(downloadedBytes);
+          convertTotalBytes = this.convertBytes(totalBytes);
+          percent = event.getPercent();
+          FW.Log.debug(
+            "正在更新完成 -> ",
+            "下载文件数量:",
+            downloadedFiles,
+            ",下载文件总数量:",
+            totalFiles,
+            ",已下载大小:",
+            convertDownloadedBytes,
+            ",下载总大小:",
+            convertTotalBytes,
+          );
+        }
+        str = "UPDATE_FINISHED";
+        needRestart = true;
+        break;
+      case jsb.EventAssetsManager.UPDATE_FAILED:
+        str = "UPDATE_FAILED";
+        this.isUpdate = false;
+        this.isRetry = true;
+        break;
+      case jsb.EventAssetsManager.ERROR_UPDATING:
+        str = "ERROR_UPDATING";
+        break;
+      case jsb.EventAssetsManager.ERROR_DECOMPRESS:
+        str = "ERROR_DECOMPRESS";
+        break;
+      default:
+        break;
+    }
+
+    FW.Log.debug("热更新中->", str);
+    FW.Log.debug("热更新msg ->", msg);
+    this.listener.hotUpdatingHandle?.(code, {
+      percent: percent,
+      downloadedFiles: downloadedFiles,
+      totalFiles: totalFiles,
+      downloadedBytes: downloadedBytes,
+      totalBytes: totalBytes,
+      convertDownloadedBytes: convertDownloadedBytes,
+      convertTotalBytes: convertTotalBytes,
+    });
+    if (failed) {
+      FW.Log.debug("热更新中结果 failed -> ", failed);
+      FW.Log.debug("下载失败");
+      this.assetMgr.setEventCallback(null!);
+      this.isUpdate = false;
+      this.retry();
+    }
+    if (needRestart) {
+      FW.Log.debug("热更新中结果 needRestart -> ", needRestart);
+      FW.Log.debug("下载完成");
+      const searchPaths = jsb.fileUtils.getSearchPaths();
+      const newPaths = this.assetMgr.getLocalManifest().getSearchPaths();
+      Array.prototype.unshift.apply(searchPaths, newPaths);
+      jsb.fileUtils.setSearchPaths(searchPaths);
+      this.isRetry = false;
+      this.isUpdate = false;
+
+      this.reloadLocalManifest();
+
+      this.assetMgr.setEventCallback(null!);
+      this.listener.completedHandle?.(this.newVersion);
+    }
+  }
+
+  private convertBytes(bytes: number) {
+    const units = ["B", "KB", "MB", "GB"];
+    let size = bytes,
+      unitIndex = 0;
+    while (size >= 1024 && unitIndex < units.length - 1) {
+      size /= 1024;
+      unitIndex++;
+    }
+    return `${size.toFixed(size < 10 ? 2 : 1)} ${units[unitIndex]}`;
+  }
+
+  public initialize(): void {}
+  public onDestroy(): void {}
+}