找物源码导读Cocos Creator 3.8 · assets/scripts
0%
已读 0 / 424
目录— 个文件
目录加载中…
…/core/objectPool/ObjectPoolManager.ts
1import { Singleton } from "../base/Singleton";
2import { IFrameworkManager } from "../base/IFrameworkManager";
3import { ObjectPool } from "./ObjectPool";
4import { ObjectBase } from "./ObjectBase";
5import { Framework } from "../../../framework/Framework";
6import { Node } from 'cc';
7import { frameworkManager } from "../base/FrameworkClassRegistry";
8
9/**
10 * 对象池管理器(支持脚本类型直接调用)
11 */
12@frameworkManager()
13export class ObjectPoolManager extends Singleton<ObjectPoolManager> implements IFrameworkManager {
14 Name: string = "ObjectPoolManager";
15 private pools: Map<string, ObjectPool<any>> = new Map();
16
17 public async Init(): Promise<void> {
18 // 记录管理器初始化入口,便于排查启动顺序。
19 Framework.Log.Log(this.Name, "Init", "初始化对象池管理器");
20 }
21
22 public DeInit(): void {
23 this.ClearAllPools(true);
24 }
25
26 Update(deltaTime: number): void {
27 }
28
29 /**
30 * 创建对象池(通过模板节点)
31 * @param templateNode 挂载 ObjectBase 子类组件的模板节点
32 * @param maxCount 最大容量(默认10)
33 * @param preloadCount 预加载数量(默认0)
34 */
35 public CreatePool(
36 templateNode: Node,
37 maxCount: number = 10,
38 preloadCount: number = 0
39 ): ObjectPool<any> | null {
40 // 从模板节点提取组件类型生成池名称
41 const baseComponent = templateNode.getComponent(ObjectBase);
42 if (!baseComponent) {
43 Framework.Log.Error("模板节点未挂载 ObjectBase 组件");
44 return null; // 失败返回null
45 }
46 const componentType = baseComponent.constructor as new () => ObjectBase;
47 const poolName = `${templateNode.name}Pool`;
48 Framework.Log.Log(`创建对象池[${poolName}],最大容量:${maxCount},预加载数量:${preloadCount}`);
49
50 if (this.pools.has(poolName)) {
51 Framework.Log.Error(`对象池[${poolName}]已存在`);
52 return this.pools.get(poolName)!; // 已存在时返回现有实例
53 }
54
55 const newPool = new ObjectPool(templateNode, maxCount, preloadCount);
56 this.pools.set(poolName, newPool);
57 return newPool; // 成功返回新创建的实例
58 }
59
60 /**
61 * 清空对象池(重载1:通过对象池实例)
62 * @param pool 要清空的对象池实例
63 * @param forceRelease 是否强制释放使用中对象
64 */
65 public ClearPool(pool: ObjectPool<any>, forceRelease?: boolean): void;
66 /**
67 * 清空对象池(重载2:通过对象池名称)
68 * @param poolName 要清空的对象池名称
69 * @param forceRelease 是否强制释放使用中对象
70 */
71 public ClearPool(poolName: string, forceRelease?: boolean): void;
72 /**
73 * 清空对象池(重载3:通过组件类型)
74 * @param componentType ObjectBase 子类类型
75 * @param forceRelease 是否强制释放使用中对象
76 */
77 public ClearPool<T extends ObjectBase>(componentType: new () => T, forceRelease?: boolean): void;
78 /**
79 * 清空对象池实现(多参数类型处理)
80 */
81 public ClearPool(arg1: any, forceRelease: boolean = false): void {
82 let pool: ObjectPool<any> | undefined;
83 let poolName: string = "";
84
85 // 根据第一个参数类型判断处理方式
86 if (arg1 instanceof ObjectPool) {
87 // 处理对象池实例重载
88 pool = arg1;
89 // 查找实例对应的名称
90 for (const [name, p] of this.pools) {
91 if (p === pool) {
92 poolName = name;
93 break;
94 }
95 }
96 } else if (typeof arg1 === "string") {
97 // 处理对象池名称重载
98 poolName = arg1;
99 pool = this.pools.get(poolName);
100 } else if (typeof arg1 === "function") {
101 // 处理组件类型重载(原有逻辑)
102 poolName = `${arg1.name}Pool`;
103 pool = this.pools.get(poolName);
104 }
105
106 // 执行清空逻辑
107 if (pool && poolName) {
108 pool.Clear(forceRelease);
109 let usingCount = pool.GetUsingCount();
110 if (usingCount === 0) {
111 this.pools.delete(poolName);
112 Framework.Log.Log(`对象池[${poolName}]已清空并移除`);
113 } else {
114 Framework.Log.Warn(`对象池[${poolName}]仍有${usingCount}个使用中对象,未从管理器移除`);
115 }
116 } else {
117 Framework.Log.Error(`对象池不存在或参数无效: ${arg1}`);
118 }
119 }
120
121
122 // 清空所有池(保持不变)
123 public ClearAllPools(forceRelease: boolean = false): void {
124 this.pools.forEach(pool => pool.Clear(forceRelease));
125 this.pools.clear();
126 }
127}
讲解128 行
对象池管理器人工通读

ObjectPoolManager.ts

用一张 Map 按名字管理多个对象池,创建时从模板节点提取 ObjectBase 组件并生成池名,同名池已存在就直接返回旧实例。清空支持池实例、池名、组件类型三种重载,只有池内还有使用中对象时才保留在映射里。

按 CreatePool、三个 ClearPool 重载声明、ClearPool 的参数类型分发、ClearAllPools 的顺序读,注意两套池名生成规则。

特殊处理与易错点

12注释对象池管理器(支持脚本类型直接调用)
13注释ObjectPoolManager:对象池管理器:按模板节点创建池、按实例/名称/组件类型清理、统计使用中数量。
14属性管理器名称,日志里的模块标识。
15属性池名到对象池实例的映射,创建、清空与全部清空都读写它。
17方法只写一条初始化日志,不预建任何对象池。
19注释记录管理器初始化入口,便于排查启动顺序。
22方法用强制模式清空所有池并移除全部映射,使用中的对象也会被销毁。
26方法空实现,对象池的创建与回收都由业务显式调用,没有逐帧任务。
35方法校验模板节点的 ObjectBase 组件后生成池名,已存在则返回旧池,否则新建并登记。
38属性创建对象池(通过模板节点)
41注释从模板节点提取组件类型生成池名称
65方法按首个参数是池实例、字符串还是构造函数分发,清空后视在用数量决定是否删除映射。
71注释清空对象池(重载2:通过对象池名称)
77注释清空对象池(重载3:通过组件类型)
81注释清空对象池实现(多参数类型处理)
86注释根据第一个参数类型判断处理方式
88注释处理对象池实例重载
90注释查找实例对应的名称
98注释处理对象池名称重载
102注释处理组件类型重载(原有逻辑)
107注释执行清空逻辑
123方法遍历所有池逐个清空后直接清掉整个映射,不检查是否还有使用中对象。