找物源码导读Cocos Creator 3.8 · assets/scripts
0%
已读 0 / 424
目录— 个文件
目录加载中…
…/core/base/FrameworkClassRegistry.ts
1/**
2 * 框架基础装饰器,用于标记框架核心组件
3 * 使用此装饰器的类将被 GameEntry 自动实例化为单例
4 */
5
6// 定义带优先级的类信息接口
7interface ClassWithPriority {
8 cls: Function;
9 priority: number;
10 isModule: boolean; // 标记是否为模块类
11}
12
13/**
14 * 框架类装饰器,用于标记框架核心组件
15 * 使用此装饰器的类将被 GameEntry 自动实例化为单例
16 */
17export function frameworkManager(priority: number = 0) {
18 return function(constructor: Function) {
19 // 存储类引用和优先级到全局注册表
20 FrameworkClassRegistry.register({ cls: constructor, priority,isModule:false });
21 };
22}
23
24/**
25 * 业务模块类装饰器,用于标记模块组件
26 * 使用此装饰器的类将在框架类之后被 GameEntry 自动实例化为单例
27 */
28export function moduleManager(priority: number = 0) {
29 return function(constructor: Function) {
30 // 存储类引用和优先级到全局注册表
31 FrameworkClassRegistry.register({ cls: constructor, priority,isModule:true });
32 };
33
34}
35/**
36 * 框架类注册表,用于存储被装饰器标记的类
37 */
38export class FrameworkClassRegistry {
39 private static _classes: ClassWithPriority[] = [];
40
41 /**
42 * 注册一个框架类
43 */
44 public static register(clsInfo: ClassWithPriority): void {
45 // 使用 findIndex 检查类是否已存在
46 const index = this._classes.findIndex(item => item.cls === clsInfo.cls);
47 if (index === -1) {
48 this._classes.push(clsInfo);
49 }
50 }
51
52 /**
53 * 获取所有已注册的类,先按是否为框架类排序(框架类在前),再按优先级排序
54 */
55 public static getAllRegisteredClasses(): Function[] {
56 return [...this._classes]
57 .sort((a, b) => {
58 // 先按是否为模块类排序,框架类在前
59 if (a.isModule !== b.isModule) {
60 return a.isModule ? 1 : -1;
61 }
62 // 再按优先级排序
63 return a.priority - b.priority;
64 })
65 .map(item => item.cls);
66 }
67
68 /**
69 * 获取所有已注册的框架类,并按优先级排序
70 */
71 public static getFrameworkClasses(): Function[] {
72 return this._classes
73 .filter(item => !item.isModule)
74 .sort((a, b) => a.priority - b.priority)
75 .map(item => item.cls);
76 }
77
78 /**
79 * 获取所有已注册的模块类,并按优先级排序
80 */
81 public static getModuleClasses(): Function[] {
82 return this._classes
83 .filter(item => item.isModule)
84 .sort((a, b) => a.priority - b.priority)
85 .map(item => item.cls);
86 }
87}
讲解88 行
框架类注册表与装饰器人工通读

FrameworkClassRegistry.ts

提供两个装饰器,在类定义被加载时把构造函数、优先级和是否为模块登记进一张静态表。GameEntry 启动时从这张表取类并实例化单例,取出的顺序是框架类在前、模块类在后、同类按优先级升序。注册表只活在内存里,不参与序列化,也不负责实例化。

先看 frameworkManager 与 moduleManager 两个装饰器,再看 register 的按引用去重,最后读三个取类方法的排序差异。

特殊处理与易错点

7注释定义带优先级的类信息接口
8属性cls(Function):该模块的运行态字段。
9属性priority(number):该模块的运行态字段。
10属性是否 Module(boolean):布尔开关/状态标记,用于显隐、分支或互斥判断。
17方法返回一个类装饰器,把被装饰类以非模块身份和给定优先级登记到注册表。
20注释存储类引用和优先级到全局注册表
28方法返回一个类装饰器,把被装饰类标记为业务模块并按优先级登记,实例化排在框架类之后。
31注释存储类引用和优先级到全局注册表
38注释FrameworkClassRegistry:框架类注册表,用于存储被装饰器标记的类
44方法用构造函数引用在数组中查找,未登记过才追加,重复登记被忽略且不报错。
46注释使用 findIndex 检查类是否已存在
55方法复制内部数组后统一排序,框架类在前、模块类在后,同组按优先级升序返回构造函数列表。
59注释先按是否为模块类排序,框架类在前
63注释再按优先级排序
71方法过滤出非模块的框架类并按优先级升序返回,不包含业务模块。
81方法过滤出模块类并按优先级升序返回,供入口在框架类之后实例化。