【GFFrameWork】事件系统

前言

游戏开发中抛事件，收事件也是比较常用的解耦方式，我所理解的设计模式旁观者模式有类似的原理，所以事件系统在一个框架中还是蛮重要的一块，本生事件系统不算一个大系统，代码量不多，主要是思路就是注册监听。

代码

EventManager

//-------------------------------------------
// Copyright © Aladdin. All rights reserved.
// Homepage: http://dingxiaowei.cn/
// Author: Aladdin
// Time: 2019/3/22 11:02:40
//-------------------------------------------

using GF.Debug;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;

namespace GF.EventSystem
{
    /// <summary>
    /// 消息分发器
    /// </summary>
    public class EventManager
    {
        private static EventManager instance;
        public static EventManager Instance
        {
            get
            {
                if (null == instance)
                    instance = new EventManager();
                return instance;
            }
            set
            {
                instance = value;
            }
        }
        /// <summary>
        /// 委托事件
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sender"></param>
        /// <param name="evt"></param>
        public delegate void EventHandler<T>(object sender, T evt);

        /// <summary>
        /// 注册事件字典
        /// </summary>
        public Dictionary<Type, List<object>> handlers = new Dictionary<Type, List<object>>();

        /// <summary>
        /// 注册事件
        /// </summary>
        /// <typeparam name="T">Class类型</typeparam>
        /// <param name="handler">函数</param>
        public void Register<T>(EventHandler<T> handler)
        {
            Debugger.Log("注册事件:" + handler.Method.Name);
            Register(typeof(T), handler);
        }

        private void Register<T>(Type EventType, EventHandler<T> handler)
        {
            if (!handlers.ContainsKey(EventType))
            {
                handlers.Add(EventType, new List<object>());
            }
            if (!handlers[EventType].Contains(handler))
            {
                handlers[EventType].Add(handler);
            }
        }

        /// <summary>
        /// 分发事件
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sender"></param>
        /// <param name="evt"></param>
        public void Publish<T>(object sender, T evt)
        {
            subscribe(null, typeof(T), evt);
        }

        /// <summary>
        /// 发送通知事件
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="sender"></param>
        /// <param name="EventType"></param>
        /// <param name="evt"></param>
        private void publish<T>(object sender, Type EventType, T evt)
        {
            if (handlers.ContainsKey(EventType))
            {
                Debugger.Log("public event key:" + typeof(T));
                //移除所有的无效事件
                handlers[EventType].RemoveAll(delegate (object handler) { return handler == null; });

                for (int i = 0; i < handlers[EventType].Count; i++)
                {
                    object handler = handlers[EventType][i];
                    MethodInfo method = handler.GetType().GetMethod("Invoke");
                    method.Invoke(handler, new object[] { sender, evt });
                }
            }
            else
            {
                Debugger.Log(string.Format("<color=red>未注册的Key:{0}</color>", EventType));
            }
        }


        /// <summary>
        /// 注销事件
        /// </summary>
        /// <typeparam name="T">类型</typeparam>
        /// <param name="handler">注册函数名</param>
        public void UnRegister<T>(EventHandler<T> handler)
        {
            UnRegister(typeof(T), handler);
        }

        private void UnRegister<T>(Type EventType, EventHandler<T> handler)
        {
            if (handlers.ContainsKey(EventType))
            {
                handlers[EventType].Remove(handler);
                Debugger.Log("Remove Event:" + handler);

                if (0 == handlers[EventType].Count)//注册事件为空时，移除字典Key
                {
                    handlers.Remove(EventType);
                }
            }
        }

        /// <summary>
        /// 清空注册事件
        /// </summary>
        public void Clear()
        {
            handlers.Clear();
        }
    }
}

使用

监听消息

EventManager.Instance.Register<FishRoundData>(onFrameData);

取消监听

EventManager.Instance.UnRegister<FishRoundData>(onFrameData);

监听消息回调

private void onFrameData(object sender, FishRoundData data)
{

}

分发消息

EventManager.Instance.Publish<FishRoundData>(this, roundData.Value);

改进

我们可以将要监听的事件结构抽象一下，然后每新增一个消息就直接继承这个基类，这样我们监听消息回调就是一个统一的方法，然后强转data变成自定义的事件结构。

事件基类 GFEventArgs

/// <summary>
  /// 游戏框架中包含事件数据的类的基类。
  /// </summary>
  public abstract class GFEventArgs : EventArgs
  {
      /// <summary>
      /// 初始化游戏框架中包含事件数据的类的新实例。
      /// </summary>
      public GFEventArgs()
      {

      }
  }

游戏事件基类

/// <summary>
    /// 游戏逻辑事件基类。
    /// </summary>
    public abstract class GameEventArgs : GFEventArgs
    {

    }

EventManager

internal sealed class EventManager1
{
    private readonly List<GameEventArgs> m_EventPool;

    public EventManager1()
    {
        m_EventPool = new List<GameEventArgs>();
    }

    public bool Check(int id, EventHandler<GameEventArgs> handler)
    {
        //检查事件
    }

    public void Subscribe(int id, EventHandler<GameEventArgs> handler)
    {
        //订阅消息
    }

    public void Unsubscribe(int id, EventHandler<GameEventArgs> handler)
    {
        //取消订阅
    }

    public void Fire(object sender, GameEventArgs e)
    {
        //放入事件响应队列
    }

    public void FireNow(object sender, GameEventArgs e)
    {
        //立刻响应
    }
}

使用

Event.Subscribe(OpenUIFormSuccessEventArgs.EventId, OnOpenUIFormSuccess);

private void OnOpenUIFormSuccess(object sender, GameEventArgs e)
{
    OpenUIFormSuccessEventArgs ne = (OpenUIFormSuccessEventArgs)e;
    // 判断userData是否为自己
    if (ne.UserData != this)
    {
        return;
    }
    Log.Debug("UI_Menu：恭喜你，成功地召唤了我。");
}

GFFramework地址

https://github.com/dingxiaowei/GFFrameWork

更多教程

http://dingxiaowei.cn/

赏

努力赚奶粉钱

支付宝

微信