目录— 个文件
⌕
目录加载中…
…/core/version/VersionManager.ts
1import { Framework } from "../../Framework";
2import { frameworkManager } from "../base/FrameworkClassRegistry";
3import { IFrameworkManager } from "../base/IFrameworkManager";
4import { Singleton } from "../base/Singleton";
5import { DataFrameKey } from "../data/DataFrameKey";
6import { EventFrameCode } from "../event/EventFrameCode";
7
8/**
9 * 版本号管理器
10 * 版本号暂时通过BundleVersion Bundle的版本号保持同步
11 */
12@frameworkManager()
13export class VersionManager extends Singleton<VersionManager> implements IFrameworkManager {
14 Name: string = "VersionManager";
15
16 //版本号
17 version: string = null!;
18
19 //是否是新的版本
20 isNewVersion: boolean = false;
21
22 get IsNewVersion(): boolean {
23 return this.isNewVersion;
24 }
25
26 public async Init(): Promise<void> {
27 // 记录管理器初始化入口,便于排查启动顺序。
28 Framework.Log.Log(this.Name, "Init", "初始化版本管理器");
29 this.version = Framework.Res.Config.BundleVersion;
30 // 玩家存档确认后再比较资源版本,避免提前读写尚未加载的存档。
31 Framework.Event.RegisterEvent(EventFrameCode.PLAYER_DATA_READY, this.CheckVersion, this);
32 }
33
34
35
36 DeInit(): void {
37 Framework.Event.UnRegisterEvent(EventFrameCode.PLAYER_DATA_READY, this.CheckVersion, this);
38 }
39
40 Update(deltaTime: number): void {
41 }
42
43 /** 使用最终玩家存档比较并记录本次客户端资源版本。 */
44 private CheckVersion(): void {
45 let oldVersion = this.GetLocalVersion();
46 //旧的版本号和新的不一样 则更新本地版本号 并且抛出版本更新事件
47 if (oldVersion != this.version) {
48 this.SetLocalVersion(this.version);
49 this.isNewVersion = true;
50 }
51 }
52
53 /**
54 * 获取本地存储版本号
55 * @constructor
56 * @private
57 */
58 private GetLocalVersion(): string {
59 let version = Framework.Data.GetData(DataFrameKey.CLIENT_RESOURCE_VERSION, Framework.Res.Config.BundleVersion)
60 return version;
61 }
62
63 /**
64 * 设置本地存储版本号
65 * @constructor
66 * @private
67 */
68 private SetLocalVersion(version: string): void {
69 Framework.Data.SaveData(DataFrameKey.CLIENT_RESOURCE_VERSION, version);
70 }
71
72}
讲解73 行
客户端资源版本管理人工通读
VersionManager.ts
单例框架管理器,在 Init 时读取 Bundle 版本号并监听玩家数据就绪事件,待存档可用后再与本地记录的版本比较。版本不同则写入新值并置 isNewVersion,供后续逻辑判断是否需要提示或刷新资源。
按 Init、CheckVersion、GetLocalVersion、SetLocalVersion 的顺序读,注意比较发生在事件回调而不是 Init 当时。
特殊处理与易错点
- 时序版本比较挂在 PLAYER_DATA_READY 事件上,Init 执行完时 isNewVersion 还没有被计算。L31
- 边界首次读取的默认值就是当前 BundleVersion,因此首次启动不会被判定为新版本。L59
- 设计只有版本不相等才回写本地存档,相同版本不做任何写入。L47
- 设计IsNewVersion 只读属性直接返回字段,没有复位逻辑,一旦置 true 本次运行内不会自动清除。L22
- 易错点DeInit 只注销事件,不会重写或清理已保存的本地版本号。L36
12注释版本号管理器 版本号暂时通过BundleVersion Bundle的版本号保持同步
13注释VersionManager:版本管理器:PLAYER_DATA_READY 后比较 BundleVersion 与本地缓
14属性管理器名,固定为 VersionManager,用于框架注册与日志。
17属性当前 Bundle 的资源版本号,Init 时从 Framework.Res.Config.BundleVers
20属性是否检测到版本变化的标志,默认 false。
22方法读取玩家存档就绪后比较客户端资源版本得到的更新标记。
26方法打印初始化日志,取 Bundle 版本号写入 version,并注册玩家数据就绪事件。
28注释记录管理器初始化入口,便于排查启动顺序。
31注释玩家存档确认后再比较资源版本,避免提前读写尚未加载的存档。
36方法注销 PLAYER_DATA_READY 上的 CheckVersion 监听。
40方法空实现,只为满足管理器接口,不参与每帧逻辑。
44方法读取本地版本与当前版本比较,不相等时回写本地并把 isNewVersion 置为 true。
47注释旧的版本号和新的不一样 则更新本地版本号 并且抛出版本更新事件
58方法按 CLIENT_RESOURCE_VERSION 键读取存档,缺省时返回当前 Bundle 版本。
68方法把版本号写入 CLIENT_RESOURCE_VERSION 存档项。