C#之事件

事件：定義了事件成員的類允許通知其他其他對象發生了特定的事情。具體的說，定義了事件成員的類能提供以下功能

1.方法能登記它對事件的關注

2.方法能注銷它對事件的關注

3.事件發生時，登記了的方法將收到通知

類型之所以能提供事件通知功能，是因為類型維護了一個已登記方法的列表。事件發生后，類型將通知列表中所有已登記的方法。

事件是以委托為基礎。委托是調用回調方法的一種類型安全的方式。對象憑借回調方法接收他們訂閱的通知。

 

假如有一下場景：要設計一個電子郵件程序。當有新的郵件的到達時，用戶希望做些一別的操作，例如轉發給其他人或其他想實現的功能。事件在其中起到的就是一個通知的作用，告訴其他對象有新的郵件到達了，可以做XXX事情了。

下面使用事件實現這個功能

1.定義一個附加信息類，用來通知接收者發生了什么。

 /// <summary>
    /// 事件附加消息
    /// </summary>
    public 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;
        }
        // 發件人
        public string From { get{return m_from;} }
        // 接收人
        public string To { get{return m_to;} }
        // 主題
        public string Subject{get{return m_subject;}}
    }

附加信息類繼承了EventArgs，這個基類只定義了一個空的信息，在沒有附加信息時可直接使用EventArgs.Empty。EventArgs類的源代碼

namespace System
{
    //
    // Summary:
    //     Represents the base class for classes that contain event data, and provides a
    //     value to use for events that do not include event data.
    public class EventArgs
    {
        //
        // Summary:
        //     Provides a value to use with events that do not have event data.
        public static readonly EventArgs Empty;

        //
        // Summary:
        //     Initializes a new instance of the System.EventArgs class.
        public EventArgs();
    }
}

 

2.定義事件成員

事件成員使用C#關鍵字event定義。每個事件成員都要指定以下內容：可訪問標識符public（因為只有publi才能使其他對象訪問），委托類型以及名稱。

 public class MailManager{
        // 定義事件成員
        public event EventHandler<NewMailEventArgs> NewMail;
       
    }

它的類型是EventHandler<NewMailEventArgs> 這意味着事件通知的所有接收者都必須有一個和這個類型匹配的回調方法。System.EventHandler的委托定義類型如下：

namespace System
{
    //
    // Summary:
    //     Represents the method that will handle an event when the event provides data.
    //
    // Parameters:
    //   sender:
    //     The source of the event.
    //
    //   e:
    //     An object that contains the event data.
    //
    // Type parameters:
    //   TEventArgs:
    //     The type of the event data generated by the event.
    public delegate void EventHandler<TEventArgs>(object sender, TEventArgs e);
}

所以接收者必須提供的方法必須是一下形式：

void MethodName(Object sender,NewMailEventArgs e);

3. 定義負責引發事件的方法來通知事件的登記對象

    public class MailManager{
        // 定義事件成員
        public event EventHandler<NewMailEventArgs> NewMail;
        // 定義負責引發事件的方法來通知已登記的對象
        protected virtual void OnNewMail(NewMailEventArgs e){
            // 將字段復制到一個臨時變量，避免多線程情況中這個成員被移除
            EventHandler<NewMailEventArgs> temp=Volatile.Read(ref NewMail);
            if(temp!=null) temp(this,e);
        }

        // 接受附加信息並調用引發事件的方法來通知所有登記的對象
        public void SimulateNewMail(string from,string to,string subject){
            NewMailEventArgs e=new NewMailEventArgs(from,to,subject);
            OnNewMail(e);
        }
    }

4. 定義事件接收者

   public class Fax{
        public Fax(MailManager mm){
            // 構造委托實例，向事件登記回調方法
            mm.NewMail+=FaxMsg;
        }
        /// <summary>
        /// 回調方法
        /// </summary>
        /// <param name="sender">表示MailManager對象，便於將信息傳遞給他</param>
        /// <param name="e">表示MailManager對象想傳給我們的附加信息</param>
        private void FaxMsg(object sender,NewMailEventArgs e){
            Console.WriteLine("msg:{0},{1},{2}",e.From,e.To,e.Subject);
        }

        /// <summary>
        /// 注銷對事件的登記
        /// </summary>
        /// <param name="mm"></param>
        public void Unregister(MailManager mm){
            mm.NewMail-=FaxMsg;
        }
    }

對象不在接收事件通知時應注銷對事件的關注。因為對象只要向事件等急了它的一個方法，便不能被垃圾回收。

5. 程序初始化時應首先構造MailManager對象，將指向它的變量傳遞給Fax。在Fax構造器中添加對事件的關注。最后調用MailManager對象的事件通知方法

 static void Main(string[] args)
        {
            MailManager mm=new MailManager();
            Fax f=new Fax(mm);
            mm.SimulateNewMail("a","b","Hello World!");
            Console.ReadKey();
        }

控制台輸出結果：以調用回調方法。