C# 事件(Event)
事件(Event) 基本上说是一个用户操作,如按键、点击、鼠标移动等等,或者是一些提示信息,如系统生成的通知。应用程序需要在事件发生时响应事件。例如,中断。
C# 中使用事件机制实现线程间的通信。
通过事件使用委托
事件在类中声明且生成,且通过使用同一个类或其他类中的委托与事件处理程序关联。包含事件的类用于发布事件。这被称为 发布器(publisher) 类。其他接受该事件的类被称为 订阅器(subscriber) 类。事件使用 发布-订阅(publisher-subscriber) 模型。
发布器(publisher) 是一个包含事件和委托定义的对象。事件和委托之间的联系也定义在这个对象中。发布器(publisher)类的对象调用这个事件,并通知其他的对象。
订阅器(subscriber) 是一个接受事件并提供事件处理程序的对象。在发布器(publisher)类中的委托调用订阅器(subscriber)类中的方法(事件处理程序)。
声明事件(Event)
在类的内部声明事件,首先必须声明该事件的委托类型。例如:
public delegate void BoilerLogHandler(string status);
然后,声明事件本身,使用 event 关键字:
// 基于上面的委托定义事件 public event BoilerLogHandler BoilerEventLog;
上面的代码定义了一个名为 BoilerLogHandler 的委托和一个名为 BoilerEventLog 的事件,该事件在生成的时候会调用委托。
实例
实例 1
using System;
namespace SimpleEvent
{
using System;
/***********发布器类***********/
public class EventTest
{
private int value;
public delegate void NumManipulationHandler();
public event NumManipulationHandler ChangeNum;
protected virtual void OnNumChanged()
{
if ( ChangeNum != null )
{
ChangeNum(); /* 事件被触发 */
}else {
Console.WriteLine( "event not fire" );
Console.ReadKey(); /* 回车继续 */
}
}
public EventTest()
{
int n = 5;
SetValue( n );
}
public void SetValue( int n )
{
if ( value != n )
{
value = n;
OnNumChanged();
}
}
}
/***********订阅器类***********/
public class subscribEvent
{
public void printf()
{
Console.WriteLine( "event fire" );
Console.ReadKey(); /* 回车继续 */
}
}
/***********触发***********/
public class MainClass
{
public static void Main()
{
EventTest e = new EventTest(); /* 实例化对象,第一次没有触发事件 */
subscribEvent v = new subscribEvent(); /* 实例化对象 */
e.ChangeNum += new EventTest.NumManipulationHandler( v.printf ); /* 注册 */
e.SetValue( 7 );
e.SetValue( 11 );
}
}
}
namespace SimpleEvent
{
using System;
/***********发布器类***********/
public class EventTest
{
private int value;
public delegate void NumManipulationHandler();
public event NumManipulationHandler ChangeNum;
protected virtual void OnNumChanged()
{
if ( ChangeNum != null )
{
ChangeNum(); /* 事件被触发 */
}else {
Console.WriteLine( "event not fire" );
Console.ReadKey(); /* 回车继续 */
}
}
public EventTest()
{
int n = 5;
SetValue( n );
}
public void SetValue( int n )
{
if ( value != n )
{
value = n;
OnNumChanged();
}
}
}
/***********订阅器类***********/
public class subscribEvent
{
public void printf()
{
Console.WriteLine( "event fire" );
Console.ReadKey(); /* 回车继续 */
}
}
/***********触发***********/
public class MainClass
{
public static void Main()
{
EventTest e = new EventTest(); /* 实例化对象,第一次没有触发事件 */
subscribEvent v = new subscribEvent(); /* 实例化对象 */
e.ChangeNum += new EventTest.NumManipulationHandler( v.printf ); /* 注册 */
e.SetValue( 7 );
e.SetValue( 11 );
}
}
}
当上面的代码被编译和执行时,它会产生下列结果:
event not fire event fire event fire
本实例提供一个简单的用于热水锅炉系统故障排除的应用程序。当维修工程师检查锅炉时,锅炉的温度和压力会随着维修工程师的备注自动记录到日志文件中。
实例 2
using System;
using System.IO;
namespace BoilerEventAppl
{
// boiler 类
class Boiler
{
private int temp;
private int pressure;
public Boiler(int t, int p)
{
temp = t;
pressure = p;
}
public int getTemp()
{
return temp;
}
public int getPressure()
{
return pressure;
}
}
// 事件发布器
class DelegateBoilerEvent
{
public delegate void BoilerLogHandler(string status);
// 基于上面的委托定义事件
public event BoilerLogHandler BoilerEventLog;
public void LogProcess()
{
string remarks = "O. K";
Boiler b = new Boiler(100, 12);
int t = b.getTemp();
int p = b.getPressure();
if(t > 150 || t < 80 || p < 12 || p > 15)
{
remarks = "Need Maintenance";
}
OnBoilerEventLog("Logging Info:\n");
OnBoilerEventLog("Temparature " + t + "\nPressure: " + p);
OnBoilerEventLog("\nMessage: " + remarks);
}
protected void OnBoilerEventLog(string message)
{
if (BoilerEventLog != null)
{
BoilerEventLog(message);
}
}
}
// 该类保留写入日志文件的条款
class BoilerInfoLogger
{
FileStream fs;
StreamWriter sw;
public BoilerInfoLogger(string filename)
{
fs = new FileStream(filename, FileMode.Append, FileAccess.Write);
sw = new StreamWriter(fs);
}
public void Logger(string info)
{
sw.WriteLine(info);
}
public void Close()
{
sw.Close();
fs.Close();
}
}
// 事件订阅器
public class RecordBoilerInfo
{
static void Logger(string info)
{
Console.WriteLine(info);
}//end of Logger
static void Main(string[] args)
{
BoilerInfoLogger filelog = new BoilerInfoLogger("e:\\boiler.txt");
DelegateBoilerEvent boilerEvent = new DelegateBoilerEvent();
boilerEvent.BoilerEventLog += new
DelegateBoilerEvent.BoilerLogHandler(Logger);
boilerEvent.BoilerEventLog += new
DelegateBoilerEvent.BoilerLogHandler(filelog.Logger);
boilerEvent.LogProcess();
Console.ReadLine();
filelog.Close();
}//end of main
}//end of RecordBoilerInfo
}
using System.IO;
namespace BoilerEventAppl
{
// boiler 类
class Boiler
{
private int temp;
private int pressure;
public Boiler(int t, int p)
{
temp = t;
pressure = p;
}
public int getTemp()
{
return temp;
}
public int getPressure()
{
return pressure;
}
}
// 事件发布器
class DelegateBoilerEvent
{
public delegate void BoilerLogHandler(string status);
// 基于上面的委托定义事件
public event BoilerLogHandler BoilerEventLog;
public void LogProcess()
{
string remarks = "O. K";
Boiler b = new Boiler(100, 12);
int t = b.getTemp();
int p = b.getPressure();
if(t > 150 || t < 80 || p < 12 || p > 15)
{
remarks = "Need Maintenance";
}
OnBoilerEventLog("Logging Info:\n");
OnBoilerEventLog("Temparature " + t + "\nPressure: " + p);
OnBoilerEventLog("\nMessage: " + remarks);
}
protected void OnBoilerEventLog(string message)
{
if (BoilerEventLog != null)
{
BoilerEventLog(message);
}
}
}
// 该类保留写入日志文件的条款
class BoilerInfoLogger
{
FileStream fs;
StreamWriter sw;
public BoilerInfoLogger(string filename)
{
fs = new FileStream(filename, FileMode.Append, FileAccess.Write);
sw = new StreamWriter(fs);
}
public void Logger(string info)
{
sw.WriteLine(info);
}
public void Close()
{
sw.Close();
fs.Close();
}
}
// 事件订阅器
public class RecordBoilerInfo
{
static void Logger(string info)
{
Console.WriteLine(info);
}//end of Logger
static void Main(string[] args)
{
BoilerInfoLogger filelog = new BoilerInfoLogger("e:\\boiler.txt");
DelegateBoilerEvent boilerEvent = new DelegateBoilerEvent();
boilerEvent.BoilerEventLog += new
DelegateBoilerEvent.BoilerLogHandler(Logger);
boilerEvent.BoilerEventLog += new
DelegateBoilerEvent.BoilerLogHandler(filelog.Logger);
boilerEvent.LogProcess();
Console.ReadLine();
filelog.Close();
}//end of main
}//end of RecordBoilerInfo
}
当上面的代码被编译和执行时,它会产生下列结果:
Logging info: Temperature 100 Pressure 12 Message: O. K

