当前位置: 首页 > article >正文

Unity EventCenter 消息中心的设计与实现

在开发过程中,想要传递信号和数据,就得在不同模块之间实现通信。直接通过单例调用虽然简单,但会导致代码高度耦合,难以维护。消息中心提供了一种松耦合的通信方式:发布者不需要知道谁接收事件,接收者不需要知道事件来自哪里,由此减少模块间的直接依赖,便于扩展和维护。

架构

%% EventCenter 架构图
graph TDsubgraph 事件中心核心A[EventCenter] --> B[ConcurrentDictionary eventKey:callback]endsubgraph 调用接口A --> E[添加监听 AddListener]A --> F[移除监听 RemoveListener]A --> G[同步触发 SyncBroadcast]A --> H[异步触发 Broadcast]endsubgraph 线程管理G -->|立即执行| J[当前线程]H -->|主线程队列延迟| K[主线程]endsubgraph 异常处理G --> L[Try-Catch块]H --> LL --> M[打印错误日志]M --> N[继续触发剩余回调]end

数据结构

我们需要一个数据结构来存储eventKey与callback的映射关系,可以使用字典。

如果使用Dictionary,当多个线程同时注册或触发事件,可能导致数据异常,因此我们可以使用ConcurrentDictionary,它是门为高并发场景设计的线程安全集合,内置原子操作,无需手动加锁。

ConcurrentDictionary 提供以下方法:

bool TryAdd(TKey key, TValue value);
bool TryRemove(TKey key, out TValue value);
bool TryGetValue(TKey key, out TValue value);
bool ContainsKey(TKey key);

思考一下,可以使用 ConcurrentDictionary<string,delegate>存储eventKey与callback的映射,但很快便发现,这样一个key只能对应一个回调,不能满足多个模块监听一个事件的应用场景。

于是我们尝试 ConcurrentDictionary<string,List<delegate>>,但是ConcurrentDictionary只能保证获取到 List<T> 的过程是安全的,修改 List<T> 仍然会存在线程不安全的问题。

假设有两个线程同时执行这段代码:

if (!eventDic.ContainsKey("Attack")) 
{ eventDic["Attack"] = new List<Delegate>(); eventDic["Attack"].Add(callback); 
}
时间线程1线程2
t1执行步骤1(判断"Attack"不存在)-
t2-执行步骤1(同样判断"Attack"不存在)
t3执行步骤2(创建新List)-
t4-执行步骤2(再次创建新List,覆盖线程1创建的List)
t5执行步骤3(向被覆盖的List添加handler1)-
t6-执行步骤3(向新List添加handler2)

可以看到线程2覆盖了线程1创建的List,这可能会导致数据错误。

我们可以尝试使用ConcurrentDictionary<string,ConcurrentDictionary<Delegate,bool>>,嵌套的内层字典可以存储多个Delegate,并且修改操作都是线程安全的,对于内存字典的值,我们是用不上的,可以使用字节数最小的bool类型来占位。

广播

在广播时,我们遍历存储当前key所有委托的内层字典,并依次执行其回调函数。

因为我们不需要回调函数的返回值,所以我们把这些方法委托都从基类Delegate转换成无返回值类型的Action委托。

回调函数无参数:

public static void SyncBroadcast(string eventKey)
{if (eventDic.TryGetValue(eventKey, out ConcurrentDictionary<Delegate, bool> callbackList)){foreach (var callback in callbackList.Keys){(callback as Action)?.Invoke();}}
}

回调函数带参数,使用泛型实现:

一般来说,三个参数就可以覆盖绝大多数的使用场景,所以我们只实现0~3个参数的方法。

public static void SyncBroadcast<T>(string eventKey, T data)
{if (eventDic.TryGetValue(eventKey, out ConcurrentDictionary<Delegate, bool> callbackList)){foreach (var callback in callbackList.Keys){(callback as Action<T>)?.Invoke(data);}}
}

错误处理

