1. 程式人生 > WINDOWS開發 >C#基礎篇——事件

C#基礎篇——事件

前言

在本章中,主要是藉機這個C#基礎篇的系列整理過去的學習筆記、歸納總結並更加理解透徹。

在上一篇文章,我們已經對委託有了進一步瞭解,委託相當於用方法作為另一方法引數,同時,也可以實現在兩個不能直接呼叫的方法中做橋樑。

下面我們來回顧一下委託的例子。

    public delegate void ExecutingDelegate(string name);

    public class ExecutingManager
    {
        public void ExecuteProgram(string name,ExecutingDelegate ToExecuting)
        {
            ToExecuting(name);
        }
    }
    private static void StartExecute(string name)
    {
        Console.WriteLine("開始執行:" + name);
    }

    private static void EndExecute(string name)
    {
        Console.WriteLine("結束執行:" + name);
    }

    static void Main(string[] args)
    {
        ExecutingManager exec = new ExecutingManager();
        exec.ExecuteProgram("開始。。。",StartExecute);
        exec.ExecuteProgram("結束。。。",EndExecute);
        Console.ReadKey();
    }

根據上述的示例,再利用上節學到的知識,將多個方法繫結到同一個委託變數實現多播,該如何做呢?

再次修改程式碼:

    static void Main(string[] args)
    {
        ExecutingManager exec = new ExecutingManager();
        ExecutingDelegate executingDelegate;
        executingDelegate = StartExecute;
        executingDelegate += EndExecute;
        exec.ExecuteProgram("yuan",executingDelegate);

        Console.ReadKey();
    }

但是,此刻我們發現是不是可以將例項化宣告委託的變數封裝到ExecutingManager類中,這樣是不是更加方便呼叫呢?

    public class ExecutingManager
    {
        /// <summary>
        /// 在 ExecutingManager 類的內部宣告 executingDelegate 變數
        /// </summary>
        public ExecutingDelegate executingDelegate;
        public void ExecuteProgram(string name,ExecutingDelegate ToExecuting)
        {
            ToExecuting(name);
        }
    }
    static void Main(string[] args)
    {
        ExecutingManager exec = new ExecutingManager();
        exec.executingDelegate = StartExecute;
        exec.executingDelegate += EndExecute;
        exec.ExecuteProgram("yuan",exec.executingDelegate);
        Console.ReadKey();
    }

寫到這裡了,這樣做沒有任何問題,但我們發現這條語句很奇怪。在呼叫exec.ExecuteProgram方法的時候,再次傳遞了exec的executingDelegate欄位,既然如此,我們何不修改 ExecutingManager類成這樣:

    public class ExecutingManager
    {
        /// <summary>
        /// 在 GreetingManager 類的內部宣告 delegate1 變數
        /// </summary>
        public ExecutingDelegate executingDelegate;
        public void ExecuteProgram(string name)
        {
            if (executingDelegate != null) // 如果有方法註冊委託變數
            {
                executingDelegate(name); // 通過委託呼叫方法
            }
        }
    }
    static void Main(string[] args)
    {
        ExecutingManager exec = new ExecutingManager();
        exec.executingDelegate = StartExecute;
        exec.executingDelegate += EndExecute;
        exec.ExecuteProgram("yuan");
        Console.ReadKey();
    }

這樣再看,發現呼叫一下就更加簡潔了。

正文

在日常生活中,我們可能都會遇到這樣的各種各樣的事情,而對於這些事情我們都會採取相應的措施。比如,當你要給一個女神過生日的時候,你就可以給她送禮物。而這種情況,在C#開發中,就相當於過生日被當作事件來對待,而送禮物就是事件做出的響應。

當女神過生日的時候,女神就會發布生日事件,而你就會接受到這個事件的通知,並做出響應的處理(送禮物等騷操作)。其中,觸發這個事件的物件我們可稱之為事件釋出者,而捕獲這個事件並做出相應處理的稱之為事件訂閱者,我們可以看出,女神就是充當了釋出者,而你自己則充當了訂閱者。

