抱歉，您的浏览器无法访问本站
本页面需要浏览器支持（启用）JavaScript
了解详情 >

Unity自定义事件系统

Unity工具

发布于：2023年8月24日

次浏览

字数：1.9k 字

时长：9 分钟

简介

在事件传递的过程中设置一个中间对象，负责管理监听者和发送者，以达到解耦合的目的。

本项目利用元组来实现指定参数的监听事件，方便传参，避免事件通知时传参产生的拆装箱。

基本原理

我们创建一个事件数据类来保存我们要用到的数据。

1
2
3
4
5
6
7
8
9
10
11
12
using System;

namespace EventToolKit
{
    public struct EventData
    {
        public string id;
        public string key;
        public int index;
        public Delegate action;
    }
}

在事件管理工具中我们使用 Dictionary<string, Dictionary<int, EventData>> _events 来保存监听的事件。

其中 key 为枚举类型，代表事件名，Dictionary<int, EventData> 为事件 index 和事件函数的键值对。

然后我们用 Dictionary<string, HashSet<(string key, int index)>> _nodeNav 来保存节点导航，其中 key 为 string 类型，代表节点 id，后面的 HashSet 为事件名和事件 index 的键值对。此处用 HashSet 是为了避免重复添加。

事件监听的逻辑如下所示：

graph TD;

A["注册监听"]
B["创建EventData"]
C["保存EventData到_events"]
D["保存key和index到_nodeNav"]

A --> B
B --> C
C --> D

事件触发的逻辑如下所示：

graph TD;

A["触发事件"]
B["尝试从 _events 获取事件 key 对应的监听字典"]
C["遍历监听字典，调用相符的事件函数"]

A --> B
B --> C

粘性通知

为了防止部分情况中出现通知不到位的情况（即先通知后监听），这里我们引入了粘性通知的功能。

此处我们定义一个字典 Dictionary<string, List<Action>> _stickyNotify 来保存通知的行为，这里我们分为两种情况，一种情况是该粘性通知只需要通知一次，则我们只需要让新的通知覆盖旧的通知；另一种是需要多次通知，则我们设置一个数组来保存多次通知的内容。

粘性通知和普通通知的触发事件逻辑相似，可以说前半部分的代码和普通通知一样，只不过我们判断是否通知到位，若没有通知到位，则进入粘性通知内容保存的流程。

注册监听者的部分代码也有改动，在注册完成后，若从粘性通知字典 _stickyNotify 取到对应事件名的内容，则立刻进行一次通知，通知结束后删除对应的内容。

简单来说，粘性通知就是在监听和通知这两个过程之后增加一个判断，对于监听者来说，就是要判断有无通知的内容，而对于通知来说，就是判断是否有监听者监听过该通知内容。

所以整体的事件监听流程就变成了如下：

graph TD;

A["注册监听"]
B["创建EventData"]
C["保存EventData到_events"]
D["保存key和index到_nodeNav"]
E["判断是否有粘性通知，有就立即执行事件"]

A --> B
B --> C
C --> D
D --> E

所以整体的事件触发流程就变成了如下：

graph TD;

A["触发事件"]
B["尝试从 _events 获取事件 key 对应的监听字典"]
C["遍历监听字典，调用相符的事件函数"]
D["保存通知行为到 _stickyNotify"]

A --> B
B --"有通知监听"--> C
B --"没有通知监听"--> D

代码

事件数据类

1
2
3
4
5
6
7
8
9
10
11
12
using System;

namespace EventToolKit
{
    public struct EventData
    {
        public string id;
        public string key;
        public int index;
        public Delegate action;
    }
}

事件管理类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel;
using UnityEngine;

namespace EventToolKit
{
    public enum Sticky
    {
        /// <summary>
        /// 非粘性通知
        /// </summary>
        None,
        /// <summary>
        /// 粘性通知
        /// </summary>
        Sticky,
        /// <summary>
        /// 粘性通知队列
        /// </summary>
        StickyArray
    }

    public class EventKit
    {
        /// <summary>
        /// 节点导航字典，存储该节点的所有事件
        /// </summary>
        private static Dictionary<string, HashSet<(string key, int index)>> _nodeNav = new();

        /// <summary>
        /// 事件字典
        /// </summary>
        private static Dictionary<string, Dictionary<int, EventData>> _events = new();

        /// <summary>
        /// 粘性通知字典
        /// </summary>
        private static Dictionary<string, List<Action>> _stickyNotify = new();

        /// <summary>
        /// 事件索引
        /// </summary>
        private static int _eventIndex = 0;

        /// <summary>
        /// 添加无参事件监听
        /// </summary>
        /// <param name="id">节点id</param>
        /// <param name="key">事件名</param>
        /// <param name="evt">事件函数</param>
        /// <returns></returns>
        public static EventData AddEvent(string id, string key, Action evt)
        {
            int index = _eventIndex++;

            if (!_events.ContainsKey(key))
            {
                _events.Add(key, new Dictionary<int, EventData>());
            }

            EventData eventData = new EventData()
            {
                id = id,
                index = index,
                key = key,
                action = evt
            };

            _events[key][index] = eventData;

            if (!_nodeNav.ContainsKey(id))
            {
                _nodeNav.Add(id, new HashSet<(string e, int index)>());
            }

            _nodeNav[id].Add((key, index));

            _stickyNotify.TryGetValue(key, out var stickies);

            if (stickies != null)
            {
                foreach (var sticky in stickies)
                {
                    sticky.Invoke();
                }

                _stickyNotify.Remove(key);
            }

            return eventData;
        }

