C# 事件

2019-08-23 本文已影响0人 JeetChan

声明

本文内容来自微软 MVP solenovex 的视频教程——真会C#? - 第4章委托、事件、Lambda表达式（完结），大致和第 3 课—— 4.2 事件 对应。可在 GitHub 中查看 C# 视频教程的配套PPT

本文主要包括以下内容：

标准的事件模式
事件访问器
事件修饰符

事件

类或对象可以通过事件向其他类或对象通知发生的相关事情。发送（或引发）事件的类称为“发布者” ，接收（或处理）事件的类称为“订阅者” 。

使用委托的时候，通常会出现两个角色，一个广播者，一个订阅者。

事件的广播和订阅，使用委托的时候，通常会出现两个角色，一个广播者，一个订阅者，广播者这个类型包含一个委托字段，广播者通过调用委托来决定什么时候进行广播。订阅者是方法目标的接收者，订阅者可以决定何时开始或结束监听，方式是通过在委托上调用+=和-=。一个订阅者不知道和不干扰其它的订阅者。

事件就是将上述模式正式化的一个语言特性。事件是一种结构，为了实现广播者/订阅者模型，它只暴露了所需的委托特性的部分子集。事件的主要目的就是防止订阅者之间互相干扰。

声明事件，最简单的声明事件的方式就是在委托前面加上event关键字。

// Broadercaster 类型里面的代码拥有对 PriceChanged 的完全访问权，在这里就可以把它当作委托。

// 而 Broadercaster 类型之外的代码只能对 PriceChanged 这个 event 执行 += 或 -= 操作。

// Delegate definition
public delegate void PriceChangedHandler (decimal oldPrice,
decimal newPrice);

public class Broadcaster
{
    // Event declaration
    public event PriceChangedHandler PriceChanged;
}

事件在内部是如何工作的？

public class Broadcaster
{
    public event PriceChangedHandler PriceChanged;
}

首先，编译器把事件的声明翻译成类似下面的代码：

PriceChangedHandler priceChanged; // private delegate

public event PriceChangedHandler PriceChanged
{
    add { priceChanged += value; }
    remove { priceChanged -= value; }
}

add 和 remove 关键字代表着显式的事件访问器，有点像属性访问器。
然后编译器会查看 Broadcaster 内部对 PriceChanged 的引用，如果不是 += 或 -= 的操作，那就直接把它们定向到底层的委托字段 priceChanged。
第三点，编译器把作用在 event 上的 += 和 -= 操作翻译成调用 add 或 remove 访问器。

标准的事件模式

为编写事件，.NET 定义了一个标准的模式，System.EventArgs，一个预定义的框架类，除了静态的 Empty 属性之外，它没有其它成员。EventArgs 是为事件传递信息的类的基类。

public class PriceChangedEventArgs : System.EventArgs
{
    public readonly decimal LastPrice;
    public readonly decimal NewPrice;
    
    public PriceChangedEventArgs (decimal lastPrice, decimal newPrice)
    {
        LastPrice = lastPrice;
        NewPrice = newPrice;
    }
}

通常是根据所含有的信息进行命名，而不是所使用的事件，通过属性或只读字段来暴露数据。

为事件选择或定义委托

返回类型是 void；接收两个参数，第一个参数类型是 object，第二参数类型是 EventArgs 的子类。第一个参数表示事件的广播者，第二个参数包含需要传递的信息；名称必须以 EventHandler 结尾。

`System.EventHandler<T>`

Framework 定义了一个范型委托System.EventHandler<T>，它满足上述规则。

public delegate void EventHandler<TEventArgs>
 (object source, TEventArgs e) where TEventArgs : EventArgs;

针对选择的委托定义事件

public class Stock
{
   ...
   public event EventHandler<PriceChangedEventArgs> PriceChanged;
}

可触发事件的 protected virtual 方法

方法名必须和事件一致，前面再加上 On，接收一个 EventArgs 参数。

public class Stock
{
    ...
    public event EventHandler<PriceChangedEventArgs> PriceChanged;
    
    protected virtual void OnPriceChanged (PriceChangedEventArgs e)
    {
        if (PriceChanged != null) PriceChanged (this, e);
    }
}

注意：多线程的场景下，你需要在测试或调用前，把委托赋给一个临时变量，来避免线程安全相关的错误：

var temp = PriceChanged;
if (temp != null) temp (this, e);

在C#6之后，可以这样写：PriceChanged?.Invoke (this, e);

非范型的 EventHandler

当事件不携带多余信息的时候，可以使用非范型的 EventHandler 委托。EventArgs.Empty 属性。

事件访问器

事件访问器是事件的+=和-=函数的实现。public event EventHandler PriceChanged;编译器会把它转化为：

一个私有的委托字段
一对公共的事件访问器函数（add_PriceChanged 和 remove_PriceChanged），这两个函数的实现会把+=和-=操作交给私有的委托字段。

也可以显式的定义事件访问器。

显式定义的事件访问器

当事件访问器仅仅是另一个广播事件的类的中继。当类暴露大量 event，但是大部分时候都只有少数的订阅者存在。显式实现一个声明了事件的接口。

private EventHandler priceChanged; // Declare a private delegate

public event EventHandler PriceChanged
{
    add { priceChanged += value; }
    remove { priceChanged -= value; }
}

事件修饰符

virtual，可以被重写；和类一样，有 abstract，sealed，static 修饰符。

public class Foo
{
    public static event EventHandler<EventArgs> StaticEvent;
    public virtual event EventHandler<EventArgs> VirtualEvent;
}

event.jpg

参考

Events (C# Programming Guide)
event (C# Reference)
EventArgs Class