由浅入深理解C#中的事件

这篇具有很好参考价值的文章主要介绍了由浅入深理解C#中的事件。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

目录

本文较长,给大家提供了目录,可以直接看自己感兴趣的部分。

前言

有关事件的概念

示例

​   简单示例

​   标准 .NET 事件模式

​   使用泛型版本的标准 .NET 事件模式

​   补充

总结
参考

前言

前面介绍了C#中的委托,事件的很多部分都与委托类似。实际上,事件就像是专门用于某种特殊用途的简单委托,事件包含了一个私有的委托,如下图所示:

有关事件的私有委托需要了解的重要事项如下:

1、事件提供了对它的私有控制委托的结构化访问。我们无法直接访问该委托。

2、事件中可用的操作比委托要少,对于事件我们只可以添加、删除或调用事件处理程序。

3、事件被触发时,它调用委托来依次调用调用列表中的方法。

有关事件的概念

发布者(Publisher):发布某个事件的类或结构,其他类可以在该事件发生时得到通知。

订阅者(Subscriber):注册并在事件发生时得到通知的类或结构。

事件处理程序(event handler):由订阅者注册到事件的方法,在发布者触发事件时执行。

触发(raise)事件:调用(invoke)或触发(fire)事件的术语。当事件触发时,所有注册到它的方法都会被依次调用。

示例

简单示例

现在我们先来看一下最最原始的事件示例。其结构如下所示:

委托类型声明:事件和事件处理程序必须有共同的签名和返回类型,它们通过委托类型进行描述。

事件处理程序声明:订阅者类中会在事件触发时执行的方法声明。它们不一定有显示命名的方法,还可以是匿名方法或Lambda表达式。

事件声明:发布者类必须声明一个订阅者类可以注册的事件成员。当声明的事件为public时,称为发布了事件。

事件注册:订阅者必须订阅事件才能在它被触发时得到通知。

触发事件的代码:发布者类中”触发“事件并导致调用注册的所有事件处理程序的代码。

现在我们可以照着这个思路去写示例代码。

首先声明一个自定义的委托类型:

 public delegate void MyDelegate();

该委托类型没有参数也没有返回值。

然后再写一个发布者类:

   public class Publisher
   {
       public event MyDelegate MyEvent;
       public void DoCount()
       {
           for(int i = 0; i < 10; i++) 
           { 
               Task.Delay(3000).Wait();            
                   
               //确认有方法可以执行
               if(MyEvent != null)
               {
                    //触发事件
                    MyEvent();
                }
               
           }
       }
   }

事件声明:

 public event MyDelegate MyEvent;

事件声明在一个类中,它需要委托类型的名称,任何注册到事件的处理程序都必须与委托类型的签名和返回类型匹配。它声明为public,这样其他类和结构可以在它上面注册事件处理程序。不能使用对象创建表达式(new表达式)来创建它的对象。

一个常见的误解就是把事件认为是类型,事件其实不是类型,它和方法、属性一样是类或结构的成员。

由于事件是成员,所以我们不能在一段可执行的代码中声明事件,它必须声明在类或结构中,和其他成员一样。

事件成员被隐式自动初始化为null。

事件声明的图解如下所示:

触发事件:

              //确认有方法可以执行
               if(MyEvent != null)
               {
                    //触发事件
                    MyEvent();
                }

也可以这样写:

              //确认有方法可以执行
               if(MyEvent != null)
               {
                    //触发事件
                    MyEvent().Invoke();
                }

这两者是等效的,MyEvent();直接调用事件的委托,MyEvent().Invoke()使用显式调用委托的 Invoke 方法。

现在再看看订阅者类:

  public class Subscriber
  {          
      public void EventHandler()
      {
          Console.WriteLine($"{DateTime.Now}执行了事件处理程序");
      }
  }

订阅者类中有一个EventHandler方法,与前面定义的委托类型的签名与返回值类型一致。

在看下主函数:

 static void Main(string[] args)
 {
   Publisher publisher = new Publisher();
   Subscriber subscriber = new Subscriber();
   
   //订阅事件
   publisher.MyEvent += subscriber.EventHandler;
   
   publisher.DoCount();
 }
 publisher.MyEvent += subscriber.EventHandler;

就是在订阅事件,对应上面结构图中的事件注册,将subscriber类的EventHandler方法注册到publisher类的MyEvent事件上。

也可以通过:

 publisher.MyEvent -= subscriber.EventHandler;

取消订阅事件。

运行结果如下所示:

