【SKFramework框架核心模块】3-4、事件模块

推荐阅读

• CSDN主页
• GitHub开源地址
• Unity3D插件分享
• QQ群：398291828
• 小红书
• 小破站

大家好，我是佛系工程师☆恬静的小魔龙☆，不定时更新Unity开发技巧，觉得有用记得一键三连哦。

一、前言

【Unity3D框架】SKFramework框架完全教程《全网最全》-专栏文章目录：
https://blog.csdn.net/q764424567/article/details/143926557

二、正文

2-1、介绍

事件模块主要指的是事件委托模块。

委托相比大家都不陌生，在C#中，委托是一种引用类型，它表示对方法的引用，即委托就是一种用来指向一个方法的引用类型变量。委托的声明类似于方法签名，关键字是delegate。
下面是一个委托的声明和使用的例子：

// 声明一个委托
public delegate void MyDelegate(string message);
 
public class Program
{
    static void Main(string[] args)
    {
        // 创建委托实例，绑定到具体的方法
        MyDelegate myDelegate = new MyDelegate(DisplayMessage);
 
        // 使用委托
        myDelegate("Hello, World!");
    }
 
    // 与委托具有相同签名的方法
    static void DisplayMessage(string message)
    {
        Console.WriteLine(message);
    }
}

委托简单理解就是先绑定事件，然后在合适的位置执行事件，最后将数据或者参数返回。

2-2、使用说明

SKFramework框架的事件模块，是将委托事件进行了封装，重载了方法，方便调用。

事件模块：订阅委托事件，11个重载方法：

事件模块：取消订阅委托事件，12个重载方法：

事件模块：执行事件：

接下来演示一下如何使用。

示例：

using UnityEngine;
using SK.Framework;
using SK.Framework.Events;
using System.Collections.Generic;

public class UseEvents : MonoBehaviour
{
    Events m_Event;
    Dictionary<string, List<string>> m_Dic;

    void Start()
    {
        m_Event = SKFramework.Module<Events>();

        // 订阅
        m_Event.Subscribe(100, () => { Debug.Log("执行100事件"); });

        m_Event.Subscribe(0, (value) => { ShowInfo((InfoDataEventArgs)value); });

        m_Event.Subscribe<string, string>(102, (value1, value2) => { ShowInfo(value1, value2); });
    }

    void ShowInfo(InfoDataEventArgs args)
    {
        Debug.Log(args.UserFun());
    }

    void ShowInfo(string info1, string info2)
    {
        Debug.Log(info1 + " " + info2);
    }



    void Update()
    {
        if (Input.GetKeyDown(KeyCode.W))
        {
            m_Event.Publish(100);
        }
        if (Input.GetKeyDown(KeyCode.E))
        {
            InfoDataEventArgs data = new InfoDataEventArgs();
            data.Info = "自定义的数据";
            m_Event.Publish(data);
        }
        if (Input.GetKeyDown(KeyCode.R))
        {
            m_Event.Publish(102, "传递的值1", "传递的值2");
        }
    }
}

public class InfoDataEventArgs : EventArgs
{
    public override int ID { get; }
    public override void OnInvoke() { }
    
    public string Info { get; set; }
    // 自定义函数
    public string UserFun()
    {
        return Info;
    }
}

执行结果：

说明：
1、单个委托事件，可以直接

订阅事件：
m_Event.Subscribe(100, () => { Debug.Log("执行100事件"); });
执行委托：
m_Event.Publish(100);

2、多参委托事件调用：

订阅事件：
m_Event.Subscribe<string, string>(102, (value1, value2) => { ShowInfo(value1, value2); });
执行委托：
m_Event.Publish(102, "传递的值1", "传递的值2");

3、自定义事件处理类

自定义事件处理类：
public class InfoDataEventArgs : EventArgs
{
    public override int ID { get; }
    public override void OnInvoke() { }
    
    public string Info { get; set; }
    // 自定义函数 可以实例化的时候写入数据
    public string UserFun()
    {
        return Info;
    }
}
订阅事件：
m_Event.Subscribe(0, (value) => { ShowInfo((InfoDataEventArgs)value); });

执行委托：
InfoDataEventArgs data = new InfoDataEventArgs();
data.Info = "自定义的数据";
m_Event.Publish(data);

2-3、实现及代码分析

委托事件存放在字典中：

private readonly Dictionary<int, List<Delegate>> m_Dic = new Dictionary<int, List<Delegate>>();

订阅事件：

public void Subscribe(int eventId, Action callback)
{
    SubscribeInternal(eventId, callback);
}
private void SubscribeInternal(int eventId, Delegate callback)
{
   if (!m_Dic.ContainsKey(eventId))
        m_Dic.Add(eventId, new List<Delegate>());
   m_Dic[eventId].Add(callback);
}

取消订阅：

        private bool UnsubscribeInternal(int eventId, Delegate callback)
        {
            if (m_Dic.TryGetValue(eventId, out List<Delegate> list))
            {
                list.Remove(callback);
                if (list.Count == 0)
                    m_Dic.Remove(eventId);
                return true;
            }
            return false;
        }

执行：

总体来说代码难度不大，简单又粗暴。

自定义事件处理类需要继承基类，然后重写自己的方法。

三、后记

如果觉得本篇文章有用别忘了点个关注，关注不迷路，持续分享更多Unity干货文章。

你的点赞就是对博主的支持，有问题记得留言：

博主主页有联系方式。

博主还有跟多宝藏文章等待你的发掘哦：