C#委托/事件在Unity中的使用

C# delegate/event 在Unity中的使用

---

写在之前：在此对于delegate / event 的需求引入和具体含义 不再细说，对于delegate （委托）和 event （事件）不是很明白的朋友建议先看这里 ：C#委托/事件基础 （传送门）

---

好了，本节主要说一下，delegate /event 怎么在Unity中使用：
委托应该放在哪个部分？事件应该放在哪个部分？怎么注册/订阅?
不是很清楚的朋友请往下看：

---

说明

我们先了解一下Observer设计模式，Observer设计模式中主要包括如下两类对象：

Subject：被观察者，它往往包含着观察者所感兴趣的内容。

Observer：观察者，观察Subject，(当Subject中的某件事发生后，会告知Observer，而)Observer会采取相应行动。

---

实例

以 YouTube 订阅事件为例：

Subject：其内包含 其他对象 所感兴趣的内容。
发生顺序为：

Part1、订阅要完成的功能是：将新的视频通告给每一个订阅者
–> Subject 声明事件委托（）

public class YouToberA : MonoBehaviour{
    // 声明 委托类型
    public delegate void WorkDoneEventHandler();
    // 相当于实例化一个WorkDownEventHander委托
    public event WorkDoneEventHandler WorkDone;
}

---

Part2、这一步是在观众（Observer）的脚本中完成的。毕竟是我订阅（取消订阅）你，我有主动权

观众（Observer） 告诉 油管主（Subject） 我对你的视频感兴趣（Subscribe订阅、注册） –> 该观众将自己 加入到 对方通知列表中

public class ObserverA : MonoBehaviour {

    // need get a reference from the inspector
    public YouToberA Pews; 

    void Awake(){
        Debug.Log ("I am interested in the video");
        if(Pews != null)
            // 如果有订阅对象的话，添加自己方法（TellMe）进入列表
            Pews.WorkDone += TellMe;
    }

---

Part3、 事件触发：油管主做好了视频。 委托调用：向所有订阅者发送通知。(调用委托)

如果有人订阅，那么就发送通知给他（Tell him），如果没有，就不发送。

public class YouToberA : MonoBehaviour {

    public delegate void WorkDoneEventHandler();
    public event WorkDoneEventHandler WorkDone;

    void Start () {
        Work();
    }

    public void Work(){
        Debug.Log ("I am working.");

        for(int cnt = 0; cnt < 5;cnt++){
            Debug.Log ("Work done!");
            // 将事件转化为委托，调用委托
            WorkDoneEventHandler handler = WorkDone;
            // 如果委托清单不为空，则执行委托
            if (handler != null)
                handler ();
        }
    }
}

---

observer：观察者，观察Subject，(当Subject中的某件事发生后，会告知Observer，而)Observer会采取相应行动。
实质上 括号内事情是在 Subject 中完成的，Observer 中只包含要做的事情。

包含内容：

public class ObserverA : MonoBehaviour {

    // need get a reference from the inspector
    public YouToberA Pews; 
    void Awake(){
        Debug.Log ("I am interested in the video");
        if(Pews != null)
            Pews.WorkDone += TellMe;
    }

    private void TellMe(){
        // 委托回调，接受到信息
        Debug.Log ("I have received the new video notify");
        // do something
    }
}

---

以上版本为简化版，下面给出实际代码，还有实测结果：

public class YouToberA : MonoBehaviour {

    public delegate void WorkDoneEventHandler();
    public event WorkDoneEventHandler WorkDone;

    public float workTime = 5f; // 工作时间
    //测试委托调用的即时性。

    void Start () {
        StartCoroutine ("Work");
    }

    public IEnumerator Work(){
        Debug.Log ("I am working.");
        for(int cnt = 0; cnt < 5;cnt++){
            // 等待 5 秒
            yield return new WaitForSeconds (workTime);
            // 任务完成
            Debug.Log ("Work done!");
            // 事件回调执行。（相当于发送信息）
            WorkDoneEventHandler handler = WorkDone;
            if (handler != null)
                handler ();
        }
    }
}

---

public class ObserverA : MonoBehaviour {

    // need get a reference from the inspector
    public YouToberA Pews; 
    void Awake(){
        Debug.Log ("I am interested in the video");
        if(Pews != null)
            Pews.WorkDone += TellMe;
        // 开启协程，测试 取消订阅效果
        StartCoroutine ("Leave");
    }

    void OnDestroy(){
        Debug.Log("I lose my account");
        // 取消订阅，关闭协程
        if(Pews != null)
            Pews.WorkDone -= TellMe;
        StopCoroutine ("Leave");
    }

    private void TellMe(){
        Debug.Log ("I have received the new video notify");
    }

    // 测试 取消委托后 时间的处理
    private IEnumerator Leave(){
        yield return new WaitForSeconds (3f);
        Debug.Log ("I am leaving");
        yield return new WaitForSeconds (4f);
        Debug.Log ("bye");
        Destroy (gameObject);
    }
}

实测结果：

说明：首先进行 Observer订阅，然后Subject 工作，然后 Subject 完成，事件触发，Observer立刻收到通知。之后Observer 销毁，之后Subject完成事件时，不再执行委托。

---

总结

这次主要阐述了委托和事件的基本实现与使用情况，只涉及简单的委托（无参数，无返回值），委托中更复杂的情况还未涉及，有机会的话再深入研究吧。