本示例全部代码如下所示:

 internal class Program
 {
     public delegate void MyDelegate();
     public class Publisher
     {
         public event MyDelegate MyEvent;
         public void DoCount()
         {
             for(int i = 0; i < 3; i++) 
             { 
                 Task.Delay(3000).Wait();
              
                 //确认有方法可以执行
                 if(MyEvent != null)
                 {
                     //触发事件
                     MyEvent();
                 }
                 
             }
         }
     }
     public class Subscriber
     {          
         public void EventHandler()
         {
             Console.WriteLine($"{DateTime.Now}执行了事件处理程序");
         }
     }
     static void Main(string[] args)
     {
       Publisher publisher = new Publisher();
       Subscriber subscriber = new Subscriber();
       
       //订阅事件
       publisher.MyEvent += subscriber.EventHandler;
       
       publisher.DoCount();
     }
 }

以上就根据上面的结构图写出了一个使用事件的示例,但是本示例还有需要改进的地方。

上面我们触发事件检查空值是这样写的:

                 //确认有方法可以执行
                 if(MyEvent != null)
                 {
                     //触发事件
                     MyEvent();
                 }

C# 6.0 引入了空条件操作符之后,现在也可以这样做空值检查:

 MyEvent?.Invoke();

同时也不是一上来就检查空值,而是先将MyEvent赋给第二个委托变量localDelegate:

 MyDelegate localDelegate = MyEvent;
 localDelegate?.Invoke();

这个简单的修改可确保在检查空值和发送通知之间,如果一个不同的线程移除了所有MyEvent订阅者,将不会引发NullReferenceException异常。

标准 .NET 事件模式

以上我们以一个简单的例子介绍了C#中的事件,但是大家可能会觉得有点模式,跟我们平常在winform中使用的事件好像不太一样,那是因为 .NET 框架提供了一个标准模式,接下来我将以winform中的button按钮点击事件为例进行介绍。

页面很简单,只有一个button按钮:

然后button按钮点击事件的代码如下:

 private void button1_Click(object sender, EventArgs e)
 {
     MessageBox.Show("Hello World");
 }

现在我们再根据下面这张事件结构图,来看一看标准的 .NET 事件模式:

事件注册

打开解决方案中的Form1.Designer.cs文件:

看到button1相关内容:

button1.Click += button1_Click;

就是在订阅事件,对应上面图中的事件注册。

委托类型声明

右键查看定义:

 public event EventHandler? Click
 {
     add => Events.AddHandler(s_clickEvent, value);
     remove => Events.RemoveHandler(s_clickEvent, value);
 }

发现Click事件中的委托类型是EventHandler,再查看EventHandler的定义:

 public delegate void EventHandler(object? sender, EventArgs e);

这一步对应上面事件结构图中的委托类型声明。

EventHandler是 .NET中预定义的委托,专门用来表示不生成数据的事件的事件处理程序方法应有的签名与返回类型。

第一个参数是sender,用来保存触发事件的对象的引用。由于是object?类型,所以可以匹配任何类型的实例。

第二个参数是e,用于传递数据。但是EventArgs类表示包含事件数据的类的基类,并提供用于不包含事件数据的事件的值。也就是说EventArgs设计为不能传递任何数据。它用于不需要传递数据的事件处理程序,通常会被忽略。如果我们想要传递数据,必须声明一个派生自EventArgs的类,使用合适的字段来保存需要传递的数据。

尽管EventArgs类实际上并不传递数据,但它是使用EventHandler委托模式的重要部分。不管参数使用的实际类型是什么,object类和EventArgs类总是基类,这样EventHandler就能提供一个对所有事件和事件处理器都通用的签名,只允许两个参数,而不是各自都有不同签名。

事件声明

 public event EventHandler? Click
 {
     add => Events.AddHandler(s_clickEvent, value);
     remove => Events.RemoveHandler(s_clickEvent, value);
 }

Click事件在Control类中定义,Button类继承自ButtonBase类,而ButtonBase类继承自Control类。

public event EventHandler? Click;

对应上面结构图中的事件声明。

触发事件的代码

查看Button类的定义,找到OnClick方法的定义:

 protected override void OnClick(EventArgs e)
 {
     Form? form = FindForm();
     if (form is not null)
     {
         form.DialogResult = _dialogResult;
     }

     // accessibility stuff
     AccessibilityNotifyClients(AccessibleEvents.StateChange, -1);
     AccessibilityNotifyClients(AccessibleEvents.NameChange, -1);

     // UIA events:
     if (IsAccessibilityObjectCreated)
     {
         AccessibilityObject.RaiseAutomationPropertyChangedEvent(UiaCore.UIA.NamePropertyId, Name, Name);
         AccessibilityObject.RaiseAutomationEvent(UiaCore.UIA.AutomationPropertyChangedEventId);
     }

     base.OnClick(e);
 }

