[C#1] 10事件

事件概述

CLR的事件模型建立在委托的机制之上。定义事件成员的类型允许类型(或者类型的实例)在某些特定事件发生时通知其他对象，事件为类型提供了一下三种能力：

1允许对象登记该事件

2允许对象注销该事件

3允许定义事件的对象维持一个登记对象的集合，并在某些特定的事件反生时通知这些对象

下面是根据一个上课的场景解释事件的原理【上课铃响，老师讲课，学生进教室听课】。定义一个RingManager类管理上课铃声，定义一个SchoolBell【上课铃响】的事件，Teacher和Student类型登记该事件。当Teacher和Student对象构造时登记 SchoolBell事件，上课铃声响起时则通知这两个对象。

发布事件

class RingManager
{
    /*
    * 定义一个类型保存发送给事件登记者的附加信息，
    * 按照.NET框架的约定，所有这样保存事件信息的类型
    * 都继承自System.EventArgs,且以EventArgs作
    * 为名字的结尾。    
    */
    public class SchoolBellEventArgs : EventArgs
    {
        //教室位置
        public readonly string classRoom;
        //上课时间
        public readonly DateTime schoolTime;
 
        public SchoolBellEventArgs(string classroom,
            DateTime schooltime)
        {
            this.classRoom = classroom;
            this.schoolTime = schooltime;
        }
    }
 
    /* 按照.NET框架的约定，委托类型的名称应该以
    * EventHander结束，回调方法的 原型有一个void返回值
    * 并且接受两个参数【object指向发送通知的对象，
    * e是给接受者的附加信息】
    */
    public delegate void SchoolBellEventHandler
        (object sender, SchoolBellEventArgs e);
 
    //声明事件成员
    public event SchoolBellEventHandler SchoolBell;
 
    //负责通知事件的登记对象
    public void OnSchoolBell(SchoolBellEventArgs e)
    {
        if (SchoolBell != null)
        {
            SchoolBell(this, e);
        }
    }
    //把输入的参数转化为事件调用
    public void IsOnTimeToClass(string classRoom,
        DateTime time)
    {
        OnSchoolBell(new SchoolBellEventArgs
            (classRoom, time));
    }
}

public event SchoolBellEventHandler SchoolBell;

当编译器遇到上面一行代码时，会产生一下3个构造[IL代码]：

public event SchoolBellEventHandler SchoolBell
 //虽然我们声明的是public，但是编译器为我们产生了private的 私有字段
 //这样做可以防止类型外的的错误操作[也说明事件在一方面封装了委托]
 .field private class RingManager/SchoolBellEventHandler SchoolBell

 //add_SchoolBell方法注册事件
 .method public hidebysig specialname instance void
    add_SchoolBell(class RingManager/SchoolBellEventHandler
    'value') cil managed synchronized
 {
    //......省略
    //调用System.Delegate的静态方法Combine把委托对象添加到委托链表
    IL_0008: call class[mscorlib]System.Delegate[mscorlib]System.Delegate::
        Combine(class [mscorlib]System.Delegate, class [mscorlib]System.Delegate)
    //..省略
 }

 //注销事件
 .method public hidebysig specialname instance void
    remove_SchoolBell(class RingManager/SchoolBellEventHandler
    'value') cil managed synchronized
 {
    //。。。省略
    //调用System.Delegate的静态方法Remove从委托链表中移除委托对象
    IL_0008:callclass[mscorlib]System.Delegate[mscorlib]System.Delegate::
        Remove(class [mscorlib]System.Delegate,class [mscorlib]System.Delegate)
 //。。。省略
 }

仔细看IL代码的话会发现add_SchoolBell和remove_SchoolBell方法声明后面有一个单词synchronized【它表示这个方法加锁,相当于不管哪一个线程1每次运行到这个方法时,都要检查有没有其它正在用这个方法的2线程,有的话要等正在使用这个方法的线程2（或者其他345线程）运行完这个方法后再运行此线程1没有的话,直接运行，这个特性是 [MethodImplAttribute(MethodImplOptions.Synchronized)],所属命名空间是System.Runtime.CompilerServices】，这保证了登记注销事件时的线程安全性。add_SchoolBell和remove_SchoolBell方法的访问级别取决于源代码中声明的事件的访问级别。

除了上述3个构造外，编译器还会在托管模块中的元数据产生一个事件定义条目，包含了一些标记和定义事件所使用的委托类型，并且有对add和remove方法的引用。

.event RingManager/SchoolBellEventHandler SchoolBell
{
    .addon instance void RingManager::add_SchoolBell(class RingManager/SchoolBellEventHandler)
    .removeon instance void RingManager::remove_SchoolBell(class RingManager/SchoolBellEventHandler)
} // end of event RingManager::SchoolBell

侦听事件

+=和-=对应这rm.add_SchoolBell和rm.remove_SchoolBell方法【编译器帮我们调用这两个方法】:

//老师类，学生类就不写了
class Teacher
{
    //构造老师对象时穿进去RingManager
    public Teacher(RingManager rm)
    {
        rm.SchoolBell += 
            new RingManager.SchoolBellEventHandler(rm_SchoolBell);
    }
 
    //老师的回调方法
    private void rm_SchoolBell(object sender, 
        RingManager.SchoolBellEventArgs e)
    {
        //sender表示RingManager的对象
        Console.WriteLine("上课铃响了--我是老师：");
        //e是事件的附加信息
        Console.WriteLine("在{0}上课,现在时间是{1}",
            e.classRoom, e.schoolTime);
    }
 
    //注销SchoolBell事件
    public void UnRegister(RingManager rm)
    {
        RingManager.SchoolBellEventHandler rm_sbea =
            new RingManager.SchoolBellEventHandler(rm_SchoolBell);
        rm.SchoolBell -= rm_sbea;
    }
}

测试代码：

static void Main()
{
    RingManager rm = new RingManager();
    Teacher t = new Teacher(rm);
    //触发事件，老师t的到通知，做他该做的事情
    rm.IsOnTimeToClass("教学楼320教室", DateTime.Now);
    //老师注销该事件
    t.UnRegister(rm);
    //再次触发事件，这次老师t接受不到通知了
    rm.IsOnTimeToClass("教学楼320教室", DateTime.Now);
}

显示控制事件注册

有时候我们的程序是在单线程的环境下运行的，还需要频繁的添加或者移除委托实例，则编译器自动产生的add和remove方法就不够理想了，而且加了线程同步保护使性能有所损伤。

C#编译器允许我们显示的实现add和remove方法，下面的代码对RingManager做了些修改，显示的实现了add和remove方法：

//声明一个私有的委托字段
private SchoolBellEventHandler _SchoolBell;
 
//像是属性一样的写法，add和remove都接受一个隐含参数value
public event SchoolBellEventHandler SchoolBell
{
    add
    {
        //添加value（委托对象）到委托链表
        _SchoolBell = (SchoolBellEventHandler)
            Delegate.Combine(_SchoolBell, value);
    }
    remove
    {
        //从委托链表_SchoolBell中移除value（委托对象）
        _SchoolBell = (SchoolBellEventHandler)
            Delegate.Remove(_SchoolBell, value);
    }
}
 
//负责通知事件的登记对象
public void OnSchoolBell(SchoolBellEventArgs e)
{
    if (_SchoolBell != null)
    {
        _SchoolBell(this, e);
    }
}

把第一个RingManager中的public event SchoolBellEventHandler SchoolBell和public void OnSchoolBell(SchoolBellEventArgs e)方法换成上述代码就可以了。上述代码和第一个RingManager中的代码编译后的代码的行为除了去掉了[MethodImplAttribute(MethodImplOptions.Synchronized)]特性之外完全相同。这里去除了线程安全的保障。