理解C#事件

前面文章中介紹了委托相關的概念（http://www.linuxidc.com/Linux/2015-02/113469.htm），委托實例保存這一個或一組操作，程序中將在某個特定的時刻通過委托實例使用這些操作。

如果做過GUI程序開發，可能對上面的描述會比較熟悉。在GUI程序中，單擊一個button會觸發一個click事件，然後會執行一系列的操作，這一系列的操作就被存放在一個委托實例中。

接下來我們就看看事件。

使用委托中的問題

回到前面文章中蘋果和富士康的例子，蘋果將iphone的組裝、包裝和運輸的工作全部委托給了富士康。

根據上面的描述，我們修改了一下代碼，在Apple這個類中加入一個訂單屬性，蘋果只要接到新的訂單，就發送一個通知給富士康，然後富士康就會執行一系列的操作了（組裝、包裝和運輸）。

在主程序中，蘋果將iphone的組裝、包裝和運輸工作委托給了富士康，然後蘋果每次收到訂單，就會通過委托實例"VerdorToAssembleIphone"讓富士康去執行一系列操作。

class Apple
{
    //聲明委托類型
    public delegate void AssembleIphoneHandler(int num);
    public AssembleIphoneHandler VerdorToAssembleIphone;

    public void DesignIphone()
    {
        Console.WriteLine("Design Iphone By Apple");
    }

    private int orderNum;
    public int OrderNum
    {
        get { return this.orderNum; }
        set
        {
            this.orderNum = value;
            if (VerdorToAssembleIphone != null)
            {
                VerdorToAssembleIphone(this.orderNum);
            }
        }
    }
}

class Foxconn
{
    //與委托類型簽名相同的方法
    public void AssembleIphone(int num)
    {
        Console.WriteLine("Assemble {0} Iphone By Foxconn", num);
    }

    public void PackIphone(int num)
    {
        Console.WriteLine("Pack {0} Ipnone By Foxconn", num);
    }

    public void ShipIphone(int num)
    {
        Console.WriteLine("Ship {0} Iphone By Foxconn", num);
    }
}


class Program
{
    static void Main(string[] args)
    {
        Apple apple = new Apple();
        Foxconn foxconn = new Foxconn();
        apple.VerdorToAssembleIphone = new Apple.AssembleIphoneHandler(foxconn.AssembleIphone);
        apple.VerdorToAssembleIphone += new Apple.AssembleIphoneHandler(foxconn.PackIphone);
        apple.VerdorToAssembleIphone += new Apple.AssembleIphoneHandler(foxconn.ShipIphone);

        apple.OrderNum = 100;
     
        Console.Read();
    }
}

下面我們看下這個例子實現中的問題：

1. 如果用戶在建立委托鏈的時候錯誤的使用了"="而不是"+="，那麼委托鏈就斷了
2. 在主程序中，我們可以繞過設置訂單這一步，直接調用委托實例"apple.VerdorToAssembleIphone(99);"來讓富士康執行操作，這點是不合理的

class Program
{
    static void Main(string[] args)
    {
        Apple apple = new Apple();
        Foxconn foxconn = new Foxconn();

        //創建委托實例
        apple.AssembleIphone = new Apple.AssembleIphoneHandler(foxconn.AssembleIphone);
        apple.AssembleIphone += new Apple.AssembleIphoneHandler(foxconn.PackIphone);
        apple.AssembleIphone = new Apple.AssembleIphoneHandler(foxconn.ShipIphone);
        apple.DesignIphone();
        
        //委托實例的調用
        apple.VerdorToAssembleIphone(99);
     
        Console.Read();
    }
}

事件的出現

為了解決上面兩個問題，出現了事件這個概念，我們要做的改變只是在聲明委托實例的時候加上event關鍵字。

public event AssembleIphoneHandler VerdorToAssembleIphone;

這時，上面兩處有問題的代碼就會在編譯的時候報錯了。

