C# 一套事件系统,全局监听、发送、接收、移除事件

事件系统主要通过单例事件管理器:EventManager和事件参数:EventArgs(可以是任意类型),来进行事件的监听、发送、接收、移除。

分为以下模块:

  • IEventListener:事件监听者,由需要监听事件的对象继承;
  • IEventArgs,EventArgs,EventArgsExtend:事件参数;
  • EventManager:负责事件监听、派送、移除;
  • IEventHub,EventHub:封装事件监听、派送、移除功能实现的具体逻辑;

事件系统分为两部分:使用方法实现代码(说明讲解都在注释里):

一、使用方法:

使用时只需要使用EventManager、IEventListener、EventArgs即可:

/// <summary>
/// 事件Id
/// </summary>
public class EventId
{
    public const int Open = 100;
    public const int Close = 101;
    public const int Message = 102;
}

/// <summary>
/// 测试消息
/// </summary>
public class TestMsg
{
    public int MsgId;
    public string Msg;
}

public class ClassA
{
    public void DoTest()
    {
        // 发送 Open 事件,传递参数为string类型
        IEventArgs arg1 = EventArgs<string>.CreateEventArgs("打开");
        EventManager.Instance.Dispatch(EventId.Open, arg1);


        // 发送 Close 事件,传递参数为值类型:int
        IEventArgs arg2 = EventArgs<int>.CreateEventArgs(999);
        EventManager.Instance.Dispatch(EventId.Close, arg2);


        // 发送 Message 事件,传递参数为引用类型:class
        TestMsg value = new TestMsg()
        {
            MsgId = 888,
            Msg = "一条广告"
        };
        IEventArgs arg3 = EventArgs<TestMsg>.CreateEventArgs(value);
        EventManager.Instance.Dispatch(EventId.Message, arg3);
    }
}

// 继承IEventListener,接收事件
public class ClassB : IEventListener
{
    public void OnEnable()
    {
        // 监听事件
        EventManager.Instance.AddListener(EventId.Open, this);
        EventManager.Instance.AddListener(EventId.Close, this);
        EventManager.Instance.AddListener(EventId.Message, this);
    }

    public void OnDisable()
    {
        // 移除事件
        EventManager.Instance.RemoveListener(EventId.Open, this);
        EventManager.Instance.RemoveListener(EventId.Close, this);
        EventManager.Instance.RemoveListener(EventId.Message, this);
    }

    // 处理事件
    public void HandleEvent(int eventId, IEventArgs args)
    {
        switch (eventId)
        {
            case EventId.Open:
                string value1 = args.GetValue<string>(); // "打开"
                break;

            case EventId.Close:
                int value2 = args.GetValue<int>(); // 999
                break;

            case EventId.Message:
                TestMsg value3 = args.GetValue<TestMsg>();
                // value3.MsgId 888
                // value3.Msg "一条广告"
                break;

            default:
                break;
        }
    }
}
二、事件系统代码实现:

分为以下模块:

  • IEventListener:事件监听者,由需要监听事件的对象继承;
  • IEventArgs,EventArgs,EventArgsExtend:事件参数;
  • EventManager:负责事件监听、派送、移除;
  • IEventHub,EventHub:事件监听、派送、移除功能实现的具体逻辑;
IEventListener:事件监听者,由需要监听事件的对象继承;
/// <summary>
/// 事件监听者
/// </summary>
public interface IEventListener
{
    void HandleEvent(int eventId, IEventArgs args);
}
IEventArgs,EventArgs,EventArgsExtend:事件参数;
public interface IEventArgs
{
}
/// <summary>
/// 事件参数
/// 可以是值类型,也可以是引用类型
/// </summary>
/// <typeparam name="T"></typeparam>
public class EventArgs<T> : IEventArgs
{
    public T arg;

    /// <summary>
    /// 创建事件参数
    /// </summary>
    /// <param name="val"></param>
    /// <returns></returns>
    public static IEventArgs CreateEventArgs(T val)
    {
        return new EventArgs<T>(val);
    }

