在C#中使用代理的方式觸發事件 (委託和事件 )

From：  http://www.cnblogs.com/gzhnan/articles/1859477.html

 

在C#中使用代理的方式觸發事件 (委託和事件 ) 

事件（event）是一個非常重要的概念，我們的程式時刻都在觸發和接收著各種事件：滑鼠點擊事件，鍵盤事件，以及處理作業系統的各種事件。所謂事 件就是由某個對象發出的訊息。比如使用者按下了某個按鈕，某個檔案發生了改變，socket上有資料到達。觸發事件的對象稱作寄件者（sender），捕獲 事件並且做出響應的對象稱作接收者（receiver），一個事件可以存在多個接受者。

在非同步機制中，事件是線程之間進行通訊的一個非 常常用的方式。比如：使用者在介面上按下一個按鈕，執行某項耗時的任務。程式此時啟動一個線程來處理這個任務，使用者介面上顯示一個進度條指示使用者任務執行的 狀態。這個功能就可以使用事件來進行處理。可以將處理任務的類作為訊息的寄件者，任務開始時，發出“TaskStart”事件，任務進行中的不同時刻發出 “TaskDoing”事件，並且攜帶參數說明任務進行的比例，任務結束的時候發出“TaskDone”事件，在畫面中接收並且處理這些事件。這樣實現了 功能，並且介面和後台執行任務的模組耦合程度也是最低的。

具體說C#語言，事件的實現依賴於“代理”（delegate）的概念，先瞭解一下代理。

代理（delegate）

delegate 是C#中的一種類型，它實際上是一個能夠持有對某個方法的引用的類。與其它的類不同，delegate類能夠擁有一個簽名（signature），並且它 只能持有與它的簽名相匹配的方法的引用。它所實現的功能與C/C++中的函數指標十分相似。它允許你傳遞一個類A的方法m給另一個類B的對象，使得類B的 對象能夠調用這個方法m。但與函數指標相比，delegate有許多函數指標不具備的優點。首先，函數指標只能指向靜態函數，而delegate既可以引 用靜態函數，又可以引用非靜態成員函數。在引用非靜態成員函數時，delegate不但儲存了對此函數入口指標的引用，而且還儲存了調用此函數的類執行個體的 引用。其次，與函數指標相比，delegate是物件導向、型別安全、可靠的受控（managed）對象。也就是說，runtime能夠保證 delegate指向一個有效方法，你無須擔心delegate會指向無效地址或者越界地址。

實現一個delegate是很簡單的，通過以下3個步驟即可實現一個delegate：

1． 聲明一個delegate對象，它應當與你想要傳遞的方法具有相同的參數和傳回值類型。

2． 建立delegate對象，並將你想要傳遞的函數作為參數傳入。

3． 在要實現非同步呼叫的地方，通過上一步建立的對象來調用方法。

下面是一個簡單的例子：

public class MyDelegateTest

{

// 步驟1，聲明delegate對象

public delegate void MyDelegate(string name);

// 這是我們欲傳遞的方法，它與MyDelegate具有相同的參數和傳回值類型

public static void MyDelegateFunc(string name)

{

Console.WriteLine("Hello, {0}", name);

}

public static void Main ()

{

// 步驟2，建立delegate對象

MyDelegate md = new MyDelegate(MyDelegateTest.MyDelegateFunc);

// 步驟3，調用delegate

md("sam1111");

}

}

輸出結果是：Hello, sam1111

下面我們來看看事件是如何處理的：

在 C# 中處理事件

 

C#中的事件處理實際上是一種具有特殊簽名的delegate，象下面這個樣子：

 

public delegate void MyEventHandler(object sender, MyEventArgs e);

 

其中的兩個參數，sender代表事件寄件者，e是事件參數類。 MyEventArgs類用來包含與事件相關的資料，所有的事件參數類都必須從System.EventArgs類派生。當然，如果你的事件不含參數，那 麼可以直接用System.EventArgs類作為參數。

 

