C#中自定义事件
一、了解C#中的预定义事件处理机制
在写代码前我们先来熟悉.net框架中和事件有关的类和委托,了解C#中预定义事件
的处理。
EventArgs是包含事件数据的类的基类,用于传递事件的细节。
EventHandler是一个委托声明如下
public delegate void EventHandler( object sender , EventArgs e )
注意这里的参数,前者是一个对象(其实这里传递的是对象的引用,如果是button1
的click事件则sender就是button1),后面是包含事件数据的类的基类。
下面我们研究一下Button类看看其中的事件声明(使用WinCV工具查看),以Click
事件为例。
public event EventHandler Click;
这里定义了一个EventHandler类型的事件Click
前面的内容都是C#在类库中已经为我们定义好了的。下面我们来看编程时产生的代
码。
private void button1_Click(object sender, System.EventArgs e)
{
...
}
这是我们和button1_click事件所对应的方法。注意方法的参数符合委托中的签名(
既参数列表)。那我们怎么把这个方法和事件联系起来呢,请看下面的代码。
this.button1.Click += new System.EventHandler(this.button1_Click);
把this.button1_Click方法绑定到this.button1.Click事件。
下面我们研究一下C#事件处理的工作流程,首先系统会在为我们创建一个在后台监
听事件的对象(如果是button1的事件那么监听事件的就是button1),这个对象用来产生
事件,如果有某个用户事件发生则产生对应的应用程序事件,然后执行订阅了事件的所
有方法。
二、简单的自定义事件(1)
首先我们需要定义一个类来监听客户端事件,这里我们监听键盘的输入。
定义一个委托。
public delegate void UserRequest(object sender,EventArgs e);
前面的object用来传递事件的发生者,后面的EventArgs用来传递事件的细节,现在
暂时没什么用处,一会后面的例子中将使用。
下面定义一个此委托类型类型的事件
public event UserRequest OnUserRequest;
下面我们来做一个死循环
public void Run() { bool finished=false; do {
if (Console.ReadLine()=="h") { OnUserRequest(this,new
EventArgs()); } }while(!finished); }
此代码不断的要求用户输入字符,如果输入的结果是h,则触发OnUserRequest事件,
事件的触发者是本身(this),事件细节无(没有传递任何参数的EventArgs实例)。我们
给这个类取名为UserInputMonitor。
下面我们要做的是定义客户端的类
首先得实例化UserInputMonitor类
UserInputMonitor monitor=new UserInputMonitor();
然后我们定义一个方法。
private void ShowMessage(object sender,EventArgs e)
{
Console.WriteLine("HaHa!!");
}
最后要做的是把这个方法和事件联系起来(订阅事件),我们把它写到库户端类的
构造函数里。
Client(UserInputMonitor m)
{
m.OnUserRequest+=new UserInputMonitor.UserRequest(this.ShowMessage);
//m.OnUserRequest+=new m.UserRequest(this.ShowMessage);
//注意这种写法是错误的,因为委托是静态的
}
下面创建客户端的实例。
new Client(monitor);
对了,别忘了让monitor开始监听事件。
monitor.run();
大功告成,代码如下:
using System;
class UserInputMonitor{
public delegate void UserRequest(object sender,EventArgs e); //定义委托
public event UserRequest OnUserRequest; //此委托类型类型的事件
public void Run()
{
bool finished=false;
do
{ if (Console.ReadLine()=="h")
{
OnUserRequest(this,new EventArgs());
}
}while(!finished);
}
}
public class Client{
public static void Main()
{
UserInputMonitor monitor=new UserInputMonitor();
new Client(monitor);
monitor.Run();
}
private void ShowMessage(object sender,EventArgs e)
{
Console.WriteLine("HaHa!!");
}
Client(UserInputMonitor m)
{
m.OnUserRequest+=new UserInputMonitor.UserRequest(this.ShowMessage);
//m.OnUserRequest+=new m.UserRequest(this.ShowMessage); //注意这种写法是错误
的,因为委托是静态的
}
}
三、进一步研究C#中的预定义事件处理机制
可能大家发现在C#中有些事件和前面的似乎不太一样。例如
private void textBox1_KeyPress(object
sender,System.Windows.Forms.KeyPressEventArgs e)
{ this.textBox1.KeyPress+=newSystem.Windows.Forms.KeyPressEventHandler
(this.textBox1_KeyPress);
}
这里使用了KeyPressEventArgs而不是EventArgs作为参数。这里使用了
KeyEventHandler委托,而不是EventHandler委托。
KeyPressEventArgs是EventArgs的派生类,而KeyEventHandler的声明如下
public delegate void KeyEventHandler( object sender , KeyEventArgs e );
是参数为KeyEventArgs的委托。那为什么KeyPress事件要这么做呢,我们可以从两个
类的构造函数来找答案。
public EventArgs();
public KeyPressEventArgs(char keyChar);
这里的keyData是什么,是用来传递我们按下了哪个键的,哈。
我在KeyEventArgs中又发现了属性
public char KeyChar { get; }
进一步证明了我的理论。下面我们来做一个类似的例子来帮助理解。
四、简单的自定义事件(2)
拿我们上面做的例子来改。
我们也定义一个EventArgs(类似KeyEventArgs)取名MyEventArgs,定义一个构造函
数public MyEventArgs(char keyChar),同样我们也设置相应的属性。代码如下
using System;
class MyMyEventArgs:EventArgs{
private char keyChar;
public MyMyEventArgs(char keyChar)
{ this.keychar=keychar; }
public char KeyChar
{ get { return keyChar; } }}
因为现在要监听多个键了,我们得改写监听器的类中的do...while部分。改写委托,改
写客户端传递的参数。好了最终代码如下,好累
using System;
class MyEventArgs:EventArgs
{
private char keyChar;
public MyEventArgs(char keyChar)
{ this.keyChar=keyChar; }
public char KeyChar
{ get { return keyChar; } }
}
class UserInputMonitor
{
public delegate void UserRequest(object sender,MyEventArgs e); //定义委托
public event UserRequest OnUserRequest; //此委托类型类型的事件
public void Run()
{ bool finished=false;
do { string inputString= Console.ReadLine();
if (inputString!="")
OnUserRequest(this,new MyEventArgs(inputString[0]));
}while(!finished);
}
}
public class Client
{
public static void Main()
{
UserInputMonitor monitor=new UserInputMonitor();
new Client(monitor);
monitor.Run();
}
private void ShowMessage(object sender,MyEventArgs e)
{ Console.WriteLine("捕捉到:{0}",e.KeyChar); }
Client(UserInputMonitor m)
{
m.OnUserRequest+=new UserInputMonitor.UserRequest(this.ShowMessage);
//m.OnUserRequest+=new m.UserRequest(this.ShowMessage); //注意这种写法是错误的,因为委托是静
}
}
=======================================================================================
C#中事件处理的个人体会
事件的简单解释:
事件是对象发送的消息,以发信号通知操作的发生。操作可能是由用户交互(例如鼠标单击)引起的,也可能是由某些其他的程序逻辑触发的。引发(触发)事件的对象叫做事件发送方。捕获事件并对其作出响应的对象叫做事件接收方。
在事件通信中,事件发送方类不知道哪个对象或方法将接收到(处理)它引发的事件。所需要的是在源和接收方之间存在一个媒介(或类似指针的机制)。.NET Framework 定义了一个特殊的类型(Delegate),该类型提供函数指针的功能。
与其他的类不同,委托类具有一个签名,并且它只能对与其签名匹配的方法进行引用。这样,委托就等效于一个类型安全函数指针或一个回调。
C#中使用事件需要的步骤:
-
创建一个委托
-
将创建的委托与特定事件关联(.Net类库中的很多事件都是已经定制好的,所以他们也就有相应的一个委托,在编写关联事件处理程序--也就是当有事件发生时我们要执行的方法的时候我们需要和这个委托有相同的签名)
-
编写事件处理程序
-
利用编写的事件处理程序生成一个委托实例
-
把这个委托实例添加到产生事件对象的事件列表中去,这个过程又叫订阅事件
C#中事件产生和实现的流程:
-
定义A为产生事件的实例,a为A产生的一个事件
-
定义B为接收事件的实例,b为处理事件的方法
-
A由于用户(程序编写者或程序使用者)或者系统产生一个a事件(例如点击一个Button,产生一个Click事件)
-
A通过事件列表中的委托对象将这个事件通知给B
-
B接到一个事件通知(实际是B.b利用委托来实现事件的接收)
-
调用B.b方法完成事件处理
下面给出《C#入门经典》的例子,并做一定的解释:
//====================Connection.cs===========
//事件定义,也就是上面提到的A
//============================================
using System;
using System.Timers;
namespace Ch12Ex02
{
/// <summary>
/// Connection 的摘要说明。
/// </summary>
///
public delegate void MessageHandler(string messageText);//创建一个委托---步骤1
public class Connection
{
public event MessageHandler MessageArrived;//将创建的委托和特定事件关联,在这里特定的事件为MessageArrived ---步骤2*/
/*上面这语句值得注意的地方是 MessageArrived方法被关联到MessageHandler上后,以后消息的传递就通过MessageHandler这个委托来实现,所以如果要能接收这个消息,就必须能支持MessageHandler这个委托,也就是要有一个和委托一样的签名
private Timer pollTimer;
public Connection()
{
//
// TODO: 在此处添加构造函数逻辑
//
pollTimer=new Timer(100);
pollTimer.Elapsed+=new ElapsedEventHandler(CheckForMessage);
}
public void Connect()
{
pollTimer.Start();
}
public void Disconnect()
{
pollTimer.Stop();
}
public void CheckForMessage(object sender,ElapsedEventArgs e)
{
Console.WriteLine("Check for message.");
Random random=new Random();
if((random.Next(9)==0)&&(MessageArrived!=null))
{
MessageArrived("Hello Mum!");//程序编写者自己产生一个消息,消息的内容为Hello Mum!
}
}
}
}
//====================Display.cs===========
//接收事件的类,也就是上面提到的B
//=========================================
using System;
namespace Ch12Ex02
{
/// <summary>
/// Display 的摘要说明。
/// </summary>
public class Display
{
public Display()
{
//
// TODO: 在此处添加构造函数逻辑
//
}
public void DisplayMessage(string message) //a事件的最终处理函数,即上面的B.b,在main函数中,我们会使用本函数实现一个委托实例,并且添加到A的MessageArrived事件列表中--步骤3
{
Console.WriteLine("Message Arrived:{0}",message);
}
}
}
//====================Class1.cs=================
//一个控制台可执行类,主要是使用上面两个类的实例
//==============================================
using System;
namespace Ch12Ex02
{
/// <summary>
/// Class1 的摘要说明。
/// </summary>
class Class1
{
/// <summary>
/// 应用程序的主入口点。
/// </summary>
[STAThread]
static void Main(string[] args)
{
//
// TODO: 在此处添加代码以启动应用程序
//
Connection myConnection=new Connection();
Display myDisplay=new Display();
myConnection.MessageArrived+=new MessageHandler(myDisplay.DisplayMessage);//把委托添加到当前A的事件列表中----步骤4和步骤5
myConnection.Connect();
Console.ReadLine();
}
}
}
值得注意的代码:
public delegate void MessageHandler(string messageText);//委托定义
public event MessageHandler MessageArrived;//定义一个事件,并且关联到一个委托上
myConnection.MessageArrived+=new MessageHandler(myDisplay.DisplayMessage);//产生一个委托实例,并通过+=运算符号添加到事件列表中 +=运算符号在这里非常的有用