    private EventArgs(T arg)
    {
        this.arg = arg;
    }
}
/// <summary>
/// 事件参数扩展
/// </summary>
public static class EventArgsExtend
{
    /// <summary>
    /// 获取事件参数值
    /// </summary>
    /// <param name="args"></param>
    /// <typeparam name="T"></typeparam>
    /// <returns></returns>
    public static T GetValue<T>(this IEventArgs args)
    {
        T result = default(T);
        if (args is EventArgs<T>)
        {
            result = ((EventArgs<T>)args).arg;
        }
        return result;
    }
}
EventManager:负责事件监听、派送、移除;
/// <summary>
/// 单例事件管理器,负责事件监听、派送、移除
/// </summary>
public class EventManager
{
    public static EventManager Instance
    {
        get
        {
            if (_instance == null)
            {
                _instance = new EventManager();
            }

            return _instance;
        }
    }

    private static EventManager _instance;

    private IEventHub _eventHub;

    public EventManager()
    {
        this._eventHub = new EventHub();
    }

    /// <summary>
    /// 添加监听事件
    /// </summary>
    /// <param name="eventId"></param>
    /// <param name="listener"></param>
    public void AddListener(int eventId, IEventListener listener)
    {
        this._eventHub.AddListener(eventId, listener);
    }

    /// <summary>
    /// 发送事件
    /// </summary>
    /// <param name="eventId"></param>
    /// <param name="args">事件参数可通过 EventArgs.CreateEventArgs 创建</param>
    public void Dispatch(int eventId, IEventArgs args = null)
    {
        this._eventHub.Dispatch(eventId, args);
    }

    /// <summary>
    /// 移除监听事件
    /// </summary>
    /// <param name="eventId"></param>
    /// <param name="listener"></param>
    public void RemoveListener(int eventId, IEventListener listener)
    {
        this._eventHub.RemoveListener(eventId, listener);
    }
}
IEventHub,EventHub:封装事件监听、派送、移除功能实现的具体逻辑;
public interface IEventHub
{
    void AddListener(int eventId, IEventListener listener);

    void RemoveListener(int eventId, IEventListener listener);

    void Dispatch(int eventId, IEventArgs args);
}
using System.Collections.Generic;

public class EventHub : IEventHub
{
    private Dictionary<int, List<IEventListener>> _eventDic = new Dictionary<int, List<IEventListener>>();

    public void AddListener(int eventId, IEventListener listener)
    {
        if (this._eventDic == null)
        {
            return;
        }

        List<IEventListener> list = null;
        this._eventDic.TryGetValue(eventId, out list);
        if (list == null)
        {
            list = new List<IEventListener>();
            this._eventDic[eventId] = list;
        }
        list.Add(listener);
    }

    public void RemoveListener(int eventId, IEventListener listener)
    {
        if (this._eventDic == null)
        {
            return;
        }

        List<IEventListener> list = null;
        this._eventDic.TryGetValue(eventId, out list);
        if (list != null && list.Contains(listener))
        {
            list.Remove(listener);
        }
    }

    public void Dispatch(int eventId, IEventArgs args)
    {
        if (this._eventDic == null)
        {
            return;
        }

        List<IEventListener> list = null;
        this._eventDic.TryGetValue(eventId, out list);
        if (list == null || list.Count <= 0)
        {
            return;
        }

        for (int i = 0; i < list.Count; i++)
        {
            IEventListener eventListener = list[i];
            if (eventListener != null)
            {
                eventListener.HandleEvent(eventId, args);
            }
        }
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,069评论 4 358
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,212评论 1 287
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 105,912评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,424评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,741评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,194评论 1 206
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,553评论 2 307
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,289评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,923评论 1 237
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,251评论 2 240
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,775评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,144评论 2 249
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,698评论 3 228
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,936评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,658评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,214评论 2 267
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,159评论 2 258