去掉无关部分,保留相关部分便于理解:

 protected override void OnClick(EventArgs e)
 {
         base.OnClick(e);
}    

这里的base指的是Button类的基类ButtonBase类:

再查看ButtonBase类中OnClick方法的定义:

 protected override void OnClick(EventArgs e)
 {
     base.OnClick(e);
     OnRequestCommandExecute(e);
 }

发现也有一个base.OnClick(e);,这里的base指的是ButtonBase类的基类Control

再查看Control类中OnClick方法的定义:

 /// <summary>
 ///  Raises the <see cref="Click"/>
 ///  event.
 /// </summary>
 [EditorBrowsable(EditorBrowsableState.Advanced)]
 protected virtual void OnClick(EventArgs e)
 {
     ((EventHandler?)Events[s_clickEvent])?.Invoke(this, e);
 }

终于找到了触发事件的代码。

事件处理程序

这个想必大家并不陌生,双击button按钮就可以看到:

  private void button1_Click(object sender, EventArgs e)
  {
      MessageBox.Show("Hello World");
  }

这对应上面结构图中的事件处理程序。该事件处理程序方法的签名与返回值类型与EventHandler委托类型一致。

使用泛型版本的标准 .NET事件模式

接下来我会举一个例子,说明如何使用泛型版本的标准 .NET事件模式。

第一步,自定义事件数据类,该类继承自EventArgs类:

  public class MyEventArgs : EventArgs
  {
      public string? Message {  get; set; }
      public DateTime? Date {  get; set; }
  }

拥有两个属性Message与Date。

第二步,写发布者类:

  public class Publisher
  {
      public event EventHandler<MyEventArgs>? SendMessageEvent;
      public void SendMessage()
      {
          for(int i = 0; i < 3; i++)
          {
              Task.Delay(3000).Wait();
              MyEventArgs e = new MyEventArgs();
              e.Message = $"第{i+1}次触发事件";
              e.Date = DateTime.Now;
              EventHandler<MyEventArgs>? localEventHandler = SendMessageEvent;
              localEventHandler?.Invoke(this, e);
          }
      }
  }
public event EventHandler<MyEventArgs>? SendMessageEvent;

声明了事件。

 EventHandler<MyEventArgs>? localEventHandler = SendMessageEvent;
 localEventHandler?.Invoke(this, e);

触发了事件。

第三步,写订阅者类:

 public class Subscriber
 {
     public void EventHandler(object? sender,MyEventArgs e)
     {
         Console.WriteLine($"Received Message:{e.Message} at {e.Date}");
     }
 }

包含事件处理程序,该方法与EventHandler<MyEventArgs>委托类型的签名与返回值类型一致。

第四步,写主函数:

  static void Main(string[] args)
  {
     Publisher publisher = new Publisher();
     Subscriber subscriber = new Subscriber();
     publisher.SendMessageEvent += subscriber.EventHandler;
     publisher.SendMessage();
  }
 publisher.SendMessageEvent += subscriber.EventHandler;

订阅事件。

运行结果如下所示:

包含了我们自定义的事件数据。

补充

上面说自定义的事件数据类要继承自EventArgs类,但其实在 .NET Core 的模式较为宽松。 在此版本中,EventHandler<TEventArgs> 定义不再要求 TEventArgs 必须是派生自 System.EventArgs 的类。

因此我在.NET 8 版本的示例中去掉继承自EventArgs类,该示例依旧能正常运行。

异步事件订阅者

一个关于异步事件订阅者的例子如下:

// 事件发布者
public class EventPublisher
{
    // 定义异步事件
    public event Func<string, Task>? MyEvent;

    // 触发事件的方法
    public async Task RaiseEventAsync(string message)
    {
        Func<string, Task> localEvent = MyEvent;
        await localEvent?.Invoke(message);
    }
}

// 异步事件订阅者
public class AsyncEventSubscriber
{
    // 处理事件的异步方法
    public async Task HandleEventAsync(string message)
    {
        Console.WriteLine($"Received event with message: {message}");

        // 异步操作,例如IO操作、网络请求等
        await Task.Delay(3000);

        Console.WriteLine("Event handling complete.");
    }
}

class Program
{
    static async Task Main(string[] args)
    {
        // 创建事件发布者
        var publisher = new EventPublisher();

        // 创建异步事件订阅者
        var subscriber = new AsyncEventSubscriber();

        // 订阅事件
        publisher.MyEvent += subscriber.HandleEventAsync;

        // 触发事件
        await publisher.RaiseEventAsync("Hello, world!");

        Console.ReadLine();
    }
}

运行结果如下所示:

总结