這裡由生日事件引申出兩類角色,即事件釋出者事件訂閱者

開始

1.釋出者/訂閱者模式

在開發中,我們是否遇到這樣的情景,當一個特定的程式事件發生時,其他程式部分可以得到該事件註冊發生通知。

釋出者定義一系列事件,並提供一個註冊方法;訂閱者向釋出者註冊,並提供一個可被回撥的方法,也就是事件處理程式;當事件被觸發的時候,訂閱者得到通知,而訂閱者所提交的所有方法會被執行。

  • 釋出者:釋出某個事件的類或結構,其他類可以在該事件發生時得到通知。
  • 訂閱者:註冊並在事件發生時得到通知的類或結構。
  • 事件處理程式:由訂閱者註冊到事件的方法,在釋出者觸發事件時執行。事件處理程式方法可以定義在事件所在的類或結果中,也可以定義在不同的類或結構中。
  • 觸發事件:呼叫事件的術語。當事件觸發時,所有註冊到它的方法都會被一次呼叫。

2.基本使用

        /// <summary>
        /// 先自定義一個委託
        /// </summary>
        /// <param name="oldPrice"></param>
        /// <param name="newPrice"></param>
        public delegate void PriceChangedHandler(decimal oldPrice,decimal newPrice);
        /// <summary>
        /// 這個一個釋出者
        /// </summary>
        public class IPhone
        {
            decimal price;
            /// <summary>
            /// 定義一個事件
            /// event 用來定義事件
            /// PriceChangedHandler委託型別,事件需要通過委託來呼叫訂閱者需要的方法
            /// </summary>
            public event PriceChangedHandler PriceChanged;
          
            public decimal Price
            {
                get { return price; }
                set
                {
                    if (price == value)
                        return;
                    decimal oldPrice = price;
                    price = value;             // 如果呼叫列表不為空,則觸發。            
                    if (PriceChanged != null)   //用來判斷事件是否被訂閱者註冊過
                        PriceChanged(oldPrice,price);   //呼叫事件
                }
            }
        }
        /// <summary>
        /// 這個一個訂閱者
        /// </summary>
        /// <param name="oldPrice"></param>
        /// <param name="price"></param>
        static void iPhone_PriceChanged(decimal oldPrice,decimal price)
        {
            Console.WriteLine("618促銷活動,全場手機 只賣 " + price + " 元, 原價 " + oldPrice + " 元,快來搶!");
        }
        static void Main()
        {
            ///例項化一個釋出者類
            IPhone phone = new IPhone()
            {
                Price = 5288
            };         // 訂閱事件   
            phone.PriceChanged += iPhone_PriceChanged;          //完成事件的註冊 調整價格(事件發生)    
            phone.Price = 3999;                                //激發事件,並呼叫事件
            Console.ReadKey();
        }

輸出:

618促銷活動,全場手機 只賣 3999 元, 原價 5288 元,快來搶!

3.解析

  1. 委託型別宣告:事件與事件處理程式必須有共同的簽名和返回型別,它們通過委託型別進行描述。
  2. 事件宣告:使用關鍵字evet來宣告一個事件,當宣告的事件為一個public時,稱為釋出了一個事件。
  3. 事件註冊:訂閱者通過+=操作符來註冊事件,並提供一個事件處理程式。
  4. 事件處理程式: 訂閱者向事件註冊的方法,它可以是顯示命名的方法、匿名方法或者Lambda表示式
  5. 觸發事件:釋出者用來呼叫事件的程式碼

4.語法

事件的宣告語法:

//宣告一個事件
public [static] event EventHandler EventName;
//宣告多個同類型的事件
public [static] event EventHandler EventName1,EventName2,EventName3;

事件必須宣告在類或結構中,因為事件它不是一個型別,它是一個類或者結構中的一員。

在事件被觸發之前,可以通過和null做比較,判斷是否包含事件註冊處理程式。因為事件成員被初始化預設是null。

委託型別EventHandler是宣告專門用來事件的委託。事件提供了對委託的結構化訪問;也即是無法直接訪問事件中的委託。

5.用法