文人墨客
using System; /***********发布器类***********/ public class EventTest { public delegate void NumManipulationHandler(string name, int a); //声明委托 public event NumManipulationHandler ChangeNum; //声明事件 public void OpenDoor(string name, int a)//模拟事件 { ChangeNum(name, a); //事件触发 } } /***********订阅器类***********/ public class subscribEvent { public void result(string name, int a) { Console.WriteLine("{0} is arriving at Airport Terminal{1}", name, a); } } /***********触发***********/ public class MainClass { public static void Main() { EventTest e = new EventTest(); /* 实例化事件触发对象 */ subscribEvent v = new subscribEvent(); /* 实例化订阅事件对象 */ /* 订阅器的printf()在事件触发对象中注册到委托事件中 */ e.ChangeNum += new EventTest.NumManipulationHandler(v.result); e.OpenDoor("Yang", 3); /* 模拟事件 */ } }文人墨客
一个很简单的例子:当宠物店有新狗时通知订阅客户。
using System; namespace BoilerEvent { class Dog { private String name; private String color; public delegate void Handeler(); //定义委托 public static event Handeler NewDog; //定义事件 public Dog(String Name, String Color) { name = Name; color = Color; if (NewDog != null) { Console.WriteLine("新进了一只狗"); NewDog(); //调用事件 } } } class Test { public static void Main(String[] args) { Dog d = new Dog("Tony","yellow"); //因为还没有添加订阅,所以不能触发事件 Dog.NewDog += new Dog.Handeler(Client1); //Client1添加订阅 Dog.NewDog += new Dog.Handeler(Client2);//Client2添加订阅 Dog d2 = new Dog("Tom", "white"); } static void Client1() { Console.WriteLine("我喜欢这条狗!"); } static void Client2() { Console.WriteLine("我非常想要!"); } } }文人墨客
明明可以很简单(对实例1的简单修改):
using System; namespace SimpleEvent { /***********发布器类***********/ public class EventTest { public delegate void NumManipulationHandler(); //声明委托 public event NumManipulationHandler ChangeNum; //声明事件 public void OpenDoor() { ChangeNum(); //事件触发 } } /***********订阅器类***********/ public class subscribEvent { public void printf() { Console.WriteLine( "The door is opened." ); } } /***********触发***********/ public class MainClass { public static void Main() { EventTest e = new EventTest(); /* 实例化事件触发对象 */ subscribEvent v = new subscribEvent(); /* 实例化订阅事件对象 */ /* 订阅器的printf()在事件触发对象中注册到委托事件中 */ e.ChangeNum += new EventTest.NumManipulationHandler( v.printf ); e.OpenDoor(); /* 触发了事件 */ } } }文人墨客
事件的运用总结
事件的整个过程是:订阅 -> 发布 -> 执行。
文人墨客
实例:
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace BoilerEvent_tz { class DelegateTest // 发布器类 { public delegate void delegate_tz(); public event delegate_tz delegate_tz0; public static void get() { Console.WriteLine("这是触发事件的第一个方法,此方法在事件类中"); } public void inter() { Console.WriteLine("开始调用事件方法"); delegate_tz0(); } } class Test // 订阅器类 { public Test() { } public void TryEvent() { Console.WriteLine("这是触发事件的第三个方法,在订阅器中,这才是正宗的订阅器类"); Console.ReadKey(); } } class Program //主体函数 程序入口 { static void Main(string[] args) { DelegateTest DelegateTest0 = new DelegateTest(); //主体函数中根据需求组装事件,组装过程类似委托多播 DelegateTest0.delegate_tz0 += new DelegateTest.delegate_tz(DelegateTest.get); DelegateTest0.delegate_tz0 += new DelegateTest.delegate_tz(Method1); DelegateTest0.delegate_tz0 += new DelegateTest.delegate_tz(new Test().TryEvent); DelegateTest0.inter(); // 执行操作,以触发事件 } static public void Method1() { Console.WriteLine("这是触发事件的第二个方法,在主体Main函数中"); } } }执行输出结果为:
文人墨客
delegate 相当于定义一个函数类型。
event 相当于定义一个 delegate 的函数指针(回调函数指针)。
这样就好理解了。
文人墨客
一个事件调用委托的简单例子:
using System; /*功能:当起床铃声响起,就引发学生起床/厨师做早餐两个事件 */ // 定义一个委托(也可以定义在Ring类里面) public delegate void DoSomething(); // 产生事件的类 public class Ring { // 声明一个委托事件 public event DoSomething doIt; // 构造函数 public Ring() { } // 定义一个方法,即"响铃" 引发一个事件 public void RaiseEvent() { Console.WriteLine("铃声响了......."); // 判断事件是否有调用委托(是不是要求叫学生起床,叫厨师做饭) if (null != doIt) { doIt(); // 如果有注册的对象,那就调用委托(叫学生起床,叫厨师做饭) }else{ Console.WriteLine("无事发生......."); //没有注册,事件没有调用任何委托 } } } // 学生类( 处理事件类一) public class HandleEventOfStudents { // 默认构造函数 public HandleEventOfStudents() { } //叫学生起床 public void GetUp() { Console.WriteLine("[学生]:听到起床铃声响了,起床了。"); } } // 校园厨师类(处理事件类二) public class HandleEventOfChefs { // 默认构造函数 public HandleEventOfChefs() { } //叫厨师做早餐 public void Cook() { Console.WriteLine("[厨师]:听到起床铃声响了,为学生做早餐。"); } } // 主类 public class ListenerEvent { public static void Main(String[] args) { Ring ring = new Ring(); // 实例化一个铃声类[它是主角,都是因为它才牵连一系列的动作] ring.doIt += new HandleEventOfStudents().GetUp; // 注册,学生委托铃声类,铃声响起的时候叫我起床. ring.doIt += new HandleEventOfChefs().Cook; // 注册,厨师告诉铃声类,我也委托你叫我什么时候做早餐 ring.RaiseEvent(); // 铃声响起来了,它发现学生和厨师都拜托(注册)了自己,然后它就开始叫学生起床,叫厨师做早餐(一个事件调用了两个委托) } }你可能发现,上面的注册代码和前面的例子都不一样。这是因为 ring.doIt 本来就是 DoSomething 类型的,C# 会自动把学生类方法转换成相同的类型(猜测,但是上面的代码可以完美运行)。当然上面的注册代码也可以写成和文章例子的一样。 改成这样 ring.doIt += new Ring.DoSomething(new HandleEventOfStudents().GetUp); 这样也可以实现,当然这样的话定义委托的语句就要写在 Ring 类里面了。
文人墨客
就第一篇笔记的具体实现:
using System; namespace CarEvent { public class Car { // 申明委托 public delegate void CarEngineHandler(string msg); // 创建委托实例Exploded和AboutToBlow事件 public event CarEngineHandler Exploded; public event CarEngineHandler AboutToBlow; //设置属性 public int CurrentSpeed { get; set; } public int MaxSpeed { get; set; } public string PetName { get; set; } public bool CarIsDead;//用于判断是否超速 public Car()//构造函数 { MaxSpeed = 100; } public Car(string name, int maxSp, int currSp)//构造函数重载 { CurrentSpeed = currSp; MaxSpeed = maxSp; PetName = name; } public void Accelerate(int delta)//用于触发Exploded和AboutToBlow事件 { CurrentSpeed += delta;//"踩油门"加速 if (CurrentSpeed >= MaxSpeed)//判断时速 CarIsDead = true; else CarIsDead = false; if (CarIsDead)// 如果Car超速了,触发Exploded事件 { if (Exploded != null)//判断是否被委托联系起来 { Exploded("sorry,this car is dead");//调用CarDead事件 } } else { //如果没有超速,则提示快要超速并显示实时车速 if ((MaxSpeed - CurrentSpeed) > 0 && (MaxSpeed - CurrentSpeed) <= 10 && AboutToBlow != null)//判断是否被委托联系起来且速度是否接近临界值 { AboutToBlow("careful buddy ! gonna blow !");//调用NearDead事件 Console.WriteLine("CurrentSpeed={0}",CurrentSpeed);//显示实时车速 } } } } //订阅类书写举例 public class Answer { public void CarDead(string msg)//汽车已爆缸事件 { Console.WriteLine("sorry,this car is dead"); } public void NearDead(string msg)//汽车快要爆缸事件 { Console.WriteLine("careful buddy ! gonna blow !"); } } //主函数书写 public class test { static void Main(string[] args) { Car c = new Car("奔驰",100,93);//创建实例并初始化,初始速度为93 Answer an = new Answer(); c.Exploded += new Car.CarEngineHandler(an.CarDead);//Exploded"绑定"CarDead c.AboutToBlow += new Car.CarEngineHandler(an.NearDead);//AboutToBlow"绑定"NearDead c.Accelerate(6);//第一次加速,时速小于100,引发的事件为"快要爆缸"并显示实时车速为99 Console.ReadLine();//等待回车键已启动第二次加速 c.Accelerate(2);//第二次加速,时速超过100,引发的事件为"已爆缸",不显示车速 Console.ReadKey(); } } }结果为:
文人墨客
一个最简单的例子,不带参数的事件。是实例 2 的一个简化版:
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace BoilerEvent_tz { class DelegateTest { public delegate void delegate_tz(); public event delegate_tz delegate_tz0; public void start() { Console.WriteLine("启动事件"); delegate_tz0(); // 得调用该事件呀 Console.ReadKey(); } } class Program { static void Main(string[] args) { DelegateTest DelegateTest0 = new DelegateTest(); //DelegateTest0.delegate_tz0 += DelegateTest.delegate_tz(test); // 必须new一下才行,因为它是另外一个类呀 DelegateTest0.delegate_tz0 += new DelegateTest.delegate_tz(test); DelegateTest0.start(); // 启动事件 } static public void test() { Console.WriteLine("这是一个被注册的函数,按任意键继续..."); Console.ReadKey(); } } }文人墨客
写一个最简单的使用事件的代码。帮助理解。
public class Car { // 这个委托用来与Car事件协作 public delegate void CarEngineHandler(string msg); // 这种汽车可以发送这些事件 public event CarEngineHandler Exploded; public event CarEngineHandler AboutToBlow; public int CurrentSpeed { get; set; } public int MaxSpeed { get; set; } public string PetName { get; set; } private bool CarIsDead; public Car() { MaxSpeed = 100; } public Car(string name, int maxSp, int currSp) { CurrentSpeed = currSp; MaxSpeed = maxSp; PetName = name; } public void Accelerate(int delta) { // 如果Car无法使用了,触发Exploded事件 if (CarIsDead) { if (Exploded != null) { Exploded("sorry,this car is dead"); } } else { CurrentSpeed += delta; // 确认已无法使用,触发AboutToBlow事件 if ((MaxSpeed - CurrentSpeed) == 10 && AboutToBlow != null) { AboutToBlow("careful buddy ! gonna blow !"); } if (CurrentSpeed >= MaxSpeed) { CarIsDead = true; } else { Console.WriteLine(@"$CurrentSpeed={CurrentSpeed}"); } } } }