如何：訂閱和取消訂閱事件（C# 編程指南） · MSDN C# 編程指南 & 參考手冊 2015

# 如何：訂閱和取消訂閱事件（C# 編程指南）如果您想編寫引發事件時調用的自定義代碼，則可以訂閱由其他類發布的事件。例如，可以訂閱某個按鈕的 click 事件，以使應用程序在用戶單擊該按鈕時執行一些有用的操作。 ## 使用 Visual Studio IDE 訂閱事件 1. 如果看不到**“屬性”**窗口，請在**“設計”**視圖中，右擊要為其創建事件處理程序的窗體或控件，然后選擇**“屬性”**。 2. 在**“屬性”**窗口的頂部，單擊**“事件”**圖標。 3. 雙擊要創建的事件，例如 Load 事件。 Visual C# 會創建一個空事件處理程序方法，并將其添加到您的代碼中。或者，您也可以在**“代碼”**視圖中手動添加代碼。例如，下面的代碼行聲明了一個在 Form 類引發 Load 事件時調用的事件處理程序方法。 ``` private void Form1_Load(object sender, System.EventArgs e) { // Add your form load event handling code here. } ``` 還會在項目的 Form1.Designer.cs 文件的 InitializeComponent 方法中自動生成訂閱該事件所需的代碼行。該代碼行類似于： ``` this.Load += new System.EventHandler(this.Form1_Load); ``` ## 以編程方式訂閱事件 1. 定義一個事件處理程序方法，其簽名與該事件的委托簽名匹配。例如，如果事件基于 [EventHandler](https://msdn.microsoft.com/zh-cn/library/system.eventhandler.aspx) 委托類型，則下面的代碼表示方法存根： ``` void HandleCustomEvent(object sender, CustomEventArgs a) { // Do something useful here. } ``` 2. 使用加法賦值運算符 (**+=**) 來為事件附加事件處理程序。在下面的示例中，假設名為 publisher 的對象擁有一個名為 RaiseCustomEvent 的事件。請注意，訂戶類需要引用發行者類才能訂閱其事件。 ``` publisher.RaiseCustomEvent += HandleCustomEvent; ``` 請注意，前面的語法是 C# 2.0 中的新語法。此語法完全等效于必須使用 **new** 關鍵字顯式創建封裝委托的 C# 1.0 語法： ``` publisher.RaiseCustomEvent += new CustomEventHandler(HandleCustomEvent); ``` 還可以通過使用 lambda 表達式添加事件處理程序： ``` public Form1() { InitializeComponent(); // Use a lambda expression to define an event handler. this.Click += (s,e) => { MessageBox.Show( ((MouseEventArgs)e).Location.ToString());}; } ``` 有關更多信息，請參見 [如何：在 LINQ 外部使用 Lambda 表達式（C# 編程指南）](https://msdn.microsoft.com/zh-cn/library/bb383984.aspx)。 ## 使用匿名方法訂閱事件 * 如果以后不必取消訂閱某個事件，則可以使用加法賦值運算符 (**+=**) 將匿名方法附加到此事件。在下面的示例中，假設名為 publisher 的對象擁有一個名為 RaiseCustomEvent 的事件，并且還定義了一個 CustomEventArgs 類以承載某些類型的專用事件信息。請注意，訂戶類需要引用 publisher 才能訂閱其事件。 ``` publisher.RaiseCustomEvent += delegate(object o, CustomEventArgs e) { string s = o.ToString() + " " + e.ToString(); Console.WriteLine(s); }; ``` 請務必注意，如果使用匿名函數訂閱事件，事件的取消訂閱過程將比較麻煩。這種情況下若要取消訂閱，必須返回到該事件的訂閱代碼，將該匿名方法存儲在委托變量中，然后將此委托添加到該事件中。一般來說，如果必須在后面的代碼中取消訂閱某個事件，則建議您不要使用匿名函數訂閱此事件。有關匿名函數的更多信息，請參見[匿名函數（C# 編程指南）](https://msdn.microsoft.com/zh-cn/library/bb882516.aspx)。 ## 取消訂閱要防止在引發事件時調用事件處理程序，請取消訂閱該事件。要防止資源泄露，應在釋放訂戶對象之前取消訂閱事件。在取消訂閱事件之前，在發布對象中作為該事件的基礎的多路廣播委托會引用封裝了訂戶的事件處理程序的委托。只要發布對象保持該引用，垃圾回收功能就不會刪除訂戶對象。 ### 取消訂閱事件 * 使用減法賦值運算符 (**-=**) 取消訂閱事件： ``` publisher.RaiseCustomEvent -= HandleCustomEvent; ``` 所有訂戶都取消訂閱事件后，發行者類中的事件實例將設置為 **null**。 ## 請參閱 [事件（C# 編程指南）](https://msdn.microsoft.com/zh-cn/library/awbftdfh.aspx) [event（C# 參考）](https://msdn.microsoft.com/zh-cn/library/8627sbea.aspx) [如何：發布符合 .NET Framework 準則的事件（C# 編程指南）](https://msdn.microsoft.com/zh-cn/library/w369ty8x.aspx) [-= 運算符（C# 參考）](https://msdn.microsoft.com/zh-cn/library/2y9zhhx1.aspx) [+= 運算符（C# 參考）](https://msdn.microsoft.com/zh-cn/library/sa7629ew.aspx)