如果某个回调抛出异常,会中断后续回调的执行,还需要增加 try-catch 包裹回调执行部分。

Broadcast与SyncBroadcast

对于SyncBroadcast,Invoke会在调用SyncBroadcast的线程执行。

但很多时候,我们需要在Unity主线程执行回调函数,可以使LoomManager.QueueOnMainThread方法把回调函数传给主线程执行。于是我们可以这样包装一下:

public static void Broadcast(string eventKey)
{LoomManager.QueueOnMainThread(() => SyncBroadcast(eventKey));
}

代码

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using UnityEngine;public static class EventCenter
{private static string TAG = "[EventCenter]";private static readonly ConcurrentDictionary<string, ConcurrentDictionary<Delegate, bool>>eventDic = new ConcurrentDictionary<string, ConcurrentDictionary<Delegate, bool>>();// 添加事件监听public static void AddListener(string eventKey, Action callback){if (!eventDic.ContainsKey(eventKey)){eventDic[eventKey] = new ConcurrentDictionary<Delegate, bool>();}eventDic[eventKey].TryAdd(callback, false);}#region 有参public static void AddListener<T>(string eventKey, Action<T> callback){if (!eventDic.ContainsKey(eventKey)){eventDic[eventKey] = new ConcurrentDictionary<Delegate, bool>();}eventDic[eventKey].TryAdd(callback, false);}public static void AddListener<T,U>(string eventKey, Action<T,U> callback){if (!eventDic.ContainsKey(eventKey)){eventDic[eventKey] = new ConcurrentDictionary<Delegate, bool>();}eventDic[eventKey].TryAdd(callback, false);}public static void AddListener<T, U, V>(string eventKey, Action<T, U, V> callback){if (!eventDic.ContainsKey(eventKey)){eventDic[eventKey] = new ConcurrentDictionary<Delegate, bool>();}eventDic[eventKey].TryAdd(callback, false);}#endregion// 移除事件监听public static void RemoveListener(string eventKey, Action callback){if(eventDic.TryGetValue(eventKey,out ConcurrentDictionary<Delegate,bool> callbackList)){if (callbackList.ContainsKey(callback))callbackList.TryRemove(callback, out bool result);}}// 移除全部事件监听public static void Clear() => eventDic.Clear();#region 有参public static void RemoveListener<T>(string eventKey, Action<T> callback){if (eventDic.TryGetValue(eventKey, out ConcurrentDictionary<Delegate, bool> callbackList)){if (callbackList.ContainsKey(callback))callbackList.TryRemove(callback, out bool result);}}public static void RemoveListener<T, U>(string eventKey, Action<T, U> callback){if(eventDic.TryGetValue(eventKey,out ConcurrentDictionary<Delegate,bool> callbackList)){if (callbackList.ContainsKey(callback))callbackList.TryRemove(callback, out bool result);}}public static void RemoveListener<T, U, V>(string eventKey, Action<T, U, V> callback){if (eventDic.TryGetValue(eventKey, out ConcurrentDictionary<Delegate, bool> callbackList)){if (callbackList.ContainsKey(callback))callbackList.TryRemove(callback, out bool result);}}#endregion// 立即触发事件public static void SyncBroadcast(string eventKey){if (eventDic.TryGetValue(eventKey, out ConcurrentDictionary<Delegate, bool> callbackList)){foreach (var callback in callbackList.Keys){try{(callback as Action)?.Invoke();}catch(Exception ex){Debug.LogError(TAG + $"Event:{eventKey} Callback:{callback.Method.Name} Failed: {ex.Message}");}}}}#region 有参public static void SyncBroadcast<T>(string eventKey, T data){if (eventDic.TryGetValue(eventKey, out ConcurrentDictionary<Delegate, bool> callbackList)){foreach (var callback in callbackList.Keys){try{(callback as Action<T>)?.Invoke(data);}catch (Exception ex){Debug.LogError(TAG + $"Event:{eventKey} Callback:{callback.Method.Name} Failed: {ex.Message}");}}}}public static void SyncBroadcast<T, U>(string eventKey, T dataT, U dataU){if (eventDic.TryGetValue(eventKey, out ConcurrentDictionary<Delegate, bool> callbackList)){foreach (var callback in callbackList.Keys){try{(callback as Action<T, U>)?.Invoke(dataT, dataU);}catch (Exception ex){Debug.LogError(TAG + $"Event:{eventKey} Callback:{callback.Method.Name} Failed: {ex.Message}");}}}}public static void SyncBroadcast<T, U, V>(string eventKey, T dataT, U dataU, V dataV){if (eventDic.TryGetValue(eventKey, out ConcurrentDictionary<Delegate, bool> callbackList)){foreach (var callback in callbackList.Keys){try{(callback as Action<T, U, V>)?.Invoke(dataT, dataU, dataV);}catch (Exception ex){Debug.LogError(TAG + $"Event:{eventKey} Callback:{callback.Method.Name} Failed: {ex.Message}");}}}}#endregion// 在主线程触发事件public static void Broadcast(string eventKey){LoomManager.QueueOnMainThread(() => SyncBroadcast(eventKey));}#region 有参public static void Broadcast<T>(string eventKey, T data){LoomManager.QueueOnMainThread(() => SyncBroadcast(eventKey, data));}public static void Broadcast<T, U>(string eventKey, T dataT, U dataU){LoomManager.QueueOnMainThread(() => SyncBroadcast(eventKey, dataT, dataU));}public static void Broadcast<T, U, V>(string eventKey, T dataT, U dataU, V dataV){LoomManager.QueueOnMainThread(() => SyncBroadcast(eventKey, dataT, dataU, dataV));}#endregion
}
http://www.lryc.cn/news/2384992.html