本文先是介绍了一些C#中事件的相关概念,然后通过几个例子介绍了在C#中如何使用事件。

参考

1、《C#图解教程》

2、《C# 7.0 本质论》

3、[C# 文档 - 入门、教程、参考。 | Microsoft Learn]文章来源地址https://www.toymoban.com/news/detail-777060.html

到了这里,关于由浅入深理解C#中的事件的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Docker由浅入深(一)

    容器化技术介绍 介绍容器化之前,我们得先知道,为什么会出现容器化,容器化之前都经历了什么 物理机时代 部署非常慢 成功很高 浪费资源 难于扩展与迁移 受制于硬件 虚拟化时代 在同一个物理机上安装多个虚拟机,每个虚拟机安装操作系统和应用, 虚拟机之间物理资源

    2024年02月03日
    浏览(49)
  • 由浅入深了解HashMap源码

           由经典面试题引入,讲解一下HashMap的底层数据结构?这个面试题你当然可以只答,HashMap底层的数据结构是由(数组+链表+红黑树)实现的,但是显然面试官不太满意这个答案,毕竟这里有一个坑需要你去填,那就是在回答HashMap的底层数据结构时需要考虑JDK的版本,因

    2023年04月13日
    浏览(42)
  • React - redux 使用(由浅入深)

    中文文档: http://www.redux.org.cn/ 英文文档: https://redux.js.org/ Github: https://github.com/reactjs/redux 可直接参照 目录十 进行使用 react-redux redux 是一个专门用于做状态管理的JS库(不是react插件库)。 它可以用在 react, angular, vue 等项目中, 但基本与 react 配合使用。 作用: 集中式管理 re

    2024年02月07日
    浏览(50)
  • 【个人笔记】由浅入深分析 ClickHouse

    项目中不少地方使用到ClickHouse,就对它做了一个相对深入一点的了解和研究。并对各种知识点及整理过程中的一些理解心得进行了汇总并分享出来,希望对其他同学能有帮助。 本文主要讲解ClickHouse的特点、读写过程、存储形式、索引、引擎、物化视图等特性。 适合 入门和

    2024年01月20日
    浏览(43)
  • 由浅入深Netty代码调优

    序列化,反序列化主要用在消息正文的转换上 序列化时,需要将 Java 对象变为要传输的数据(可以是 byte[],或 json 等,最终都需要变成 byte[]) 反序列化时,需要将传入的正文数据还原成 Java 对象,便于处理 目前的代码仅支持 Java 自带的序列化,反序列化机制,核心代码如

    2024年02月05日
    浏览(43)
  • 手拉手Vue组件由浅入深

    组件 (Component) 是 Vue.js 最强大的功能之一,它是html、css、js等的一个聚合体,封装性和隔离性非常强。 组件化开发:     1、将一个具备完整功能的项目的一部分分割多处使用     2、加快项目的进度     3、可以进行项目的复用 组件注册分为:全局注册和局部注册 目录

    2024年01月18日
    浏览(42)
  • 【由浅入深学习MySQL】之索引进阶

    本系列为:MySQL数据库详解,为千锋资深教学老师独家创作 致力于为大家讲解清晰MySQL数据库相关知识点,含有丰富的代码案例及讲解。如果感觉对大家有帮助的话,可以【关注】持续追更~ 文末有本文重点总结,技术类问题,也欢迎大家和我们沟通交流! 从今天开始本系列

    2024年02月05日
    浏览(42)
  • 由浅入深介绍 Python Websocket 编程

    1.1 websocket 协议简介 Websocket协议是对http的改进,可以实现client 与 server之间的双向通信; websocket连接一旦建立就始终保持,直到client或server 中断连接,弥补了http无法保持长连接的不足,方便了客户端应用与服务器之间实时通信。 适用场景 html页面实时更新, 客户端的html页面

    2024年02月03日
    浏览(39)
  • Springboot3+EasyExcel由浅入深

    环境介绍 技术栈 springboot3+easyexcel 软件 版本 IDEA IntelliJ IDEA 2022.2.1 JDK 17 Spring Boot 3 EasyExcel是一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。 他能让你在不用考虑性能、内存的等因素的情况下,快速完成Excel的读、写等功能。 官网https://easyexcel.opensource.ali

    2024年01月16日
    浏览(42)
  • 由浅入深了解机器学习和GPT原理

    我不是一个机器学习专家,本来是一名软件工程师,与人工智能的互动很少。我一直渴望深入了解机器学习,但一直没有找到适合自己的入门方式。这就是为什么,当谷歌在2015年11月开源TensorFlow时,我非常兴奋,知道是时候开始学习之旅了。不想过于夸张,但对我来说,这就

    2024年02月09日
    浏览(32)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包