找物源码导读Cocos Creator 3.8 · assets/scripts
0%
已读 0 / 424
目录— 个文件
目录加载中…
…/core/event/EventManager.ts
1import { Node } from 'cc';
2import { frameworkManager } from "../base/FrameworkClassRegistry";
3import { Framework } from "../../Framework";
4import { IFrameworkManager } from "../base/IFrameworkManager";
5import { Singleton } from "../base/Singleton";
6import { EventCallback } from "./EventDefine";
7
8/**
9 * 禁止使用bind方法,因为bind方法会导致事件注销时内存泄漏
10 */
11// 定义事件监听器项接口(包含回调和上下文)
12interface EventListenerItem {
13 callback: EventCallback;
14 context: any; // 回调函数的执行上下文(this)
15}
16/**
17 * 事件管理器
18 * 支持:事件注册、事件发送、事件注销,并处理异常与内存泄漏
19 */
20@frameworkManager()
21export class EventManager extends Singleton<EventManager> implements IFrameworkManager {
22 Name: string = "EventManager";
23
24 // 事件监听器:存储 {事件码: [{回调, 上下文}, ...]}
25 private eventListeners: Map<string, EventListenerItem[]> = new Map();
26
27 public async Init(): Promise<void> {
28 // 记录管理器初始化入口,便于排查启动顺序。
29 Framework.Log.Log(this.Name, "Init", "初始化事件管理器");
30 }
31
32 public DeInit(): void {
33 // 清理所有事件监听
34 this.eventListeners.clear();
35 }
36
37 Update(deltaTime: number): void {
38 }
39
40 /**
41 * 发送事件
42 * @param eventCode 事件码
43 * @param context 事件上下文
44 * @param data 事件数据
45 */
46 public SendEvent(eventCode: string, data: any = null) {
47 const listeners = this.eventListeners.get(eventCode);
48 if (listeners) {
49 // 复制监听器数组防止执行中修改导致异常
50 // const listenersCopy = [...listeners];
51 listeners.forEach(item => {
52 try {
53 // 使用存储的上下文调用回调(确保this指向正确)
54 item.callback.call(item.context, data);
55 } catch (error) {
56 console.error(`事件回调执行异常 [${eventCode}]:`, error);
57 }
58 });
59 }
60 }
61
62 /**
63 * 发送延迟事件
64 * @param eventCode
65 * @param delayMs 延迟毫秒
66 * @param context 事件上下文
67 * @param data 事件数据
68 * @constructor
69 */
70 public SendDelayEvent(eventCode: string, delayMs: number, data: any = null) {
71 setTimeout(() => {
72 this.SendEvent(eventCode, data);
73 }, delayMs);
74 }
75
76
77 /**
78 * 注册事件
79 * @param eventCode 事件码
80 * @param callback 回调函数
81 * @param context 回调执行上下文(this指向)
82 */
83 public RegisterEvent(eventCode: string, callback: EventCallback, context: any) {
84 if (!eventCode || !callback) {
85 console.error("事件注册失败:事件码或回调为空");
86 return;
87 }
88
89 if (!this.eventListeners.has(eventCode)) {
90 this.eventListeners.set(eventCode, []);
91 }
92
93 const listeners = this.eventListeners.get(eventCode)!;
94 // 避免重复注册(相同回调+相同上下文)
95 const isDuplicate = listeners.some(item =>
96 item.callback === callback && item.context === context
97 );
98
99 if (!isDuplicate) {
100 listeners.push({ callback, context });
101 }
102 }
103
104 /**
105 * 注销事件
106 * @param eventCode 事件码
107 * @param callback 回调函数
108 * @param context 回调执行上下文(需与注册时一致)
109 */
110 public UnRegisterEvent(eventCode: string, callback: EventCallback, context: any) {
111 if (!this.eventListeners.has(eventCode)) return;
112
113 const listeners = this.eventListeners.get(eventCode)!;
114 const index = listeners.findIndex(item =>
115 item.callback === callback && item.context === context
116 );
117
118 if (index !== -1) {
119 listeners.splice(index, 1);
120 // 清理空事件列表
121 if (listeners.length === 0) {
122 this.eventListeners.delete(eventCode);
123 }
124 }
125 }
126
127 /**
128 * 注册事件 当节点隐藏时自动注销事件
129 * @param eventCode 事件码
130 * @param callback 回调函数
131 * @param context 回调执行上下文
132 * @param node 节点(用于监听隐藏事件)
133 */
134 public RegisterEventReleaseDisable(eventCode: string, callback: EventCallback, context: any, node: Node) {
135 this.RegisterEvent(eventCode, callback, context);
136
137 const onNodeDisabled = (node: Node) => {
138 if (!node.active) {
139 // Framework.Log.Log(node.name+"节点隐藏时自动注销事件 [" + eventCode + "]");
140 this.UnRegisterEvent(eventCode, callback, context);
141 node.off('active-changed', onNodeDisabled, this);
142 }
143 };
144
145 // 修复:监听节点的激活状态变化事件 'active-changed'
146 node.on('active-changed', onNodeDisabled, this);
147 }
148
149 /**
150 * 注册事件 当节点销毁时自动注销事件
151 * @param eventCode 事件码
152 * @param callback 回调函数
153 * @param context 回调执行上下文
154 * @param node 节点(用于监听销毁事件)
155 */
156 public RegisterEventReleaseDestroy(eventCode: string, callback: EventCallback, context: any, node: Node) {
157 this.RegisterEvent(eventCode, callback, context);
158
159 const onNodeDestroyed = () => {
160 // Framework.Log.Log(node.name+"节点销毁时自动注销事件 [" + eventCode + "]");
161 this.UnRegisterEvent(eventCode, callback, context);
162 };
163
164 node.once('node-destroyed', onNodeDestroyed, this);
165 }
166
167 /**
168 * 检查事件是否已注册
169 * @param eventCode 事件码
170 * @returns 是否已注册
171 */
172 public HasRegisterEvent(eventCode: string, callback?: EventCallback, context?: any): boolean {
173 if (!eventCode) return false;
174 const hasCallback = callback !== undefined;
175 const hasContext = context !== undefined;
176 return this.eventListeners.has(eventCode) && this.eventListeners.get(eventCode)!.some(item => {
177 if (hasCallback && hasContext) {
178 return item.callback === callback && item.context === context;
179 }
180 if (hasCallback) {
181 return item.callback === callback;
182 }
183 if (hasContext) {
184 return item.context === context;
185 }
186 return false;
187 });
188 }
189
190}
讲解191 行
全局事件总线人工通读