相关文章:

  • 瑞萨单片机笔记
  • 300. 最长递增子序列【 力扣(LeetCode) 】
  • MySQL远程连接10060错误:防火墙端口设置指南
  • 使用 OpenCV 实现 ArUco 码识别与坐标轴绘制
  • 2024CCPC辽宁省赛 个人补题 ABCEGJL
  • #6 百日计划第六天 java全栈学习
  • AOP的代理模式
  • 解决leetcode第3548题.等和矩阵分割II
  • 深入解析自然语言处理中的语言转换方法
  • redis 进行缓存实战-18
  • JFace中MVC的表的单元格编辑功能的实现
  • 在 Excel xll 自动注册操作 中使用东方仙盟软件2————仙盟创梦IDE
  • canal实现mysql数据同步
  • 解决 MySQL 表结构修改中锁定异常的全链路实战指南:从表结构设计到版本调优
  • 动态规划应用场景 + 代表题目清单(模板加上套路加上题单)
  • 易境通专线散拼系统:全方位支持多种专线物流业务!
  • nvm版本管理下pnpm 安装失败问题解决
  • C++高频面试考点 -- 智能指针
  • 06 如何定义方法,掌握有参无参,有无返回值,调用数组作为参数的方法,方法的重载
  • 使用vscode MSVC CMake进行C++开发和Debug
  • C# AutoMapper对象映射详解
  • Keil5 MDK LPC1768 RT-Thread KSZ8041NL uIP1.3.1实现UDP网络通讯(服务端接收并发数据)
  • 提升开发运维效率:原力棱镜游戏公司的 Amazon Q Developer CLI 实践
  • 20250523-BUG-E1696:无法打开元数据文件“platform.winmd(已解决)
  • 职业规划:动态迭代的系统化路径
  • redisson-spring-boot-starter 版本选择
  • Docker run -v 的 rw 和 ro 模式_docker ro
  • CentOS相关操作hub(更新中)
  • @Column 注解属性详解
  • 基于 ESP32 与 AWS 全托管服务的 IoT 架构:MQTT + WebSocket 实现设备-云-APP 高效互联