首页 > 其他分享 >事件总线的设计与实现

事件总线的设计与实现

时间:2024-08-25 19:03:39浏览次数:11  
标签:eventHandler 总线 事件 subscribers new 设计 type public

事件总线(在有些框架中也称时间聚合器,如Prism的EventAggregater)是订阅-发布模式的一种实现,类似观察者模式,相对于观察者模式,事件总线更灵活,它是一种集中处理事件的模式,允许不同组件之间通信,降低耦合度。
事件总线的三要素:事件源(事件的定义)、发布事件(触发事件)、订阅事件(事件的应答实现)。
实现事件总线,主要工作是事件基类、参数基类、事件自动注册的定义,基于需求场景的业务型事件,只需要按照预定义的规则增加上述三要素即可,大大降低业务复杂度,且可实现一对一、一对多,多对一,同步应答、异步应答等方式。
1、定义事件基类(抽象类)

    public abstract class MyEventBase
    {
        public string EventName { get; set; }
    }

2、事件参数的基类(抽象类)

    public abstract class MyEventArgs<T>:EventArgs
    {
        public T Argument { get; set; }
    }

3、事件的基类(无返回值的事件基类,因无返回值,可异步调用,也可同步调用,建议异步调用)

   public class MyEvent<T>: MyEventBase where T : EventArgs
   {
       protected static readonly object lockObject = new object();
       protected readonly List<Action<object, T>> subscribers = new List<Action<object, T>>();

       public void Subscribe(Action<object, T> eventHandler)
       {
           lock (lockObject)
           {
               if (!subscribers.Contains(eventHandler))
               {
                   subscribers.Add(eventHandler);
               }
           }
       }

       public void Unsubscribe(Action<object, T> eventHandler)
       {
           lock (lockObject)
           {
               if (subscribers.Contains(eventHandler))
               {
                   subscribers.Remove(eventHandler);
               }
           }
       }

       public virtual void Publish(object sender, T eventArgs)
       {
           lock (lockObject)
           {
               for (int i = 0; i < subscribers.Count; i++)
               {
                   subscribers[i](sender, eventArgs);
               }
           }
       }
   }

4、事件的基类(有返回值事件的基类,因需要获取返回值,一般采用同步方式调用)

    public class MyEventWithResult<T1, T2> : MyEventBase where T1 : EventArgs
    {
        protected static readonly object lockObject = new object();
        protected readonly List<Func<object, T1, T2>> subscribers = new List<Func<object, T1, T2>>();

        public void Subscribe(Func<object, T1, T2> eventHandler)
        {
            lock (lockObject)
            {
                if (!subscribers.Contains(eventHandler))
                {
                    subscribers.Add(eventHandler);
                }
            }
        }

        public void Unsubscribe(Func<object, T1, T2> eventHandler)
        {
            lock (lockObject)
            {
                if (subscribers.Contains(eventHandler))
                {
                    subscribers.Remove(eventHandler);
                }
            }
        }

        public virtual T2 Publish(object sender, T1 eventArgs)
        {
            T2 result = default;
            lock (lockObject)
            {
                for (int i = 0; i < subscribers.Count; i++)
                {
                    result = subscribers[i](sender, eventArgs);
                }
            }
            return result;
        }
    }

5、事件中心,负责自动装载事件

    public class MyEventAggregator
    {
        private static MyEventAggregator _default;
        private static readonly object _locker = new object();
        private readonly Dictionary<Type, MyEventBase> _eventAggregator = new Dictionary<Type, MyEventBase>();

        /// <summary>
        /// 默认事件总线实例,建议只使用此实例
        /// </summary>
        public static MyEventAggregator Default
        {
            get
            {
                if (_default == null)
                {
                    lock (_locker)
                    {
                        // 如果类的实例不存在则创建,否则直接返回
                        if (_default == null)
                        {
                            _default = new MyEventAggregator();
                        }
                    }
                }
                return _default;
            }
        }

        /// <summary>
        /// 构造函数,自动加载EventBase的派生类实现
        /// </summary>
        public MyEventAggregator()
        {
            Type type = typeof(MyEventBase);
            Assembly assembly = Assembly.GetAssembly(type);
            //注册时需排除的基类
            Type typeMyEvent = typeof(MyEvent<>);
            Type typeMyEventWithResult = typeof(MyEventWithResult<,>);

            List<Type> typeList2 = assembly.GetTypes()
                .Where(t => t != type && t!=typeAnalysisEvent && t != typeMyEventWithResult && type.IsAssignableFrom(t))
                .ToList();
            foreach (var item in typeList2)
            {
                MyEventBase eventBase = (MyEventBase)assembly.CreateInstance(item.FullName);
                _eventAggregator.Add(item, eventBase);
            }
        }

        /// <summary>
        /// 获取事件实例
        /// </summary>
        /// <typeparam name="TEvent">事件类型</typeparam>
        /// <returns></returns>
        public TEvent GetEvent<TEvent>() where TEvent : MyEventBase
        {
            return (TEvent)_eventAggregator[typeof(TEvent)];
        }

        /// <summary>
        /// 添加事件类型
        /// </summary>
        /// <typeparam name="TEvent"></typeparam>
        public void AddEvent<TEvent>() where TEvent : MyEventBase, new()
        {
            lock (_locker)
            {
                Type type = typeof(TEvent);
                if (!_eventAggregator.ContainsKey(type))
                {
                    _eventAggregator.Add(type, new TEvent());
                }
            }
        }

        /// <summary>
        /// 移除事件类型
        /// </summary>
        /// <typeparam name="TEvent"></typeparam>
        public void RemoveEvent<TEvent>() where TEvent : MyEventBase, new()
        {
            lock (_locker)
            {
                Type type = typeof(TEvent);
                if (_eventAggregator.ContainsKey(type))
                {
                    _eventAggregator.Remove(type);
                }
            }
        }
    }
}