技術分享圖片

檢視原始碼:

事件的標準模式就是System名稱空間下宣告的EventHandler委託型別。

EventArgs是System下的一個類,如下:

using System.Runtime.InteropServices;

namespace System
{
    [Serializable]
    [ComVisible(true)]
    [__DynamicallyInvokable]
    public class EventArgs
    {
        [__DynamicallyInvokable]
        public static readonly EventArgs Empty = new EventArgs();

        [__DynamicallyInvokable]
        public EventArgs()
        {
        }
    }
}

根據EventArgs原始碼看出,EventArgs本身無法儲存和傳遞資料的。

如果想儲存和傳遞資料,可以實現一個EventArgs的派生類,然後定義相關的欄位來儲存和傳遞引數。

    public class IPhone
    {
        decimal price;
        /// <summary>
        /// 使用EventHandler定義一個事件
        /// </summary>
        public event EventHandler PriceChanged;
        protected virtual void OnPriceChanged()
        {
            if (PriceChanged != null)
                PriceChanged(this,null);
        }
        public decimal Price
        {
            get { return price; }
            set
            {
                if (price == value) return;
                decimal oldPrice = price; 
                price = value;             // 如果呼叫列表不為空,則觸發。      
                if (PriceChanged != null)  // //用來判斷事件是否被訂閱者註冊過
                    OnPriceChanged();
            }
        }
    }
    /// <summary>
    /// 這個一個訂閱者
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    static void iphone_PriceChanged(object sender,EventArgs e)
    {
        Console.WriteLine("年終大促銷,快來搶!");
    }
    static void Main()
    {
        IPhone phone = new IPhone()
        {
            Price = 5288M
        };         // 訂閱事件  
        phone.PriceChanged += iphone_PriceChanged;
        // 調整價格(事件發生)   
        phone.Price = 3999;
        Console.ReadKey();
    }

通過擴充套件EventHanlder來傳遞資料

技術分享圖片

System下另有泛型EventHandler類。由此,這裡我們可以將派生於EventArgs的類作為型別引數傳遞過來,這樣,既可以獲得派生類儲存的資料。

    ///擴充套件類
    public class PriceChangedEventArgs : System.EventArgs
    {
        public readonly decimal OldPrice;
        public readonly decimal NewPrice;
        public PriceChangedEventArgs(decimal oldPrice,decimal newPrice)
        {
            OldPrice = oldPrice;
            NewPrice = newPrice;
        }
    }
    public class IPhone
    {
        decimal price;
        public event EventHandler<PriceChangedEventArgs> PriceChanged;
        protected virtual void OnPriceChanged(PriceChangedEventArgs e)
        {
            if (PriceChanged != null)
                PriceChanged(this,e);
        }
        public decimal Price
        {
            get { return price; }
            set
            {
                if (price == value) return;
                decimal oldPrice = price;
                price = value;             // 如果呼叫列表不為空,則觸發。      
                if (PriceChanged != null)
                    OnPriceChanged(new PriceChangedEventArgs(oldPrice,price));
            }
        }
    }
    static void iphone_PriceChanged(object sender,PriceChangedEventArgs e)
    {
        Console.WriteLine("618促銷活動,全場手機 只賣 " + e.NewPrice + " 元, 原價 " + e.OldPrice + " 元,快來搶!");
    }
    static void Main()
    {
        IPhone phone = new IPhone()
        {
            Price = 5288M
        };         // 訂閱事件  
        phone.PriceChanged += iphone_PriceChanged;
        // 調整價格(事件發生)   
        phone.Price = 3999;
        Console.ReadKey();
    }

輸出

618促銷活動,全場手機 只賣 3999 元, 原價 5288 元,快來搶!

6.移除事件

