C#中事件的定義和使用

2020-01-24 01:08:01

字體：大中小

來源：轉載

供稿：網友

事件的聲明和使用與代理有很密切的關系，事件其實是一個或多個方法的代理，當對象的某個狀態發生了變化，代理會被自動調用，從而代理的方法就被自動執行。

聲明和使用一個事件需要如下步驟：

1.創建一個代理。

2.在類的內部利用event關鍵字聲明事件，并且在類中定義調用事件的方法，也可以定義一個處理事件消息的方法。
　　聲明一個事件的基本形式有兩種：
　　修飾符 event 類型標識符
　　修飾符 event 類型標識符{get{};set{};}
其中：
　　修飾符是指C#語言的訪問修飾符；類型是在聲明使用事件的第一步中創建的代理；標識符是一個C#語言的合法標識符，這個標識符被用來在程序中唯一確定聲明的事件；在聲明事件的第二種形式中具有和類的屬性類似的get和set部分，事件的get和set部分意義、使用方法均與屬性類似。

3.聲明若干個方法與事件關聯。將事件同方法進行關聯的過程類似于代理對象引用方法的過程。這些方法就是用來處理事件的方法。

4.最后，在程序中使用事件。使用事件需要根據事件的定義或者直接調用事件已經定義好的調用事件的方法，或者通過系統消息來自動觸發事件。

用一個例子來說明事件的使用。

創建一個簡單的類，名為FileWatch，包含事件OnfileChange。該類將檢查在執行應用程序的目錄（當前目錄，通常是項目名/bin/debug)下，是否存在文件test.txt。如果文件被刪除或創建，都將觸發事件。同時提供一個方法MonitorFile以不斷地查詢該文件。

方法：

在創建一個可用事件之前，首先聲明一個委托，放在類的外面。

復制代碼代碼如下:

public delegate void FileWatchEventHandler(object sender,EventArgs e);

接下來創建類FileWatch。然后聲明事件，注意事件的類型即為我們之前定義的委托。

復制代碼代碼如下:

public event FileWatchEventHandler FileWatchEvent;

現在創建方法OnFileChange()，當調用該方法時將觸發事件：

復制代碼代碼如下:

protected virtual void OnFileChange(EventArgs e)
{
     if (FileWatchEvent!=null)
     {
         FileWatchEvent(this,e);
     }
}

最后，創建方法MonitorFile()，

復制代碼代碼如下:

public void MonitorFile()
{
    bool bCurrentStatus;
   
    while(true)
    {
         bCurrentStatus = File.Exists("test.txt");
         if (bCurrentStatus != _bLastStatus) //_bLastStatus為私有字段，初始值為false;
         {
             _bLastStatus = bCurrentStatus;
             OnFileChange(EventArgs.Empty);
         }
    
         Thread.Sleep(250);
    }
}

完整代碼如下：

復制代碼代碼如下:

using System;
using System.Threading;
using System.IO;

namespace Sample.Event
{

public delegate void FileWatchEventHandler(object sender, EventArgs e);

      public class FileWatch
      {
            private bool _bLastStatus = false;
            public FileWatch()
            {
                  //
                  // TODO: 在此處添加構造函數邏輯
                  //
            }

public event FileWatchEventHandler FileWatchEvent;

            protected virtual void OnFileChange(EventArgs e)
            {
                  if (FileWatchEvent != null)
                  {

                        FileWatchEvent(this, e);
                  }
            }

            public void MonitorFile()
            {
                  bool bCurrentStatus;

                  while(true)
                  {
                        bCurrentStatus = File.Exists("test.txt");

                        //狀態不符，說明文件被刪除或重新創建，此時觸發事件；
                        if ( bCurrentStatus != _bLastStatus )
                        {
                              _bLastStatus = bCurrentStatus;
                              OnFileChange( EventArgs.Empty );
                        }

                        Thread.Sleep(250);
                  }

}
}
}

使用：創建一個Windows應用程序來測試我們之前建立的FileWatch中的事件。首先將剛才創建的項目編譯，生成Assembly：FileWatch.dll，然后添加引用。當然直接添加項目引用也可以。然后在Windows應用程序中加入命名空間：

復制代碼代碼如下:

using Sample.Event;

然后在應用程序類中，定義一個私有字段，類型為我們之前創建的類FileWatch：

復制代碼代碼如下:

public class frmMain : System.Windows.Forms.Form
{
    private Sample.Event.FileWatch FileWatchEventSource;

并在構造函數中實例化該對象；

復制代碼代碼如下:

public frmMain()
{
    InitializeComponent();
    FileWatchEventSource = new Sample.Event.FileWatch();

然后將本地方法OnFileChange連接到事件中：

復制代碼代碼如下:

FileWatchEventSource.FileWatchEvent+=new Sample.Event.FileWatchEventHandler(OnFileChange);

我們需要調用MonitorFile方法來觸發事件。在本例中，我們用線程來控制MonitorFile方法。這樣可以在

應用程序閑置的時候運行該方法以觸發事件。

復制代碼代碼如下:

thrd = new Thread(new ThreadStart(FileWatchEventSource.MonitorFile));
thrd.Start();

最后，我們需要知道事件是否被觸發，為了記錄下事件觸發的歷史記錄，我們在ListBox控件添加觸發內容。由于事件觸發后調用的方法是OnFileChange，因此我們將操作放在該方法里：

復制代碼代碼如下:

private void OnFileChange(object Sender, EventArgs e)
{
   listBox.Items.Add(DateTime.Now.ToString()+": 文件發生改變.");
}

當觸發事件時，EventHanler會傳遞sender和EventArgs類的引用。EventArgs類通常是在事件源和觸發事件器之間傳遞信息。在本例中，沒有傳遞信息，也沒有用到EventArgs類。而只是將事件添加到了ListBox中。

運行結果如下：

結論：在C#中使用事件的要點：

首先，要建立委托，格式為：
public delegate void 委托名(object sender, EventArgs e);
注意：委托即C里的函數指針，在事件中由于要傳遞事件及觸發事件的對象的信息，因此參數表是固定的。委托名一般格式是：名字+EnvenHandle。這樣取名比較規范。

然后，建立一個事件字段：
public event 委托類型事件名；
注意：event關鍵字代表事件，返回類型為委托；

再定義一個方法，處理事件，再本例中為OnFileChange（EventArgs e)。在該方法中應該調用事件：
事件名（object ,EventArgs)；
這里object一般為本身，實參應為this，EventArgs應為OnFileChange中傳遞過來的實參，尤其是要傳遞事件的值。

最后還要創建觸發事件的方法。例子中為MonitorFile()，在其方法中，當條件滿足則調用OnFileChange來達到觸發事件的目的。

在使用事件時，通常要定義兩個方法，一個是和事件定義的委托簽名一致的方法，在本例中為OnFileChange(Object sender,EventArgs e)；

注意在例子中，窗體類的OnFileChange和事件類的OnFileChange是不同的。后者用于調用事件，前者則用于綁定事件。綁定事件的方法很簡單，用+=表示添加事件，-=表示刪除事件。
例子中
FileWatchEventSource.FileWatchEvent+=new Sample.Event.FileWatchEventHandler(OnFileChange);
即為添加事件。

例子中：首先線程啟動（thd.Start()），然后調用MonitorFile()方法。引起事件產生，FileWatchEvent產生后，由于我們將事件FileWatchEvent綁定到了OnFileChange()方法上。因而調用本地即窗口類的OnFileChange()方法，從而實現在ListBox中添加信息。

上一篇：C# IsDefined的問題

下一篇：automation服務器不能創建對象解決方法