就是這麼簡單，結合delegate的實現，我們可以將自訂事件的實現歸結為以下幾步：

 

1．           定義delegate物件類型，它有兩個參數，第一個參數是事件寄件者對象，第二個參數是事件參數類對象。

 

2．           定義事件參數類，此類應當從System.EventArgs類派生。如果事件不帶參數，這一步可以省略。

 

3．           定義事件處理方法，它應當與delegate對象具有相同的參數和傳回值類型。

 

4．           用event關鍵字定義事件對象，它同時也是一個delegate對象。

 

5．           用+=操作符添加事件到事件隊列中（-=操作符能夠將事件從隊列中刪除）。

 

6．           在需要觸發事件的地方用調用delegate的方式寫事件觸發方法。一般來說，此方法應為protected訪問限制，既不能以public方式調用，但可以被子類繼承。名字是OnEventName。

 

7．           在適當的地方呼叫事件觸發方法觸發事件。

 

下面是一個簡單的例子：

 

 

using System;

 

 

public class EventTest

 

{

 

        // 步驟1，定義delegate對象

 

     public delegate void MyEventHandler(object sender, System.EventArgs e);

 

     // 步驟2省略

 

public class MyEventCls

 

     {

 

// 步驟3，定義事件處理方法，它與delegate對象具有相同的參數和傳回值類// 型

 

            public void MyEventFunc(object sender, System.EventArgs e)

 

            {

 

                   Console.WriteLine("My event is ok!");

 

            }

 

     }

 

     // 步驟4，用event關鍵字定義事件對象

 

     private event MyEventHandler myevent;

 

 

     private MyEventCls myecls;

 

 

     public EventTest()

 

     {

 

            myecls = new MyEventCls();

 

            // 步驟5，用+=操作符將事件添加到隊列中

 

            this.myevent += new MyEventHandler(myecls.MyEventFunc);

 

     }

 

     // 步驟6，以調用delegate的方式寫事件觸發函數

 

     protected void OnMyEvent(System.EventArgs e)

 

     {

 

            if(myevent != null)

 

                   myevent(this, e);

 

     }

 

 

     public void RaiseEvent()

 

     {

 

            EventArgs e = new EventArgs();

 

            // 步驟7，觸發事件

 

            OnMyEvent(e);

 

     }

 

 

     public static void Main()

 

     {

 

            EventTest et = new EventTest();

 

            Console.Write("Please input 'a':");

 

            string s = Console.ReadLine();

 

            if(s == "a")

 

            {

 

                   et.RaiseEvent();

 

            }

 

            else

 

            {

 

                   Console.WriteLine("Error");

 

            }

 

     }

 

}

 

 

輸出結果如下，黑體為使用者的輸入：

 

Please input ‘a’: a

 

My event is ok!

/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

C#代表元及事件觸發