上面的問題是解決了，但是event關鍵字作用是什麼，事件跟委托有什麼關系，"VerdorToAssembleIphone"怎麼理解？

深入理解事件

其實，下面這個語句還是比較難理解的，看到的第一反應就是，委托跟事件到底是什麼關系，event關鍵字跟委托類型"AssembleIphoneHandler"是什麼關系。

public event AssembleIphoneHandler VerdorToAssembleIphone;

其實，事件可以理解成一個委托的屬性，通過對委托實例的封裝來對委托實例的訪問進行一些限制。下面我們通過IL來查看一下這個個程序，得到下圖。

下面我們就結合IL的查看結果來分析事件到底是什麼。在開始之前，相信大家一定都熟悉屬性（property）這個概念吧，那就讓我們從熟悉的屬性開始分析。

C#屬性的概念

首先來看看我們熟悉的東西，"OrderNum"是我們定義的一個訂單數量的屬性（property），它有一組get/set方法。通過這個屬性的get/set方法，我們可以訪問"orderNum"字段（field）。

通過IL查看"OrderNum"這個屬性，我們可以看到這個屬性對應的get/set方法。

public int32 get_OrderNum() { }
public void set_OrderNum(int32 'value') { }

事件

接下來再看"VerdorToAssembleIphone"事件，我們按照屬性的方式去理解事件，從IL的截圖中，可以看到事件中有一對addon/removeon方法來操作我們的委托實例（想想屬性的get/set方法）。

同時，我們看到編譯器給我們生成了一個private的field（如下），從這裡我們可以看到事件"VerdorToAssembleIphone"本質上就是一個委托類型的變量。由於這個變量是private的，也就解釋了為什麼我們在定義事件的類外部不能直接訪問這個變量。

.field private class _1_1_Delegate.Apple/AssembleIphoneHandler VerdorToAssembleIphone

事件代碼的轉換

根據上面的分析，我們可以看到，編譯器幫我們進行了下面的代碼轉換。這樣一來，就相當於通過event關鍵字對委托實例訪問增加了一些限制。

原始的聲明事件的C#代碼：

public event AssembleIphoneHandler VerdorToAssembleIphone;

編譯器轉換後的代碼：

private AssembleIphoneHandler VerdorToAssembleIphone;

public void add_VerdorToAssembleIphone(AssembleIphoneHandler 'value') { }

public void remove_VerdorToAssembleIphone(AssembleIphoneHandler 'value') { }

通過上面的分析，可以了解到事件封裝了委托類型的實例，使得：

• 在定義事件的類內部，不管你聲明它是public還是protected，它總是private的；也就是說在在定義事件的類外部不能對事件進行調用
• 在定義事件的類外部，添加"+="和移除"-="委托實例的訪問限定符與聲明事件時使用的訪問符相同
  • 也就是說，如果事件聲明為private或這protect， 那麼定義事件的類外部也不能對事件進行"+="和"-="操作

事件編程

其實，上面的例子只是一個簡單的演示。在很多情況下，事件使用過程中都會結合兩個參數：事件源和事件參數。

所以，在事件編程中，可以參考下面一些規范：

• 統一以EventNameEventHandler方式命名委托變量：EventName是事件的名稱
• delegate接受兩個參數，參數名統一命名為sender和e：第一個參數類型是object，第二個參數是事件參數類型，以EventNameEventArgs命名，並且需繼承於System.EventArgs類
• 如果在事件中不需要傳遞任何數據，也需要聲明兩個參數：第一個參數就是默認的object sender，第二個參數可以使用系統默認的System.EventArgs類

總結

通過本文介紹了事件的概念以及原理，解釋了通過事件如何封裝委托實例，並解決委托例子中遇到的兩個問題。

同時了解了事件的使用：

• 通過event關鍵字聲明事件，
  • <事件修飾> event <委托類型> <事件名稱>;
• 事件的調用，由於事件本質上是委托類型，調用事件與調用委托一樣，但是事件的調用只能發生在定義事件的類的內部