        /// <summary>
        /// 添加有参事件监听
        /// </summary>
        /// <param name="id">节点id</param>
        /// <param name="key">事件名</param>
        /// <param name="evt">事件函数</param>
        /// <typeparam name="T"></typeparam>
        /// <returns></returns>
        public static EventData AddEvent<T>(string id, string key, Action<T> evt)
        {
            int index = _eventIndex++;

            if (!_events.ContainsKey(key))
            {
                _events.Add(key, new Dictionary<int, EventData>());
            }

            EventData eventData = new EventData()
            {
                id = id,
                index = index,
                key = key,
                action = evt
            };

            _events[key][index] = eventData;

            if (!_nodeNav.ContainsKey(id))
            {
                _nodeNav.Add(id, new HashSet<(string e, int index)>());
            }

            _nodeNav[id].Add((key, index));

            _stickyNotify.TryGetValue(key, out var stickies);

            if (stickies != null)
            {
                foreach (var sticky in stickies)
                {
                    sticky.Invoke();
                }

                _stickyNotify.Remove(key);
            }

            return eventData;
        }

        /// <summary>
        /// 发送无参事件
        /// </summary>
        /// <param name="key">事件名</param>
        /// <param name="sticky">粘性通知类型</param>
        public static void SendEvent(string key, Sticky sticky = Sticky.None)
        {
            _events.TryGetValue(key, out var arr);

            if (arr != null)
            {
                foreach (var action in arr)
                {
                    if (action.Value.action is Action valueAction)
                    {
                        valueAction.Invoke();
                    }
                    else
                    {
#if DEBUG
                        Debug.LogError("事件为有参函数");
#endif
                    }
                }
            }
            else
            {
                if (sticky != Sticky.None)
                {
                    if (!_stickyNotify.ContainsKey(key))
                    {
                        _stickyNotify.Add(key, new());
                    }

                    Action notify = () => { SendEvent(key); };

                    if (sticky == Sticky.StickyArray)
                    {
                        _stickyNotify[key].Add(notify);
                    }
                    else
                    {
                        if (_stickyNotify[key].Count > 0)
                        {
                            _stickyNotify[key][0] = notify;
                        }
                        else
                        {
                            _stickyNotify[key].Add(notify);
                        }
                    }
                }
                else
                {
#if DEBUG
                    Debug.LogWarning("事件" + key + "未注册");
#endif
                }
            }
        }

        /// <summary>
        /// 发送有参事件
        /// </summary>
        /// <param name="key">事件名</param>
        /// <param name="data">参数</param>
        /// <param name="sticky">粘性通知类型</param>
        /// <typeparam name="TEnum"></typeparam>
        /// <typeparam name="T"></typeparam>
        public static void SendEvent<T>(string key, T data, Sticky sticky = Sticky.None)
        {
            _events.TryGetValue(key, out var arr);

            if (arr != null)
            {
                foreach (var action in arr)
                {
                    if (action.Value.action is Action<T> valueAction)
                    {
                        valueAction.Invoke(data);
                    }
                    else
                    {
#if DEBUG
                        Debug.LogError("事件为无参函数或参数错误");
#endif
                    }
                }
            }
            else
            {
                if (sticky != Sticky.None)
                {
                    if (!_stickyNotify.ContainsKey(key))
                    {
                        _stickyNotify.Add(key, new());
                    }

                    Action notify = () => { SendEvent(key, data); };

                    if (sticky == Sticky.StickyArray)
                    {
                        _stickyNotify[key].Add(notify);
                    }
                    else
                    {
                        if (_stickyNotify[key].Count > 0)
                        {
                            _stickyNotify[key][0] = notify;
                        }
                        else
                        {
                            _stickyNotify[key].Add(notify);
                        }
                    }
                }
                else
                {
#if DEBUG
                    Debug.LogWarning("事件" + key + "未注册");
#endif
                }
            }
        }

        /// <summary>
        /// 移除事件
        /// </summary>
        /// <param name="data"></param>
        public static void RemoveEvent(EventData data)
        {
            _nodeNav.TryGetValue(data.id, out var datas);
            datas?.Remove((data.key, data.index));

            _events.TryGetValue(data.key, out var arr);
            arr?.Remove(data.index);
        }

        /// <summary>
        /// 移除节点上的所有事件
        /// </summary>
        /// <param name="id"></param>
        public static void RemoveAllEvents(string id)
        {
            _nodeNav.TryGetValue(id, out var data);

            if (data != null)
            {
                foreach (var res in data)
                {
                    _events.TryGetValue(res.key, out var arr);

                    if (arr != null)
                    {
                        arr.Remove(res.index);
                    }
                }

                _nodeNav.Remove(id);
            }
        }
    }
}

2024-08-02

  1. 重构事件系统。

2024-07-29

  1. 修复 Bug，该 Bug 导致同节点只能添加一个事件。

2024-07-01

  1. 修复 Bug，该 Bug 导致无法移除节点上的所有事件。

2023-08-24

  1. 更新基本内容。
参考资料

更新于：2024年8月2日

C#

工具类

系统架构

Unity

评论