Unity中使用委托/事件实现GameObject之间的通信

为什么GameObject之间需要通信？

  游戏开放中我经常遇到这样的问题，游戏中发生一个事件，我们如何把这个事件通知给其他的游戏物体，比如游戏中发生了爆炸，我们需要在一定范围内的GameObject都能感知到这一事件。
  有一种方法是将对该事件感兴趣的GameObject当做成员变量保存在触发该事件的GameObject的脚本组件里，那么我们把发生事件的GameObject当作Subject(被观察者)，把对该事件感兴趣的GameObject当作Observer(观察者)。但这样做有个明显的缺点一旦增加一个Observer就需要修改Subject的代码，如果Observer移除了，还必须从Subject中移除这个成员变量。
  所以我们引入c#内置的一个非常棒的事件/委托机制，这可以让我们非常方便的使用观察者模式。

如果你还不了解观察者模式或事件/委托机制，请查阅相关资料。

常见的委托类型

// 该委托不传任何参数
public delegate void CallFunc();
// 该委托会传入发生事件的GameObject，即sender
public delegate void CallFuncO(GameObject sender);
// 该委托会传入发生事件的GameObject，即sender。和一个变长参数列表
public delegate void CallFuncOP(GameObject sender, EventArgs args);

下面我将使用三种类型的委托实现游戏中简单的事件机制。

c#提供的一种标准委托类型

//标准委托类型
public delegate void EventHandler(object sender, EventArgs e);
//带泛型的委托类型
public delegate void EventHandler<TEventArgs>(object sender, TEventArgs e);

第二个参数是从EventArgs派生出的类型，用来保存事件的内容。

实现简单的事件机制

• 创建GameEventArgs类，它继承EventArgs

public class GameEventArgs : EventArgs {
    /// <summary>
    /// 消息内容字典
    /// key为消息内容的某个字段，value为字段的内容
    /// </summary>
    private Dictionary<string, object> _messageDic;
    public Dictionary<string, object> messageDic
    {
        get { return _messageDic; }
    }

    /// <summary>
    /// 构造函数
    /// </summary>
    public GameEventArgs()
    {
        _messageDic = new Dictionary<string, object>();
    }
}

• ** 创建EventManager类，用于注册和发送事件，仅仅实现了注册和发送方法

/// <summary>
/// 消息处理委托
/// </summary>
/// <param name="obj"></param>
/// <param name="args"></param>
public delegate void onMessageArrived(object obj,GameEventArgs args);

/// <summary>
/// 消息管理类
/// </summary>
public class EventManager{

    /// <summary>
    /// 单例消息管理
    /// </summary>
    private static EventManager _instance;
    public static EventManager instance
    {
        get
        {
            if(_instance == null)
            {
                _instance = new EventManager();
            }
            return _instance;
        }
    }

    /// <summary>
    /// 消息字典，key为消息名称，onMessageArrived为处理消息的委托
    /// </summary>
    private Dictionary<string, onMessageArrived> eventListeners; 

    private EventManager()
    {
        eventListeners = new Dictionary<string, onMessageArrived>();
    }

    /// <summary>
    /// 注册事件
    /// </summary>
    /// <param name="key">事件名</param>
    /// <param name="listener">事件处理委托</param>
    public void addEventListener(string key, onMessageArrived listener)
    {
        if(eventListeners.ContainsKey(key))
        {
            return;
        }
        eventListeners.Add(key, listener);
    }

    /// <summary>
    /// 事件分发
    /// </summary>
    /// <param name="key">事件名</param>
    /// <param name="obj">发送者</param>
    /// <param name="args">发送内容</param>
    public void dispatchEvent(string key, Object obj, GameEventArgs args)
    {
        if(eventListeners.ContainsKey(key))
        {
            eventListeners[key](obj, args);
        }
    }
}

• 一个简单的示例
  在场景中创建两个GameObject，分别为cube和sphere,如下图：
  
  分别为cube和sphere添加脚本组件Cube.cs和Sphere.cs.

public class Cube : MonoBehaviour {

    private Sequence mySequence;

    // Use this for initialization
    void Start () {
        mySequence = DOTween.Sequence();
        mySequence.Append(gameObject.transform.DOMoveX(5, 2, false).SetRelative());
        mySequence.OnComplete(new TweenCallback(() =>
        {
            GameEventArgs eventArgs = new GameEventArgs();
            eventArgs.messageDic.Add("jumpTimes", 5);
            EventManager.instance.dispatchEvent("jump", this, eventArgs);
        }));
        mySequence.Pause();

        StartCoroutine(move());
    }

    IEnumerator move()
    {
        yield return new WaitForSeconds(2.0f);
        mySequence.Play();
    }
}

public class Sphere : MonoBehaviour {

    // Use this for initialization
    void Start () {
        EventManager.instance.addEventListener("jump", new onMessageArrived(jump));
    }

    private void jump(object obj, GameEventArgs args)
    {
        if(args.messageDic.ContainsKey("jumpTimes"))
        {
            gameObject.transform.DOJump(new Vector3(0, 3, 0), 1, Convert.ToInt32(args.messageDic["jumpTimes"]), 2).SetRelative();
        }
    }
}

这两段代码很简单，游戏物体cube移动一段距离后发出名称为”jump”的事件，游戏物体Sphere注册了”jump”事件，当Sphere收到事件后，执行jump动作。