6、具体事件的定义和调用示例
定义

    /// <summary>
    /// 添加日志 事件
    /// </summary>
    public class WriteLogEvent : MyEvent<WriteLogEventArgs>
    {
        public override void Publish(object sender, WriteLogEventArgs eventArgs)
        {
            for (int i = 0; i < subscribers.Count; i++)
            {
                var action = subscribers[i];
                Task.Run(() => action(sender, eventArgs));
            }
        }
    }

    public class WriteLogEventArgs : MyEventArgs<WriteLogEventArgs2> { };

    public class WriteLogEventArgs2
    {
        /// <summary>
        /// 日志内容
        /// </summary>
        public string Msg { get; set; }

        /// <summary>
        /// 操作类型
        /// </summary>
        public OperationType OperationType { get; set; }

        /// <summary>
        /// 备注
        /// </summary>
        public string Remark { get; set; }

        /// <summary>
        /// 目标类型
        /// </summary>
        public LogTargetType LogTargetType { get; set; }

        /// <summary>
        /// 目标值
        /// </summary>
        public string TargetValue { get; set; }
    }

发布事件

MyEventAggregator.Default.GetEvent<WriteLogEvent>().Publish(this, new WriteLogEventArgs
{
    Argument = new WriteLogEventArgs2
    {
        Msg = logMsg,
        OperationType = OperationType.Save,
        LogTargetType = LogTargetType.OriginalData,
        TargetValue = targetValue,
        Remark = _MPIComment
    }
});

订阅事件

MyEventAggregator.Default.GetEvent<WriteLogEvent>().Subscribe(WriteLogEventHandler);

private void WriteLogEventHandler(object sender, WriteLogEventArgs e)
{
    -----business logic
    -----
}

标签:eventHandler,总线,事件,subscribers,new,设计,type,public
From: https://www.cnblogs.com/kook2007/p/18379352

相关文章

  • SSM水果商城系统 毕业设计-附源码
    摘要网络购物作为一种全新的销售方式赢得了越来越多销售者的青睐,近年来销售额更是以连年翻番的惊人速度成倍增长.网络购物已经形成了自身特有的网络销售市场和全新的网络营销模式,也使网络营销渠道应运而生.同时,伴随着水果市场的不断扩大,水果行业内的竞争日趋激烈,网络营销......
  • 【Node】【4】事件循环和EventEmitter类
    事件循环事件驱动:node中程序的执行是由事件的发生和相应的事件处理器(eventHandler)来驱动的编程范式。程序监听并响应发生的事件。每个异步事件都生成一个事件观察者,在执行某个事件(主题)结束的时候则触发这个事件上的处理函数(观察者)。【让我瞅瞅什么时候开始执行,例如点击事......
  • 软件设计之MySQL(7)
    软件设计之MySQL(7)此篇应在JavaSE之后进行学习:路线图推荐:【Java学习路线-极速版】【Java架构师技术图谱】Navicat可以在软件管家下载``使用navicat连接mysql数据库创建数据库、表、转储sql文件,导入sql数据MySQL数据库入门到大牛,mysql安装到优化,百科全书级,全网天花......
  • MFC程序设计(一) MFC框架
    基本概念SDK:开发软件的套件WDK:开发驱动的套件当我们开发驱动时,两者版本需要一致MFC:MicrosoftFundationclass,即微软基础类库。是基于Win32SDK进行的封装的框架。MFC为我们提供了大量的WindowsSDK的代码及设计重用,因此我们并不需要像SDK一样对消息过程进行处理,而是只需......
  • 快看过来,毕业设计开题报告万能模板!
    我们给出了一个通用的开题报告模版,同时也填充了内容;大家可以自行根据自己的课题修改xxx学院毕业设计(论文)开题报告课题背景及意义随着高校教学体制和教育方式的改革与发展,高校校园建设面临了新的要求和挑战。大学校园交通系统规划与建设作为校区规划中不可缺少的一部分[1]......
  • 计算机毕业设计推荐- 基于Python的高校岗位招聘数据分析平台
    ......
  • Java行为型设计模式-访问者模式(含二叉树场景示例)
    1.访问者模式简介访问者模式(VisitorPattern)是一种行为型设计模式,其主要目的是将数据结构与数据操作解耦。用于将数据结构和在数据结构上的操作分离开来。‌这种模式允许在不修改数据结构的情况下,定义新的操作。2.访问者模式角色访问者模式的主要角色包括:2.1抽象访问......
  • 基于django+vue摄影网站的设计与实现【开题报告+程序+论文】计算机毕设
    本系统(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。系统程序文件列表开题报告内容研究背景随着互联网技术的飞速发展和普及,数字化摄影已成为大众生活的一部分,摄影作品的传播与分享方式也发生了深刻变革。传统的摄影展示与交易方式......
  • 基于Node.js+vue四川省非物质文化遗产之传统美术数字平台设计与实现(程序+论文+开题报
    本系统(程序+源码+数据库+调试部署+开发环境)带文档lw万字以上,文末可获取源码系统程序文件列表开题报告内容研究背景在全球化与现代化的浪潮中,非物质文化遗产作为民族文化的瑰宝,正面临着传承与保护的严峻挑战。四川省,作为中华文化的重要发源地之一,拥有丰富的非物质文化遗产......
  • 基于python+flask框架的基于云平台的展馆综合管理系统开发与设计(开题+程序+论文) 计算
    本系统(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。系统程序文件列表开题报告内容研究背景随着信息技术的飞速发展,云计算技术已成为推动各行业数字化转型的重要力量。在展览行业,传统的展馆管理模式面临着效率低下、信息共享不足、......