[CLR via C#]11. 事件

一、 设计要公开事件的类型

　　如果类型定义了事件成员，那么类型(或类型实例)就可以通知其他对象发生了一些特定的事情。

　　例如，Button类提供了一个名为Click的事件。应用程序中的一个或多个对象可能想接受这个事件的通知，以便在Button被单击之后采取某些操作。事件就是实现这种交互的类型成员。

/// <summary>/// 第一步：定义类型来容纳所有需要发送给事件接收者的附加信息/// </summary>internal sealed class NewMailEventArgs : EventArgs{     PRivate readonly String m_from, m_to, m_subject;     public NewMailEventArgs(String from, String to, String subject)    {        m_from = from; m_to = to; m_subject = subject;    }    /// <summary>    /// 邮件发件人    /// </summary>    public String From { get { return m_from; } }    /// <summary>    /// 邮件收件人    /// </summary>    public String To { get { return m_to; } }    /// <summary>    /// 邮件主题    /// </summary>    public String Subject { get { return m_subject; } }}//后续的步骤在MailManager类中进行internal class MailManager {}

第二步 ：定义事件成员

internal class MailManager {    // 第二步：定义事件成员    public event EventHandler<NewMailEventArgs> NewMail;    ......}

public delegate void Eventhandler<TEventArgs>(Object sender, TEventArgs e) where TEventArgs: EventArgs;

　　所以方法原型必须具有以下形式：

void MethodName(Object sender, TEventArgs e);

internal class MailManager{   ......    /// <summary>    /// 第三步：定义负责引发事件的方法来 通知事件的登记对象    /// 如果类是密封的，这个方法要声明为私有和非虚    /// </summary>    /// <param name="e"></param>    protected virtual void OnNewMail(NewMailEventArgs e)    {        // 处于线程安全考虑，现在将对委托字段的引用复制到一个临时字段中        EventHandler<NewMailEventArgs> temp = NewMail;         // 任何方法登记了对事件的关注，就通知它们        if (temp != null)        {            temp(this, e);        }    }    .....}

internal class MailManager {    ......    //  第四步：定义方法将输入转换为期望事件   public void SimulateNewMail(String from, String to, String subject) {       // 构造一个对象来容纳想传给通知接收者的消息      NewMailEventArgs e = new NewMailEventArgs(from, to, subject);       // 调用虚方法通知对象事件已发生      OnNewMail(e);   }    ......}

二、 编译器如何实现事件

　　我们仔细扒一扒事件是什么？它是如何工作的。

public event EventHandler<NewMailEventArgs> NewMail;

　　我们来看看发生了什么？

 // 1. 一个被初始化为null的私有委托字段  private EventHandler<NewMailEventArgs> NewMail= null;   //2. 一个公共add_Xxx方法(其中Xxx是事件名)  //允许方法登记对事件的关注  public void add_NewMail(EventHandler<NewMailEventArgs> value){    //通过循环对CompareExchange的调用    //可以以一种线程安全的方式向事件添加委托    EventHandler<NewMailEventArgs> handler2;    EventHandler<NewMailEventArgs> newMail = this.NewMail;    do    {        handler2 = newMail;        EventHandler<NewMailEventArgs> handler3 = (EventHandler<NewMailEventArgs>) Delegate.Combine(handler2, value);        newMail = Interlocked.CompareExchange<EventHandler<NewMailEventArgs>>(ref this.NewMail, handler3, handler2);    }    while (newMail != handler2);} //3. 一个公共remove_Xxx方法(其中Xxx是事件名)//允许方法注销对事件的关注public void remove_NewMail(EventHandler<NewMailEventArgs> value){    //通过循环对CompareExchange的调用    //可以以一种线程安全的方式向事件移除委托    EventHandler<NewMailEventArgs> handler2;    EventHandler<NewMailEventArgs> newMail = this.NewMail;    do    {        handler2 = newMail;        EventHandler<NewMailEventArgs> handler3 = (EventHandler<NewMailEventArgs>) Delegate.Remove(handler2, value);        newMail = Interlocked.CompareExchange<EventHandler<NewMailEventArgs>>(ref this.NewMail, handler3, handler2);    }    while (newMail != handler2);}

　　第一个构造是具有恰当委托类型的字段。该字段是对一个委托列表的头部的引用。事件发生时会通知这个列表中的委托。字段初始化为null，表示无监听者登记对该事件的关注。

internal sealed class Fax    {        /// <summary>        /// 将MailManager对象传给构造器        /// </summary>        /// <param name="mm"></param>        public Fax(MailManager mm)        {            // 构造EventHandler<NewMailEventArgs>委托的一个实例，            // 使它引用我们的FaxMsg回调方法            // 向MailManager的NewMail时间等级我们的回调方法            mm.NewMail += FaxMsg;        }         /// <summary>        /// 新邮件到达时，MailManager将调用这个方法        /// </summary>        /// <param name="sender">MailManager对象，便于回调</param>        /// <param name="e">NewMailEventArgs对象</param>        private void FaxMsg(Object sender, NewMailEventArgs e)        {            Console.WriteLine("Faxing mail message:");            Console.WriteLine("   From={0}, To={1}, Subject={2}",               e.From, e.To, e.Subject);        }         // 执行这个方法，Fax对象指向NewMail事件注销自己对它的关注，以后便不会接受通知        public void Unregister(MailManager mm)        {            // 向MailManagerde的NewMail事件注销自己对这个事件的关注            mm.NewMail -= FaxMsg;        }    }

　　在Fax构造器中，Fax对象使用C#的+=操作符登记它对MailManager的NewMail事件的关注。

mm.NewMail += FaxMsg;

　　因为C#编译器内建对事件的支持，所以会将+=操作符翻译成为以下代码来添加对事件的关注：

mm.add_NewMail (new EventHandler<NewMailEventArgs>(this.FaxMsg));

　　即使使用的编程语言不直接支持事件，也可以显示调用add访问器方法向事件登记一个委托。两者效果是相同的，后者只是源代码看起来没那么优美而已。两者最终都是用add访问器将委托添加到事件的委托列表中，从而完成委托向事件的登记。

　　在Unregister方法中，我们使用了"-="来向MailManagerde的NewMail事件注销自己对这个事件的关注，当C#编译器看到使用"-="操作符时向事件注销一个委托时，会生成对事件的remove方法的调用：

mm.remove_NewMail (new EventHandler<NewMailEventArgs>(this.FaxMsg));

　　和"+="一样，即使使用的编程语言不直接支持事件，也可以显示调用remove访问器方法向事件注销一个委托。remove方法为了向事件注销委托，需要扫描委托列表来寻找恰当的委托。如发现一个匹配，该委托会从事件的委托列表中删除。如果没发现匹配，那么不会报错，列表不会发生变化。

　　C#要求代码使用+=和-=操作符在列表中增删委托。

四、显式实现事件

　　System.Windows.Forms.Control类型定义了约70个事件。假如Control类型在实现事件时，是允许编译器隐式生成add和remove访问器方法以及委托字段，那么每个Control对象都会包含70个委托字段。由于大多数开发人员只关心少数几个事件，所以从Control派生类型创建的对象都会浪费大量内存。

　　目前。讨论C#编译器如何允许类的开发人员显式实现一个事件，使开发人员能够控制add和remove方法来操纵回调委托的方式。这里演示如何通过显式实现事件来高效率地实现一个提供大量事件的类。

　　为了高效率存储事件委托，公开了事件每个对象都要维护的一个集合(通常是一个字典)。这个集合将某种形式的事件标识作为键(key)。新对象构造时，这个集合是空白的。登记对一个事件的关注时，会在集合中查找事件的标识符。如果事件标识符已在其中，新委托就和这个事件的委托列表合并。如果事件标识符不再集合中，就添加事件标识符和委托。

　　对象需要引发一个事件时，会在集合中查找事件标识符。如果集合中没有找到事件标识符，表明还没有任何对象登记对这个事件的关注，所以没有任何委托需要回调。如果事件标识符在集合中，就调用它关联的委托列表。这个设计模式的实现是定义了事件那个类型的开发人员的责任；使用类型的开发人员不知道事件在内部是如何实现的。

　　下面展示了如何完成这个模式的。首先实现的是一个EventSet类，它代表一个集合，其中包含了事件以及