C#的event关键字有什么作用?如何发布和订阅事件?

C#中的event关键字提供类型安全的观察者模式实现,通过定义事件、触发事件和订阅事件实现对象间松耦合通信;使用event而非public delegate可确保封装性、防止外部触发和误操作;推荐使用EventHandler泛型委托和继承EventArgs的自定义参数类,并遵循命名规范;需注意内存泄漏、异常传播、执行顺序不确定及跨线程UI更新等潜在问题,合理取消订阅、处理异常并采用弱事件模式以提升健壮性和性能。

c#的event关键字有什么作用?如何发布和订阅事件?

C#中的

event

关键字提供了一种强大且类型安全的机制,用于实现观察者模式,让对象(发布者)能够通知其他对象(订阅者)某个特定事件的发生,而无需直接了解这些订阅者的具体信息。这就像一个广播系统:发布者发出信号,所有感兴趣的订阅者都能接收到并作出响应。发布事件涉及在发布者类中定义事件并适时触发它,而订阅事件则是在订阅者类中将方法(事件处理程序)附加到该事件上。

解决方案

要发布和订阅事件,你需要定义一个发布者类和一个或多个订阅者类。

发布者(Publisher)的实现:

定义一个委托(Delegate): 委托定义了事件处理方法的签名。通常,我们会使用

EventHandler

或泛型的

EventHandler

// 假设我们要传递一个字符串消息public class MessageEventArgs : EventArgs{    public string Message { get; }    public MessageEventArgs(string message)    {        Message = message;    }}public class Notifier{    // 声明一个事件,类型是EventHandler    // 这表示事件处理方法需要接收一个object sender和MessageEventArgs e参数    public event EventHandler? MessageSent;    public void SendMessage(string msg)    {        Console.WriteLine($"Notifier: 准备发送消息 '{msg}'...");        // 触发事件。在C# 6.0及以后,可以使用 ?.Invoke() 安全地调用        // 传统方式是检查 MessageSent != null        MessageSent?.Invoke(this, new MessageEventArgs(msg));        Console.WriteLine("Notifier: 消息发送完成。");    }}

订阅者(Subscriber)的实现:

创建事件处理方法: 这个方法必须与发布者事件的委托签名匹配。订阅事件: 使用

+=

运算符将事件处理方法附加到发布者的事件上。取消订阅(可选但推荐): 使用

-=