代表元是C#中比較複雜的概念，C#中的代表元和C/C++中的函數指標非常相似使用代表元可以把代表元內部方法的引用封裝起來然後通過它使用代表元引用的方法。 它有一個特性就是不需要知道被引用的方法屬於那一個類對象只要函數的參數個數與傳回型別與代表元對象一致。這樣說可能比較抽象我下面舉幾個簡單的例子希望能給廣大初學者一些基本的認識 //定義一個傳回值為string的無參數的代表元注意這個代表元只能引用對象中傳回值為string的無參數方法 delegate   string   MyDelegate(); public   class   MyClass { public   string   SayHello() { return   "Hello   the   world!"; } } public   class   TestMyClass { public   static   void   Main(string[]   args) { MyClass   myClass1=new   MyClass(); MyDelegate   myDelegate1=new   MyDelegate(myClass1.SayHello); //下面就使用myDelegate1代替對象myClass1的SayHello方法 System.Console.WriteLine(myDelegate1()); //輸出結果為hello   the   world!   與調用myClass1.SayHello();效果相同 } } 如果代表元只有這點功能它就沒有什麼太大的用處了，代表元還有一個非常有用的功能就是定義複合代表元對象只有同樣類型的代表元才能夠複合起來   +   能定義複合代表元對象   -   從一個複合代表元中去掉一個代表元對象 delegate   void   MyDelegate(string   s); public   class   MyClass { public   void   SayHello(string   who) { System.Console.WriteLine(   who+"hello!"); } public   void   SayGoodBye(string   who) { System.Console.WriteLine(   who+"good   bye!"); } } public   class   TestMyClass { public   static   void   Main(string[]   args) { MyClass   myClass1=new   MyClass(); MyDelegate   myDelegate,myDelegate1; myDelegate=new   MyDelegate(myClass1.SayHello); myDelegate1=new   MyDelegate(myClass1.SayGoodBye); myDelegate+=myDelegate1; //這樣調用myDeletage就相當於同時調用了myClass1.SayHello和myClass1.SayGoodBye myDelegate("love.net   "); //執行結果輸出love.net   hello!   love.net   good   bye! } } 事件驅動是windows應用程式的重要特徵   C#代表元就是用於產生事件，事件就是用於在一個組件中監聽這個組件的變化 下面再舉一個簡單的例子 //定義一個事件代理（代表元） public   delegate   void   EventHandler(string   str); //定義事件來源類 class   EventSource { //定義代表元作為事件來源類的成員 public   event   EventHandler   Say; public   void   TriggerEvent() { if(this.Say!=null) //因為Say是個代表元所以執行Say方法所做的實際操作由註冊到它的事件處理函數決定 Say("A   event   take   place!"); } } //測試 class   Test { public   static   void   Main() { EventSource   aEventSource=new   EventSource(); //註冊事件處理函數為MyEvent   顯示一串字元類似於this.Click+=new   EventHandler(Button1_OnClick); aEventSource.Say+=new   EventHandler(MyEvent); //此處為示範事件觸發過程所以就用程式自動觸發 //在圖形介面應用程式中，一般由使用者觸發事件，後由作業系統發送訊息並調用處理函數   所以程式員只要註冊事件處理函數 //和編寫事件處理函數的代碼其他就不用關心了 aEventSource.TriggerEvent(); } //事件處理函數 public   static   void   MyEvent(string   str) { System.Console.WriteLine(str); } } 淺析Visual C#事件處理機制

作者: 王凱明

事件簡介：

　　任何進行過圖形化使用者介面開發的編程人員都會知道事件的概念。當使用者在使用程式的時 候，使用者必然要和程式進行一定的互動。比如當使用者點擊表單上的一個按鈕後，程式就會產生該按鈕被點擊的事件，並通過相應的事件處理函數來響應使用者的操作。 這樣使用者的直觀感覺就是程式執行了我要求的任務了。當然，事件並不一定是在和使用者互動的情況下才會產生的，系統的內部也會產生一些事件並請求處理的，比如 時鐘事件就是一個很好例子。不過要介紹C#中的事件處理機制（擴充到更廣的範圍便是整個.Net架構），我們首先得明白一個叫"委託"的概念。

　　C#中的委託：

　 　委託，顧名思義，就是中間代理人的意思。C#中的委託允許你將一個對象中的方法傳遞給另一個能調用該方法的類的某個對象。你可以將類A中的一個方法 m（被包含在某個委託中了）傳遞給一個類B，這樣類B就能調用類A中的方法m了。同時，你還可以以靜態（static）的方式或是執行個體 （instance）的方式來傳遞該方法。所以這個概念和C++中的以函數指標為參數形式調用其他類中的方法的概念是十分類似的。

　　委託的概念首先是在Visual J++中被提出來的，現在C#也應用了委託的概念，這也可謂是"拿來主義"吧。C#中的委託是通過繼承System.Delegate中的一個類來實現的，下面是具體的步驟：