可以利用 -= 運算子處理程式從事件中移除,當程式處理完後,可以將事件從中把它移除掉。

        class Publiser
        {
            public event EventHandler SimpleEvent;

            public void RaiseTheEvent()
            {
                SimpleEvent(this,null);
            }
        }

        class Subscriber
        {
            public void MethodA(object o,EventArgs e) { Console.WriteLine("A"); }
            public void MethodB(object o,EventArgs e) { Console.WriteLine("B"); }
        }


        static void Main(string[] args)
        {
            Publiser p = new Publiser();
            Subscriber s = new Subscriber();

            p.SimpleEvent += s.MethodA;
            p.SimpleEvent += s.MethodB;
            p.RaiseTheEvent();

            Console.WriteLine("\n移除B事件處理程式");
            p.SimpleEvent -= s.MethodB;
            p.RaiseTheEvent();

            Console.ReadKey();
        }

輸出:

技術分享圖片

7.事件訪問器

運算子+= 、-=事件允許的唯一運算子。這些運算子是有預定義的行為。然而,我們可以修改這些運算子的行為,讓事件執行任何我們希望定義的程式碼。

可以通過為事件定義事件訪問器,來控制事件運算子+=、-=運算子的行為

  1. 兩個訪問器: add 和 remove
  2. 宣告事件的訪問器看上去和宣告一個熟悉差不多。

下面示例演示了具有訪問器的宣告.兩個訪問器都有叫做value的隱式值引數,它接受例項或靜態方法的引用

public event EventHandler Elapsed
{
    add
    {
        //... 執行+=運算子的程式碼
    }

     remove
     {
        //... 執行-=運算子的程式碼
     }

}

聲明瞭事件訪問器後,事件不包含任何內嵌委託物件.我們必須實現自己的機制來儲存和移除事件的方法。

事件訪問器表現為void方法,也就是不能使用會返回值的return語句。

示例:

        //宣告一個delegate
        delegate void EventHandler();

        class MyClass
        {
            //宣告一個成員變數來儲存事件控制代碼(事件被激發時被呼叫的delegate)
            private EventHandler m_Handler = null;

            //激發事件
            public void FireAEvent()
            {
                if (m_Handler != null)
                {
                    m_Handler();
                }
            }

            //宣告事件
            public event EventHandler AEvent
            {
                //新增訪問器
                add
                {
                    //注意,訪問器中實際包含了一個名為value的隱含引數
                    //該引數的值即為客戶程式呼叫+=時傳遞過來的delegate
                    Console.WriteLine("AEvent add被呼叫,value的HashCode為:" + value.GetHashCode());
                    if (value != null)
                    {
                        //設定m_Handler域儲存新的handler
                        m_Handler = value;
                    }
                }

                //刪除訪問器
                remove
                {
                    Console.WriteLine("AEvent remove被呼叫,value的HashCode為:" + value.GetHashCode());
                    if (value == m_Handler)
                    {
                        //設定m_Handler為null,該事件將不再被激發
                        m_Handler = null;
                    }
                }

            }

        }

        static void Main(string[] args)
        {
            MyClass obj = new MyClass();
            //建立委託
            EventHandler MyHandler = new EventHandler(MyEventHandler);
            MyHandler += MyEventHandle2;
            //將委託註冊到事件
            obj.AEvent += MyHandler;
            //激發事件
            obj.FireAEvent();
            //將委託從事件中撤銷
            obj.AEvent -= MyHandler;
            //再次激發事件
            obj.FireAEvent();


            Console.ReadKey();
        }
        //事件處理程式
        static void MyEventHandler()
        {
            Console.WriteLine("This is a Event!");
        }

        //事件處理程式
        static void MyEventHandle2()
        {
            Console.WriteLine("This is a Event2!");
        }

輸出:

技術分享圖片

總結

  1. 這節對事件的基本使用,以及事件的標準語法、事件訪問器等多個地方進行說明,大致可以瞭解和掌握事件的基本使用。
  2. 結合上一篇的委託和這一節的事件,委託和事件我們大概掌握了基本用法。並加以實踐,結合實際開發,應用其中。
  3. 如果有不對的或不理解的地方,希望大家可以多多指正,提出問題,一起討論,不斷學習,共同進步。

參考 文件 《C#圖解教程》

注:搜尋關注公眾號【DotNet技術谷】--回覆【C#圖解】,可獲取 C#圖解教程檔案