C#委托和事件

委托

委托与事件，经常拿来就用，往往忘记其实现原理，对其使用方式也越来越局限。周家安老师在《C# 6.0 学习笔记》中对委托和事件的讲解，深入浅出，清晰明了，故特意摘抄一篇随笔，勤看勤思。

首先，委托是一种形式上与方法签名相似的类型。

定义一个委托：

public delegate void DoSome(string msg);

 

使用关键字 delegate, 类型名称为 DoSome(string msg).

 

 

创建一个DoSome(string msg)委托类型对象，并实例化。

static void TestDo(string str)
{
     // ToDo
}


DoSome d1 = new DoSome(TestDo);


// 或者

DoSome  d2;

d2 = TestDo;

 委托列表

public delegate void DoSome(string msg);
static void Main(string[] args)
{
    DoSome d = new DoSome(TestDo);
    d("Hello");
    Console.WriteLine("--------------------------------------");
    d += new DoSome(Test1);
    d("123");
    Console.WriteLine("--------------------------------------");
    d += TDo2;
    d("world");
    Console.WriteLine("--------------------------------------");
    d -= TestDo;
    d("nihao");
}

static void TestDo(string str)
{
    Console.WriteLine(str);
}

static void Test1(string str)
{
    Console.WriteLine("Test1 + " + str);
}
static void TDo2(string str)
{
    Console.WriteLine("TDo2 + " + str);
}

输出：

 

事件

 事件自身就是委托类型。

    class MyApp
    {
        public delegate void SpaceKeyPressedEventHandler();

        // 声明事件
        public event SpaceKeyPressedEventHandler SpaceKeyPressed;

        // 通过该方法引发事件
        protected virtual void OnSpaceKeyPressed()
        {

            if (this.SpaceKeyPressed != null)
            {
                // 将事件分发
                SpaceKeyPressed();
            }
        }

        // 启动事件监听的接口
        public void StartRun()
        {
            // 监听事件
            while (true)
            {
                ConsoleKeyInfo keyinfo = Console.ReadKey();
                if (keyinfo.Key == ConsoleKey.Spacebar)
                {
                    // 引发事件
                    OnSpaceKeyPressed();
                }

                if (keyinfo.Key == ConsoleKey.Escape)
                {
                    // 跳出循环
                    break;
                }
            }
        }
    }

    class Program
    {
       
        static void Main(string[] args)
        {
            MyApp app = new MyApp();
            // 订阅事件，指定处理事件的方法
            app.SpaceKeyPressed += app_SpaceKeyPressed;
            app.SpaceKeyPressed += app_SecondEventHandler;

            // 启动事件监听
            app.StartRun();
        
        }   

        // 事件处理1
        private static void app_SpaceKeyPressed()
        {
            Console.WriteLine("{0} 按下空格键。", DateTime.Now.ToLongTimeString());
        }
        // 事件处理2
        private static void app_SecondEventHandler()
        {
            Console.WriteLine("事件的第二个处理方法。");
        }

    }

通常，作为事件委托，有两个参数，一个是Object类型，表示引发事件的对象，即是谁引发了事件的，多数情况下在调用事件时是把类的当前实例引用（this）传递过去。另一个参数是从System.EventArgs派省的类的实例。这是一个标准的事件处理程序的签名，为了规范事件的处理，.NET类库已经定义好一个System.EventHandler委托，用于声明事件。它的原型如下：

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

 引发事件的对象实例将传递给sender参数，而与事件相关的数据则传递给e参数。如果不需要传递过多的数据，可以通过System.EventArgs.Empty静态成员返回一个空的EventArgs对象类传递。

但是，由于不同的事件要传递的参数不同，更多时候是从EventArgs类派生的子类的实例，显然一个EventHandler委托是不能满足各种情况的。如果针对不同的事件也顶一个一个对应的委托，水量一旦多起来，既混乱，也不好管理。为了解决这个问题，.NET类库又提供了一个带有泛型参数的事件处理委托。原型如下：

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

TEventArgs 是一个泛型参数，应该是System.EventArgs类或者System.EventArgs类的派生类型。

泛型参数的事件，实例：

    // EventArgs 派生类
    // 创建泛型参数  KeyPressedEventArgs 类
    public class KeyPressedEventArgs : EventArgs
    {
        public ConsoleKey pressedKey { get; private set; }
        public KeyPressedEventArgs(ConsoleKey key)
        {
            pressedKey = key;
        }
    }

    public class MyApp
    {
        // 捕捉按键的事件 声明一个泛型参数KeyPressedEventArgs类型的
        public event EventHandler<KeyPressedEventArgs> KeyPressed;

        // 通过该方法引发事件
        protected virtual void OnKeyPressed(KeyPressedEventArgs e)
        {
            if (this.KeyPressed != null )
            {
                this.KeyPressed(this, e);
            }
        }

        // 事件监听端口启动
        public void Start()
        {
            while (true)
            {
                ConsoleKeyInfo keyInfo = Console.ReadKey();
                // 如果按下了ESC键，则退出循环
                if (keyInfo.Key == ConsoleKey.Escape)
                {
                    break;
                }
                // 引发事件
                OnKeyPressed(new KeyPressedEventArgs(keyInfo.Key));
            }
        }
    }


    class Program
    {
       
        static void Main(string[] args)
        {
            
            MyApp app = new MyApp();
            // 订阅事件，指定处理事件的方法
            app.KeyPressed += app_KeyPressed;
            // 启动事件监听
            app.Start();
        }   

        // 事件处理
        private static void app_KeyPressed(Object sender, KeyPressedEventArgs e)
        {
            Console.WriteLine("已按下 {0} 键", e.pressedKey.ToString());
        }
        
    }