　　1． 聲明一個委派物件，其參數形式一定要和你想要包含的方法的參數形式一致。

　　2． 定義所有你要定義的方法，其參數形式和第一步中聲明的委派物件的參數形式必須相同。

　　3． 建立委派物件並將所希望的方法包含在該委派物件中。

　　4． 通過委派物件調用包含在其中的各個方法。

　　以下的C#代碼顯示了如何運用以上的四個步驟來實現委託機制的：

using System;
file://步驟1： 聲明一個委派物件
public delegate void MyDelegate(string input);

file://步驟2:：定義各個方法，其參數形式和步驟1中聲明的委派物件的必須相同
class MyClass1{
public void delegateMethod1(string input){
Console.WriteLine(
"This is delegateMethod1 and the input to the method is {0}",
input);
}
public void delegateMethod2(string input){
Console.WriteLine(
"This is delegateMethod2 and the input to the method is {0}",
input);
}
}

file://步驟3：建立一個委派物件並將上面的方法包含其中
class MyClass2{
public MyDelegate createDelegate(){
MyClass1 c2=new MyClass1();
MyDelegate d1 = new MyDelegate(c2.delegateMethod1);
MyDelegate d2 = new MyDelegate(c2.delegateMethod2);
MyDelegate d3 = d1 + d2;
return d3;
}
}

file://步驟4：通過委派物件調用包含在其中的方法
class MyClass3{
public void callDelegate(MyDelegate d,string input){
d(input);
}
}
class Driver{
static void Main(string[] args){
MyClass2 c2 = new MyClass2();
MyDelegate d = c2.createDelegate();
MyClass3 c3 = new MyClass3();
c3.callDelegate(d,"Calling the delegate");
}
}

　　C#中的事件處理函數：

　　C#中的事件處理函數是一個具有特定參數形式的委派物件，其形式如下：

public delegate void MyEventHandler(object sender, MyEventArgs e);

　 　其中第一個參數（sender）指明了觸發該事件的對象，第二個參數（e）包含了在事件處理函數中可以被運用的一些資料。上面的MyEventArgs 類是從EventArgs類繼承過來的，後者是一些更廣泛運用的類，如MouseEventArgs類、ListChangedEventArgs類等的 基類。對於基於GUI的事件，你可以運用這些更廣泛的、已經被定義好了的類的對象來完成處理；而對於那些基於非GUI的事件，你必須要從 EventArgs類派生出自己的類，並將所要包含的資料傳遞給委派物件。下面是一個簡單的例子：

public class MyEventArgs EventArgs{
public string m_myEventArgumentdata;
}

　　在事件處理函數中，你可以通過關鍵字event來引用委派物件，方法如下：

public event MyEventHandler MyEvent;

　 　現在，我們來建立兩個類，通過這兩個類我們可以知道C#完成事件處理的機制是如何工作的。在我們的執行個體中，A類將提供事件的處理函數，並在步驟3中建立 委派物件同時將事件處理函數包含在其中，同上所述，事件處理函數的參數形式必須和委派物件的參數形式相一致。然後，A類將委派物件傳遞給B類。當B類中的 事件被觸發後，A類中的事件處理函數就相應的被調用了。下面是範例程式碼：

using System;
file://步驟1：聲明委派物件
public delegate void MyHandler1(object sender,MyEventArgs e);
public delegate void MyHandler2(object sender,MyEventArgs e);

file://步驟2：建立事件處理函數的方法
class A{
public const string m_id="Class A";
public void OnHandler1(object sender,MyEventArgs e){
Console.WriteLine("I am in OnHandler1 and MyEventArgs is {0}",
e.m_id);
}
public void OnHandler2(object sender,MyEventArgs e){
Console.WriteLine("I am in OnHandler2 and MyEventArgs is {0}",
e.m_id);
}

file://步驟3：建立委派物件，並事件處理函數包含在其中同時設定好將要觸發事件的對象
public A(B b){
MyHandler1 d1=new MyHandler1(OnHandler1);
MyHandler2 d2=new MyHandler2(OnHandler2);
b.Event1 +=d1;
b.Event2 +=d2;
}
}