EventManager.ts

用一张 Map 维护事件码到回调加上下文列表的映射,提供注册、注销、立即发送、延迟发送,以及随节点隐藏或销毁自动注销的注册变体。框架模块与 UI 都通过 Framework.Event 使用它,是跨模块解耦通信的唯一通道。

先读 RegisterEvent 与 UnRegisterEvent 的匹配规则,再看 SendEvent 的遍历与异常吞掉,然后读两个自动注销变体和 HasRegisterEvent 的三种匹配分支。

特殊处理与易错点

12注释禁止使用bind方法,因为bind方法会导致事件注销时内存泄漏
13属性callback(EventCallback):该模块的运行态字段。
14属性context(any):该模块的运行态字段。
20注释事件管理器 支持:事件注册、事件发送、事件注销,并处理异常与内存泄漏
21注释EventManager:全局同步事件总线:RegisterEvent/UnRegisterEvent/SendEve
22属性管理器名称,日志里的模块标识。
25属性事件码到监听项数组的映射,监听项同时保存回调与上下文,注册、注销、发送都读写它。
27方法只写一条初始化日志,不预建任何事件表项。
29注释记录管理器初始化入口,便于排查启动顺序。
32方法直接清空整张监听表,不逐个通知也不取消已排期的延迟事件。
34注释清理所有事件监听
37方法空实现,事件全部由发送方主动触发,没有逐帧任务。
46方法按事件码取出监听数组,逐个用注册时保存的上下文调用回调并把数据原样传入。
51注释复制监听器数组防止执行中修改导致异常 const listenersCopy = [...listeners];
54注释使用存储的上下文调用回调(确保this指向正确)
70方法用 setTimeout 在指定毫秒后调用 SendEvent,期间不保存任务句柄也无法取消。
83方法校验事件码与回调后建表,按回调与上下文同时相同判重,不重复则追加一项。
95注释避免重复注册(相同回调+相同上下文)
110方法在对应事件码的数组里按回调与上下文找第一项匹配,删掉后若数组为空则移除整个键。
121注释清理空事件列表
134方法先正常注册,再监听节点的 active-changed,节点隐藏时注销事件并解除该节点监听。
140注释Framework.Log.Log(node.name+"节点隐藏时自动注销事件 [" + eventCode + "]");
146注释修复:监听节点的激活状态变化事件 'active-changed'
156方法先正常注册,再用 once 监听节点的 node-destroyed,节点销毁时注销该事件。
161注释Framework.Log.Log(node.name+"节点销毁时自动注销事件 [" + eventCode + "]");
172方法按事件码查表,再根据传入的回调与上下文是否为空走三种匹配方式判断是否存在。