C#事件Event_c# event

委托delegate是C#中的一种类型，它实际上是一个能够持有对某个方法的引用的类。与其它的类不同，delegate类能够拥有一个签名（signature），并且它"只能持有与它的签名相匹配的方法的引用"。它所实现的功能与C/C++中的函数指针十分相似。它允许你传递一个类A的方法m给另一个类B的对象，使得类B的对象能够调用这个方法m。但与函数指针相比，delegate有许多函数委托和事件在 .Net Framework中的应用非常广泛指针不具备的优点。首先，函数指针只能指向静态函数，而delegate既可以引用静态函数，又可以引用非静态成员函数。在引用非静态成员函数时，delegate不但保存了对此函数入口指针的引用，而且还保存了调用此函数的类实例的引用。其次，与函数指针相比，delegate是面向对象、类型安全、可靠的受控（managed）对象。也就是说，runtime能够保证delegate指向一个有效的方法，你无须担心delegate会指向无效地址或者越界地址。

实现一个delegate是很简单的，通过以下3个步骤即可实现一个delegate：
1． 声明一个delegate对象，它应当与你想要传递的方法具有相同的参数和返回值类型。
2． 创建delegate对象，并"将你想要传递的函数作为参数传入"。
3． 在要实现异步调用的地方，通过上一步创建的对象来调用方法。

using System;

public class MyDelegateTest
{
        // 步骤1，声明delegate对象
        public delegate void MyDelegate(string name);

        // 这是我们欲传递的方法，它与MyDelegate具有相同的参数和返回值类型
        public static void MyDelegateFunc(string name)
        {
                  Console.WriteLine("Hello, ", name);
        }
        public static void Main()
        {
                  // 步骤2，创建delegate对象(实例？？)
 MyDelegate md = new MyDelegate(MyDelegateTest.MyDelegateFunc);
                 // 步骤3，调用delegate
                 md("sam1111");
        }
}
输出结果是：Hello, sam1111

了解了delegate，下面我们来看看，在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!

二、自定义事件：

1. 定义事件所需要的附加信息

　　按照约定，所有的事件的附加信息都应该从EventArgs派生，因为我们希望一看就知道这是个事件附加信息参数，而不是其它的。EventArgs的定义如下：

public class EventArgs {
    public static readonly EventArgs Empty = new EventArgs();
    public EventArgs() {}
}

可以看到，该类有一个静态只读字段Empty，这是一个单例；与String.Empty一样，当我们需要一个空的EventArgs时，应该使用EventArgs.Empty，而不是重新去new一个。

　　我们定义一个NewMailEventArgs参数，如下：

class NewMailEventArgs : EventArgs
{
    private string from;
    private string to;
    private string content;
 
    public string From { get { return from; } }
    public string To { get { return to; } }
    public string Content { get { return content; } }
 
    public NewMailEventArgs(string from,string to,string content)
    {
        this.from = from;
        this.to = to;
        this.content = content;
    }
}

2. 定义事件

c#里定义事件用到了event关键字，而且事件一般都是公开类型的。我们定义一个NewMail事件如下：

public event EventHandler NewMail;

我们说NewMail是一个事件，但.net并没有事件这种类型。实际上，这里它是一个EventHandler委托（委托又是引用类型），只不过用了event进行修饰，也可以说它是一种具有事件性质的委托。

　　我们知道委托是用来包装回调函数的，它的本质是一个class，回调函数的签名必须与委托的签名一致。一个事件可以有多个处理函数，一个函数就会被包装成一个委托对象，所有的委托对象都保存在NewMail的委托链当中。所以，触发NewMail事件，其实就是遍历其指向的委托对象的委托链，执行每个委托对象所包装的方法。

　　EventHandler 是个泛型委托，他的定义如下：

public delegate void EventHandler(object sender, TEventArgs e);

　这里有两个特点：1. 返回值是void，这是因为事件处理函数一般不需要有返回值，.net中大部分的事件处理函数都是没有返回值的。2. object类型的sender参数，这表示事件的拥有者；这也很符合逻辑，我们除了要拿到实际的附加信息外，还要知道事件是从哪里来的；至于为什么是object类型的，是因为这样可以给更多的类型使用。

3. 定义事件触发函数　　

//3.定义触发事件的方法

protected virtual void OnNewMail(NewMailEventArgs e)

{

   \/* 第1种做法            

     if(this.NewMail != null)

     {

        this.NewMail(this,e);

     }            

     *\/

    \/* 第二种做法

    EventHandler temp = this.NewMail;

    if (temp != null)

    {

        temp(this, e);

    }

    *\/

    //第三种做法

    EventHandler temp = Interlocked.CompareExchange(ref this.NewMail, null, null);

    if (temp != null)

    {

        temp(this, e);

    }

}

第一种做法是很常见的做法，判断不为空，然后就触发。CLR里提到这是线程不安全的做法，因为当我们判断不为空后，准备执行时，另一个线程将从委托链将委托移除，此时变成了空，引发NullReferenceException异常。第二、三种做法都是线程安全的，因为它通过一个临时委托变量（委托链保存了所有委托），通过上一篇对委托链的了解，我们知道对委托链进行Combine/Remove实际都会创建一个新的数组对象，此时对temp没有影响。但实际上事件主要在单线程的环境下使用，所以一般也不会出现这种问题。

4. 包装好事件参数，调用事件触发函数。

public void ReceiveNewMail(string from, string to, string content)

{

    NewMailEventArgs e = new NewMailEventArgs(from, to, content);

    OnNewMail(e);

}

接下来，对该事件感兴趣的，就可以对该事件进行注册。

class Fax

{

    public Fax(MailManager mm)

    {

        mm.NewMail += FaxMsg;

    }

    private void FaxMsg(object sender, NewMailEventArgs e)

    {

        Console.WriteLine(string.Format("fax receive，from:{0} to:{1} content is:{2}", e.From, e.To, e.Content));

    }

}