file://步驟4：通過委派物件（也就是觸發事件）來調用被包含的方法
class B{
public event MyHandler1 Event1;
public event MyHandler2 Event2;
public void FireEvent1(MyEventArgs e){
if(Event1 != null){
Event1(this,e);
}
}
public void FireEvent2(MyEventArgs e){
if(Event2 != null){
Event2(this,e);
}
}
}
public class MyEventArgs EventArgs{
public string m_id;
}
public class Driver{
public static void Main(){
B b= new B();
A a= new A(b);
MyEventArgs e1=new MyEventArgs();
MyEventArgs e2=new MyEventArgs();
e1.m_id ="Event args for event 1";
e2.m_id ="Event args for event 2";
b.FireEvent1(e1);
b.FireEvent2(e2);
}
}

　　C#中的GUI的事件處理函數：

　 　完成GUI下的事件處理函數的基本方法和上面介紹的並沒有什麼多大區別，下面我們就通過上面的方法來完成一個簡單的執行個體程式。該執行個體程式的主類 MyForm類是從Form類繼承過來的。通過觀察整段代碼和相關的註解，你可以發現我們並沒有給它聲明委派物件並通過event關鍵字來引用該委託對 象，那是因為GUI控制項早就幫我們做好了該項工作，其委派物件是System.EventHandler。然而，我們還是要為各個控制項定義方法（也就是事 件的處理函數）並將它們包含在建立好的委派物件（System.EventHandler）中。那樣，在使用者和程式進行互動的時候，相應的事件處理函數就 會被觸發。具體代碼如下：
using System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;
using System.Data;

public class MyForm Form{
private Button m_nameButton;
private Button m_clearButton;
private Label m_nameLabel;

private Container m_components = null;

public MyForm(){
initializeComponents();
}
private void initializeComponents(){
m_nameLabel=new Label();
m_nameButton = new Button();
m_clearButton = new Button();

SuspendLayout();

m_nameLabel.Location=new Point(16,16);
m_nameLabel.Text="Click NAME button, please";
m_nameLabel.Size=new Size(300,23);

m_nameButton.Location=new Point(16,120);
m_nameButton.Size=new Size(176, 23);
m_nameButton.Text="NAME";
file://建立委派物件，包含方法並將委派物件賦給按鈕的Click事件
m_nameButton.Click += new System.EventHandler(NameButtonClicked);

m_clearButton.Location=new Point(16,152);
m_clearButton.Size=new Size(176,23);
m_clearButton.Text="CLEAR";
file://建立委派物件，包含方法並將委派物件賦給按鈕的Click事件
m_clearButton.Click += new System.EventHandler(ClearButtonClicked);

this.ClientSize = new Size(292, 271);
this.Controls.AddRange(new Control[] {m_nameLabel,
m_nameButton,
m_clearButton});
this.ResumeLayout(false);
}
file://定義方法（事件的處理函數），其參數形式必須和委派物件的一致
private void NameButtonClicked(object sender, EventArgs e){
m_nameLabel.Text=
"My name is john, please click CLEAR button to clear it";
}
private void ClearButtonClicked(object sender,EventArgs e){
m_nameLabel.Text="Click NAME button, please";
}
public static void Main(){
Application.Run(new MyForm());
}
}

　　小結：

　 　這樣，我就向大家初步介紹了C#中的事件處理機制。通過本文，希望能使大家對C#中的事件處理機制乃至整個.Net架構的事件處理機制有個大致的瞭解， 同時還希望大家能明確"委託"這樣的較新的概念。最後還要指出的是，如果你是在用Visual Studio的整合式開發環境進行開發的話，那麼各個GUI控制項會自動幫你產生相關的許多代碼，但是知道了其內部的工作機制的話總歸是有很大益處的，對嗎？