C# 事件

声明

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

本文主要包括以下内容:

  1. 标准的事件模式
  2. 事件访问器
  3. 事件修饰符

事件

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

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

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

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

声明事件,最简单的声明事件的方式就是在委托前面加上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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,706评论 4 366
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,002评论 1 301
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,462评论 0 250
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,375评论 0 216
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,763评论 3 294
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,849评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,033评论 2 317
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,768评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,490评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,734评论 2 253
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,204评论 1 264
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,566评论 3 260
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,227评论 3 241
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,137评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,934评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,926评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,774评论 2 274

推荐阅读更多精彩内容

  • 事件 事件含义 事件由对象引发,通过我们提供的代码来处理。一个事件我们必须订阅(Subscribe)他们,订阅一个...
    天堂迈舞阅读 2,874评论 1 7
  • 了解事件 事件的应用 深入理解事件 事件的声明 问题辨明 认识事件 事件是应用程序在执行过程中所关注的一些动作,但...
    JunChow520阅读 831评论 0 1
  • 之前讲过了委托,要了解委托可以看之前讲委托的那一节https://www.jianshu.com/p/64416b...
    满苑繁花阅读 1,780评论 0 0
  • 事件 基本用法 关键字event,声明格式为: public event <委托类型> <事件对象> 事件的处理方...
    CieloSun阅读 1,924评论 0 0
  • 事件是基于委托的,为委托提供了一个发布/订阅机制。可以说事件是一种特殊的委托,他的调用和委托是一样的。 事件的声明...
    zhaojieandy阅读 5,662评论 0 1