c# 事件详解

首先我们来了解一下事件的基本条件

  事件的用途

事件就是发行者向接受者通知发送相关事情。

发送事件的类称为发行者，接受事件的类称为订户。

特点

一个事件可有多个订户。反过来一个订户可处理来自多个发行者的多个事件。

没有订户事件将永远不会触发

如何订阅和取消事件

如果你想编写引发事件时调用的自定义代码，则可以订阅由其他类发布的事件。

1 定义一个事件处理程序方法，其签名应该与事件的委托签名匹配。

如果事件基于EventHandler委托类型，则下面的代码表示存根

void HandleCustomEvent(object sender,CustomerEventArgs a)

{

　　// Do something;

}

2 使用加法赋值运算符号(+=) 来为事件附加事件处理程序。假设名为publisher对象拥有一个名为RaiseCustomEvent的事件。注意订户类需要引用发行类才能订阅其事件。

publisher.RaiseCustomEvent += HandleCustomEvent;
请注意，前面的语法是 C# 2.0 中的新语法。 此语法完全等效于必须使用 new 关键字显式创建封装委托的 C# 1.0 语法：

publisher.RaiseCustomEvent += new CustomEventHandler(HandleCustomEvent);
使用匿名方法订阅事件
如果以后不必取消订阅某个事件，则可以使用加法赋值运算符 (+=) 将匿名方法附加到此事件。 在下面的示例中，假设名为 publisher 的对象拥有一个名为 RaiseCustomEvent 的事件，并且还定义了一个 CustomEventArgs 类以承载某些类型的专用事件信息。 请注意，订户类需要引用 publisher 才能订阅其事件。
 publisher.RaiseCustomEvent += delegate(object o, CustomEventArgs e)
  {
    string s = o.ToString() + " " + e.ToString();
    Console.WriteLine(s);
  };
请务必注意，如果使用匿名函数订阅事件，事件的取消订阅过程将比较麻烦。 这种情况下若要取消订阅，必须返回到该事件的订阅代码，将该匿名方法存储在委托变量中，然后将此委托添加到该事件中。 一般来说，如果必须在后面的代码中取消订阅某个事件，则建议您不要使用匿名函数订阅此事件。
取消订阅事件
 要防止在事件发生时调用事件处理程序，此时则可以取消订阅事件。
要防止资源泄露，应在释放订户对象之前取消订阅事件。
在取消订阅事件之前，在发布对象中作为该事件的基础的多路广播委托会引用封装了订户的事件处理程序的委托。 只要发布对象保持该引用，垃圾回收功能就不会删除订户对象。

publisher.RaiseCustomEvent -= HandleCustomEvent;
发布.NET FrameWork 准则事件
在.net Framework类库中所有事件都是基于EventHandler委托

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

虽然类中的事件可基于任何有效委托类型，但是，我们应该使用EventHandler让事件基于.NET Framwwork
如下
 1 在发行者类和订阅方类均可看见的范围中声明自定义数据的类。 然后添加保留您的自定义事件数据所需的成员。 在此示例中，会返回一个简单字符串。

public class CustomEventArgs : EventArgs
{
    public CustomEventArgs(string s)
    {
        msg = s;
    }
    private string msg;
    public string Message
    {
        get { return msg; }
    } 
}

2 在发布类中声明一个委托。 为它指定以 EventHandler 结尾的名称。 第二个参数指定自定义 EventArgs 类型。

public delegate void CustomEventHandler(object sender, CustomEventArgs a);

使用以下任一步骤，在发布类中声明事件。

A 如果没有自定义 EventArgs 类，事件类型就是非泛型 EventHandler 委托。 无需声明委托，因为它已在创建 C# 项目时包含的 System命名空间中进行了声明。 将以下代码添加到发行者类中。

 

public event EventHandler RaiseCustomEvent;

 

 

B 如果使用的是 EventHandler 的非泛型版本，并且您有一个由 EventArgs 派生的自定义类，请在发布类中声明您的事件，并且将来自步骤 2 的委托用作类型。

public event CustomEventHandler RaiseCustomEvent;
下面是一个完整的实例

 

namespace DotNetEvents
{
    using System;
    using System.Collections.Generic;

 

    // Define a class to hold custom event info
    public class CustomEventArgs : EventArgs
    {
        public CustomEventArgs(string s)
        {
            message = s;
        }
        private string message;

 

        public string Message
        {
            get { return message; }
            set { message = value; }
        }
    }

 

    // Class that publishes an event
    class Publisher
    {

 

        // Declare the event using EventHandler<T>
        public event EventHandler<CustomEventArgs> RaiseCustomEvent;

 

        public void DoSomething()
        {
            // Write some code that does something useful here
            // then raise the event. You can also raise an event
            // before you execute a block of code.
            OnRaiseCustomEvent(new CustomEventArgs("Did something"));

 

        }

 

        // Wrap event invocations inside a protected virtual method
        // to allow derived classes to override the event invocation behavior
        protected virtual void OnRaiseCustomEvent(CustomEventArgs e)
        {
            // Make a temporary copy of the event to avoid possibility of
            // a race condition if the last subscriber unsubscribes
            // immediately after the null check and before the event is raised.
            EventHandler<CustomEventArgs> handler = RaiseCustomEvent;

 

            // Event will be null if there are no subscribers
            if (handler != null)
            {
                // Format the string to send inside the CustomEventArgs parameter
                e.Message += String.Format(" at {0}", DateTime.Now.ToString());

 

                // Use the () operator to raise the event.
                handler(this, e);
            }
        }
    }

 

    //Class that subscribes to an event
    class Subscriber
    {
        private string id;
        public Subscriber(string ID, Publisher pub)
        {
            id = ID;
            // Subscribe to the event using C# 2.0 syntax
            pub.RaiseCustomEvent += HandleCustomEvent;
        }

 

        // Define what actions to take when the event is raised.
        void HandleCustomEvent(object sender, CustomEventArgs e)
        {
            Console.WriteLine(id + " received this message: {0}", e.Message);
        }
    }

 

    class Program
    {
        static void Main(string[] args)
        {
            Publisher pub = new Publisher();
            Subscriber sub1 = new Subscriber("sub1", pub);
            Subscriber sub2 = new Subscriber("sub2", pub);

 

            // Call the method that raises the event.
            pub.DoSomething();

 

            // Keep the console window open
            Console.WriteLine("Press Enter to close this window.");
            Console.ReadLine();

 

        }
    }
}