运算符在不再需要时移除事件处理方法,这对于避免内存泄漏很重要。

    public class Listener    {        private string _name;        public Listener(string name)        {            _name = name;        }        // 事件处理方法,签名与EventHandler匹配        public void OnMessageReceived(object? sender, MessageEventArgs e)        {            Console.WriteLine($"{_name}: 接收到来自 {((Notifier?)sender)?.GetType().Name ?? "未知来源"} 的消息:'{e.Message}'");        }    }    // 示例用法    public class Program    {        public static void Main(string[] args)        {            Notifier notifier = new Notifier();            Listener listener1 = new Listener("监听者A");            Listener listener2 = new Listener("监听者B");            // 订阅事件            notifier.MessageSent += listener1.OnMessageReceived;            notifier.MessageSent += listener2.OnMessageReceived;            notifier.SendMessage("你好,世界!");            Console.WriteLine("--- 监听者B取消订阅 ---");            // 监听者B取消订阅            notifier.MessageSent -= listener2.OnMessageReceived;            notifier.SendMessage("这是一条测试消息。");            // 当程序结束或不再需要时,通常也建议取消订阅            notifier.MessageSent -= listener1.OnMessageReceived;        }    }

运行上述代码,你会看到消息首先被两个监听者接收,在监听者B取消订阅后,只有监听者A会继续接收消息。

为什么应该使用

event

关键字而不是直接公开

delegate

字段?

这是一个非常关键的问题,也是

event

关键字存在的根本原因。如果只是简单地声明一个

public delegate MyDelegate MyEvent;

字段,确实也能实现类似的回调机制,但它会带来一些严重的封装性、健壮性和安全性问题。

event

关键字本质上是对一个委托字段的封装,它通过隐式地实现

add

remove

访问器,限制了外部代码对这个委托的直接操作:

封装性与安全性:

只允许

+=

-=

操作:

event

只允许外部代码使用

+=

(添加事件处理方法)和

-=

(移除事件处理方法)。你不能在类外部直接用

=

来赋值,这意味着你不能不小心地清空所有已注册的事件处理方法,或者替换掉已有的订阅者。防止外部触发:

event

只能由其声明的类(或其派生类)内部来触发(Invoke)。外部代码无法直接调用事件,这保证了事件触发的控制权始终在发布者手中,防止了不必要的或恶意的事件触发。对比

public delegate

如果你直接公开一个

public delegate MyDelegate MyEvent;

,外部代码可以随意执行

MyEvent = null;

(清空所有订阅者),

MyEvent = SomeMethod;

(覆盖所有订阅者),甚至

MyEvent.Invoke();

(在发布者不知情的情况下触发事件)。这完全破坏了事件的意图和封装性。

线程安全(针对订阅/取消订阅):

event

add

remove

访问器在内部是线程安全的。这意味着在多线程环境下,多个线程同时尝试订阅或取消订阅同一个事件时,CLR会确保委托链的修改是原子性的,从而避免了潜在的竞态条件和损坏。需要注意的是,这仅限于

add

remove

操作,事件的实际

Invoke

(触发)过程本身并不提供线程安全,如果事件处理程序修改共享状态,仍需手动处理线程同步。

清晰的意图表达:

使用

event

关键字明确地告诉代码读者:“这是一个事件,它遵循观察者模式,外部可以订阅,但不能随意操作或触发。”这比一个普通的

public delegate

字段更能清晰地表达设计意图。

所以,尽管

delegate

是事件的基础,但

event

关键字提供了必要的封装和保护,使得事件机制更加健壮、安全和易于管理,是实现事件驱动编程的最佳实践。

事件处理程序和事件参数的常见模式是什么?

在C#中,事件处理程序和事件参数的设计遵循一套约定俗成的模式,这不仅提高了代码的可读性,也方便了框架和库的互操作性。

标准事件委托

EventHandler

EventHandler

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

这是最基本的事件委托,用于事件不传递任何特定数据的情况。

sender

参数通常是事件的发布者(即触发事件的对象),

e

参数是

EventArgs.Empty

。例如:

public event EventHandler? SomethingHappened;

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

这是更常用、更灵活的泛型版本。当事件需要传递额外数据时,你应该使用它。

TEventArgs

必须是一个继承自

System.EventArgs

的类型。例如:

public event EventHandler? DataReceived;

自定义事件参数类(

TEventArgs

):

当你需要向事件处理程序传递自定义数据时,必须创建一个继承自

System.EventArgs

的类。这个类应该包含所有你需要传递给订阅者的信息。

设计原则:

通常,事件参数类应该是不可变的(immutable),即属性只提供

get

访问器。这样可以避免事件处理程序在处理过程中意外修改参数,影响其他处理程序或发布者。属性名应具有描述性。

示例:

// 假设我们有一个下载器,下载完成时需要传递文件路径和大小public class DownloadCompletedEventArgs : EventArgs{    public string FilePath { get; }    public long FileSize { get; }    public DateTime CompletionTime { get; }    public DownloadCompletedEventArgs(string filePath, long fileSize)    {        FilePath = filePath;        FileSize = fileSize;        CompletionTime = DateTime.Now;    }}public class Downloader{    public event EventHandler? DownloadCompleted;    public void StartDownload(string url)    {        Console.WriteLine($"开始下载 {url}...");        // 模拟下载过程        System.Threading.Thread.Sleep(1000);        string filePath = $"C:Downloads{Path.GetFileName(url)}";        long fileSize = new Random().Next(1024 * 1024, 10 * 1024 * 1024); // 1MB to 10MB        Console.WriteLine($"下载完成:{filePath}, 大小:{fileSize} 字节");        DownloadCompleted?.Invoke(this, new DownloadCompletedEventArgs(filePath, fileSize));    }}

命名约定:

事件名: 通常是过去时态的动词,表示某个动作已经发生(例如

Click

,

Loaded

,

DownloadCompleted

)。事件处理方法名: 通常以

On

开头,后跟事件名(例如

OnButtonClick

,

OnDataReceived

)。事件参数类名: 通常以事件名开头,以

EventArgs

结尾(例如

ClickEventArgs

,

DataReceivedEventArgs

)。触发事件的方法名: 通常是

On

开头,后跟事件名,并标记为

protected virtual

,以便派生类可以重写或扩展事件触发逻辑,同时在内部调用事件(例如

protected virtual void OnDownloadCompleted(DownloadCompletedEventArgs e)

)。

遵循这些模式,不仅能让你的代码更符合C#社区的习惯,也使得事件机制的使用更加清晰、一致和易于维护。

使用事件时有哪些性能考虑或潜在陷阱?

事件机制虽然强大,但在不恰当的使用下,确实可能引入一些性能问题或难以调试的逻辑错误。理解这些潜在的陷阱对于编写健壮、高效的C#代码至关重要。

内存泄漏(Memory Leaks)——最常见的陷阱:

问题描述: 当一个订阅者对象订阅了发布者的事件,但没有在适当的时候取消订阅(使用

-=

),即使订阅者对象本身已经不再被使用,发布者仍然会持有对它的引用。只要发布者对象存在,垃圾回收器就无法回收订阅者对象,从而导致内存泄漏。这在订阅者生命周期短于发布者的情况下尤为突出。场景举例: 一个全局性的日志服务(发布者)被多个临时创建的UI组件(订阅者)订阅。如果UI组件在关闭时没有取消订阅,日志服务会一直持有对这些已关闭UI组件的引用,导致它们无法被回收。解决方案:明确取消订阅: 在订阅者不再需要接收事件时,务必调用

-=

操作符取消订阅。例如,在UI组件的

Dispose

方法或窗体关闭事件中执行取消订阅。弱事件模式(Weak Events): 对于生命周期不确定的订阅者,或者为了避免手动取消订阅的繁琐和遗漏,可以使用弱事件模式。这通常通过

WeakEventManager

(WPF/Silverlight提供)或自定义实现来完成,它允许发布者持有订阅者的弱引用,不阻止垃圾回收。事件生命周期管理: 确保事件的订阅和取消订阅与对象的生命周期同步。

事件处理程序的执行顺序不确定性:

问题描述: C#规范并未明确保证事件处理程序被调用的顺序。虽然在大多数情况下,它们会按照订阅的顺序被调用,但你不应该依赖这种行为。解决方案: 避免编写依赖于特定事件处理程序执行顺序的代码。如果存在顺序依赖,考虑重新设计,例如使用责任链模式,或者让一个中央协调器来管理多个操作的执行。

异常处理——一个处理程序失败可能影响所有:

问题描述: 当事件被触发时,如果某个订阅者的事件处理程序抛出了未捕获的异常,这个异常会向上冒泡,可能会导致整个应用程序崩溃,或者至少阻止后续的事件处理程序被调用。解决方案:在事件触发处捕获异常: 在发布者触发事件的代码中,遍历委托链并为每个处理程序调用都加上

try-catch

块。这样即使某个处理程序失败,其他处理程序仍能正常执行,并且可以记录下异常信息。示例:

protected virtual void OnDownloadCompleted(DownloadCompletedEventArgs e){    // 获取委托链的副本,防止在遍历过程中被修改    EventHandler? handler = DownloadCompleted;    if (handler != null)    {        // 获取所有订阅者        Delegate[] delegates = handler.GetInvocationList();        foreach (EventHandler del in delegates)        {            try            {                del.Invoke(this, e);            }            catch (Exception ex)            {                // 记录异常,但允许其他处理程序继续执行                Console.Error.WriteLine($"错误:事件处理程序 {del.Method.Name} 抛出异常: {ex.Message}");                // 考虑是否需要重新抛出异常,或者根据业务逻辑决定            }        }    }}

订阅者内部处理: 订阅者也可以在自己的事件处理程序内部进行异常处理,但这仅限于处理自身逻辑的异常,无法阻止其他处理程序因异常而中断。

性能开销(相对较小但存在):

问题描述: 虽然通常可以忽略不计,但在事件触发非常频繁(例如,每秒数千次)且有大量订阅者的情况下,事件的

Invoke

操作会带来一些开销。这包括委托的创建、参数的封装、以及遍历委托链并调用每个方法的开销。解决方案:避免过度频繁触发: 如果事件触发频率极高,考虑是否能降低频率,或者批量处理事件。减少不必要的订阅: 确保只有真正需要接收事件的对象才进行订阅。考虑其他模式: 对于高性能场景,有时可能需要考虑更底层的回调机制或专门的消息队列。

跨线程调用UI更新:

问题描述: 如果事件发布者在非UI线程上触发事件,而事件处理程序试图直接更新UI(例如WinForms或WPF控件),则会导致跨线程访问UI的异常。UI元素通常只能在其创建的线程上被访问。解决方案:使用

Invoke

BeginInvoke

在WinForms中,使用控件的

Invoke

BeginInvoke

方法将UI更新操作调度回UI线程。使用

Dispatcher

在WPF中,使用

Application.Current.Dispatcher.Invoke

BeginInvoke

异步/等待模式: 在现代C#中,结合

async/await

可以更优雅地处理跨线程UI更新。

理解并妥善处理这些潜在问题,能够让你更有效地利用C#的事件机制,构建出稳定、高效且易于维护的应用程序。

以上就是C#的event关键字有什么作用?如何发布和订阅事件?的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1439133.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月17日 15:54:20
下一篇 2025年12月15日 12:15:38

相关推荐

  • C#的foreach循环如何遍历集合?底层实现是什么?

    答案:foreach循环通过IEnumerator实现安全遍历,避免修改集合时的异常。它利用IEnumerable接口获取枚举器,以MoveNext和Current遍历元素,编译器自动生成try-finally确保资源释放,适合只读场景;而for循环更灵活高效但易出错,修改集合时应避免foreach…

    2025年12月17日
    000
  • C#的TaskSchedulerException是什么?任务调度异常

    taskschedulerexception通常由自定义taskscheduler使用不当引起,最常见的原因是调度器已被处置或存在实现缺陷。1. 首先检查taskschedulerexception的innerexception,若为objectdisposedexception,则表明调度器已被释…

    2025年12月17日
    000
  • C#的in关键字有什么作用?如何传递只读引用?

    in关键字用于传递大型值类型的只读引用,避免复制开销,提升性能。它适用于大型struct的高频调用场景,确保方法内无法修改原始数据,兼具性能与安全。与ref(读写引用)和out(输出引用)不同,in仅用于输入且不可修改,不适用于小型值类型或需修改参数的场景,调用时可省略in但建议显式标注以明确意图。…

    2025年12月17日
    000
  • C#的协变(Covariance)和逆变(Contravariance)是什么?

    协变(out关键字)允许将更具体的泛型类型赋值给更通用的类型,适用于只输出数据的场景,如ienumerable和func;2. 逆变(in关键字)允许将更通用的泛型类型赋值给更具体的类型,适用于只输入数据的场景,如action和icomparer;3. 它们的核心应用场景包括集合操作中的类型转换、委…

    2025年12月17日
    000
  • .NET的CustomAttributeData类如何读取特性信息?

    CustomAttributeData提供非侵入式读取特性的元数据,避免实例化带来的性能开销与异常风险,适用于程序集分析、代码生成等需安全高效解析特性的场景。 在.NET中, CustomAttributeData 类提供了一种非常强大的机制,它允许我们以“非侵入式”的方式读取和检查类型或成员上应用…

    2025年12月17日
    000
  • C#的File类提供了哪些文件操作方法?

    要高效读取大型文本文件,应避免使用file.readalltext,改用file.readlines或streamreader逐行读取。1. 使用file.readlines:foreach (string line in file.readlines(“largefile.txt&#8…

    2025年12月17日
    000
  • C#的record关键字如何定义不可变类型?有什么优势?

    record关键字定义不可变类型,简化数据模型创建;其默认值语义、非破坏性修改(with表达式)和自动实现Equals/GetHashCode提升代码安全与可维护性;适用于DTO、值对象、配置等场景,确保数据不可变,避免并发bug,增强线程安全性。 C#的 record 关键字提供了一种简洁而强大的…

    2025年12月17日
    000
  • .NET的AssemblySignatureKeyAttribute类的作用是什么?

    AssemblySignatureKeyAttribute用于解决.NET强命名程序集在密钥更换时的兼容性问题,允许新密钥签名的程序集保留对旧公钥的信任,维持引用完整性与发布者策略的连续性,确保应用程序在密钥轮换后仍能正常加载和验证,避免因公钥标记变化导致的兼容性断裂,是实现安全迁移与信任链延续的关…

    2025年12月17日
    000
  • C语言中scanf怎么读取输入C语言scanf函数的常见问题解析

    scanf函数在c语言中用于读取标准输入,但存在多个潜在问题。1. scanf的返回值表示成功读取并赋值的变量数量,若未检查该值可能导致错误数据处理或未初始化变量使用;2. 使用%s读取字符串时若不指定长度可能引发缓冲区溢出,应使用%n s格式限制读取字符数;3. 输入失败后残留字符会干扰后续输入,…

    2025年12月17日 好文分享
    000
  • BackgroundWorker的RunWorkerCompleted异常怎么检查?

    在backgroundworker的runworkercompleted事件中,必须检查e.error是否为null来判断dowork中是否发生异常;2. backgroundworker内部会自动捕获dowork中的未处理异常并将其赋值给e.error,从而安全传递到ui线程;3. 常见陷阱包括未…

    2025年12月17日
    000
  • .NET的Reflection是什么?如何动态加载类型?

    答案:.NET Reflection允许程序在运行时动态加载类型、调用方法和访问属性,主要通过Assembly.LoadFrom等方法加载程序集,再使用GetType或GetTypes获取类型信息,并结合Activator.CreateInstance创建实例,常用于插件化架构、DI容器、ORM框架…

    2025年12月17日
    000
  • C#的interface关键字如何定义接口?怎么实现?

    接口是C#中定义行为契约的关键机制,通过interface关键字声明方法、属性等成员而不提供实现,强调“能做什么”而非“怎么做”。类或结构体通过实现接口来履行契约,必须提供接口所有成员的具体实现,支持多接口继承,从而突破单继承限制。接口默认成员为public abstract,不可包含字段、构造函数…

    2025年12月17日
    000
  • C语言中怎样进行矩阵运算 C语言多维数组与指针运算方法

    c语言中矩阵运算的实现需手动定义多维数组并编写运算函数。1. 使用多维数组表示矩阵,如int matrix3; 2. 初始化时通过循环赋值;3. 编写加法、乘法等运算函数,如矩阵加法遍历对应元素相加,矩阵乘法则计算行与列的乘积和;4. 动态分配内存时使用malloc或calloc,并检查返回值确保成…

    2025年12月17日 好文分享
    000
  • using语句在C#中有什么用?如何管理资源释放?

    c#的using语句是管理资源释放的理想选择,因为它通过编译器将using块转换为try-finally结构,确保实现了idisposable接口的对象在作用域结束时自动调用dispose方法,从而可靠释放文件句柄、数据库连接等非托管资源,避免资源泄露;2. using语句不仅适用于文件操作,还可广…

    2025年12月17日
    000
  • C#的implicit和explicit关键字如何定义类型转换?

    implicit用于安全无损的自动转换,explicit用于可能丢失数据或需明确意图的强制转换,选择依据是转换的安全性与直观性。 在C#中, implicit 和 explicit 这两个关键字是用来定义自定义类型转换操作符的。简单来说,它们允许你告诉编译器,你的自定义类型(比如一个类或结构体)如何…

    2025年12月17日
    000
  • .NET的Strongly Named Assembly是什么?如何创建?

    强名称程序集是带有唯一加密标识的.net程序集,用于确保唯一性、完整性和版本控制,它由程序集名称、版本号、文化信息和公钥令牌组成,主要用于解决dll hell问题和gac安装需求;其核心价值在于通过数字签名防止篡改、支持并行版本运行,并在.net framework时代广泛用于共享程序集管理;尽管在…

    2025年12月17日
    000
  • c语言中的指针是什么概念 如何理解指针的指向和解引用

    指针是内存地址,其核心在于存储变量地址而非值本身。1. 指针类型决定编译器如何解释内存数据:int 读取4字节,char 读取1字节;2. 常见错误包括空指针解引用、野指针、内存泄漏、越界访问和类型不匹配,分别通过判空、初始化、及时释放、边界检查和正确类型转换避免;3. 数组名可视为首元素指针但为常…

    2025年12月17日 好文分享
    000
  • ConcurrentDictionary的AddDuplicateKeyException怎么避免?

    避免concurrentdictionary抛出addduplicatekeyexception的核心方法是不使用add方法,而应使用tryadd、addorupdate或getoradd等原子性操作。1. 使用tryadd(key, value):当键不存在时添加,存在则返回false,不抛异常;…

    2025年12月17日
    000
  • C#的using关键字有什么作用?如何使用?

    c#中的using关键字有两个核心作用:一是通过using指令引入命名空间,简化类型引用;二是通过using语句或声明确保实现了idisposable接口的对象在使用后能自动释放非托管资源,防止资源泄露。using指令允许直接使用类型名而无需全限定名,提升代码可读性;using语句则通过隐式生成tr…

    2025年12月17日
    000
  • C#持续集成环境搭建

    搭建c#持续集成环境的核心在于自动化构建、测试和部署流程,选择合适的工具并确保团队遵循ci/cd原则;1.选择ci工具时应考虑与现有工具的集成程度、易用性、可扩展性和成本,如jenkins、azure devops、github actions和gitlab ci/cd等;2.c#项目ci流程包括代…

    2025年12月17日
    000

发表回复

登录后才能评论
关注微信