C Sharp 事件模式

C#事件模式

介绍

在C#中，事件（Event）是一种特殊的委托类型，用于实现发布-订阅（Publisher-Subscriber）模式。事件允许类或对象在发生特定动作时通知其他类或对象，而无需知道这些类的具体实现细节。事件模式广泛应用于用户界面编程（如按钮点击）、异步编程和组件间的通信。

事件的核心组成部分包括：

• 事件发布者（Publisher）：触发事件的对象。
• 事件订阅者（Subscriber）：接收并处理事件的对象。
• 事件委托（Delegate）：定义事件处理方法的签名。

事件的基本语法

在C#中，事件基于委托（Delegate）实现。以下是声明和使用事件的步骤：

1. 定义一个委托类型（如果使用内置的EventHandler或EventHandler<TEventArgs>可跳过此步）。 2. 使用event关键字声明事件。 3. 订阅事件（使用+=操作符）。 4. 触发事件（在适当条件下调用事件）。

示例代码

以下是一个简单的事件声明和使用的例子：

using System;

// 1. 定义委托
public delegate void MessageHandler(string message);

// 2. 发布者类
public class Publisher
{
    // 声明事件
    public event MessageHandler MessagePublished;

    // 触发事件的方法
    public void PublishMessage(string message)
    {
        Console.WriteLine($"发布者正在发布消息: {message}");
        MessagePublished?.Invoke(message); // 触发事件
    }
}

// 3. 订阅者类
public class Subscriber
{
    public void OnMessageReceived(string message)
    {
        Console.WriteLine($"订阅者收到消息: {message}");
    }
}

// 4. 主程序
class Program
{
    static void Main()
    {
        var publisher = new Publisher();
        var subscriber = new Subscriber();

        // 订阅事件
        publisher.MessagePublished += subscriber.OnMessageReceived;

        // 发布消息（触发事件）
        publisher.PublishMessage("Hello, C# 事件模式！");
    }
}

输出：

发布者正在发布消息: Hello, C# 事件模式！
订阅者收到消息: Hello, C# 事件模式！

代码解释

1. 定义了一个委托MessageHandler，它接受一个string参数。 2. Publisher类包含一个事件MessagePublished，并在PublishMessage方法中触发该事件。 3. Subscriber类定义了一个方法OnMessageReceived，用于处理事件。 4. 在主程序中，订阅者通过+=订阅事件，发布者调用PublishMessage触发事件。

.NET内置事件模式

.NET框架提供了标准的事件模式，使用EventHandler委托和EventArgs基类。这是推荐的做法，因为它提供了更好的兼容性和一致性。

标准事件示例

using System;

// 自定义事件参数
public class CustomEventArgs : EventArgs
{
    public string Message { get; set; }
    public CustomEventArgs(string message)
    {
        Message = message;
    }
}

// 发布者
public class Publisher
{
    // 使用 EventHandler<T> 声明事件
    public event EventHandler<CustomEventArgs> MessagePublished;

    public void PublishMessage(string message)
    {
        Console.WriteLine($"发布消息: {message}");
        MessagePublished?.Invoke(this, new CustomEventArgs(message));
    }
}

// 订阅者
public class Subscriber
{
    public void OnMessageReceived(object sender, CustomEventArgs e)
    {
        Console.WriteLine($"收到消息: {e.Message}");
    }
}

class Program
{
    static void Main()
    {
        var publisher = new Publisher();
        var subscriber = new Subscriber();

        publisher.MessagePublished += subscriber.OnMessageReceived;
        publisher.PublishMessage("标准事件示例");
    }
}

输出：

发布消息: 标准事件示例
收到消息: 标准事件示例

使用内置 EventHandler 的优势

• 标准化：所有.NET开发者都熟悉此模式。
• 灵活性：可以通过派生EventArgs传递任意数据。
• 安全性：事件只能在声明它的类中触发（通过Invoke）。

事件访问器

C#允许自定义事件的添加（add）和移除（remove）逻辑，类似于属性的get和set。

private EventHandler<CustomEventArgs> _messagePublished;

public event EventHandler<CustomEventArgs> MessagePublished
{
    add
    {
        Console.WriteLine("添加订阅者");
        _messagePublished += value;
    }
    remove
    {
        Console.WriteLine("移除订阅者");
        _messagePublished -= value;
    }
}

实际应用案例

案例1：UI按钮点击

在WPF或WinForms中，按钮点击是通过事件处理的：

button.Click += (sender, e) => 
{
    MessageBox.Show("按钮被点击了！");
};

案例2：文件下载完成通知

模拟一个文件下载器，下载完成后触发事件：

public class FileDownloader
{
    public event EventHandler<string> DownloadCompleted;

    public void DownloadFile(string url)
    {
        Console.WriteLine($"开始下载: {url}");
        // 模拟下载过程
        Thread.Sleep(2000);
        DownloadCompleted?.Invoke(this, $"文件 {url} 下载完成");
    }
}

事件与多线程

在跨线程编程中，需要确保事件处理是线程安全的。可以通过以下方式实现：

• 使用Invoke（在UI线程中）。
• 在触发事件前检查null（如?.Invoke）。
• 使用同步机制如lock。

事件模式的最佳实践

1. 命名约定：事件名使用动词或动词短语（如Clicked、DownloadCompleted）。 2. 使用标准模式：优先使用EventHandler<TEventArgs>。 3. 线程安全：确保多线程环境下正确触发事件。 4. 避免内存泄漏：及时取消订阅（-=）不再需要的事件。

常见问题

问题1：为什么事件触发前要检查null？

因为如果没有任何订阅者，事件是null，直接调用会导致NullReferenceException。使用?.Invoke可以安全触发。

问题2：如何传递多个参数？

通过自定义EventArgs派生类，将多个参数封装为属性。

总结

C#事件模式是实现松耦合组件通信的强大机制。通过事件，发布者可以通知订阅者而不必知道其具体实现。掌握事件模式对于开发交互式应用程序和组件化系统至关重要。

sequenceDiagram participant Publisher participant Subscriber Publisher->>Subscriber: 事件触发 Note right of Subscriber: 订阅者处理事件

通过本文，你应该已经理解了：

• 事件的基本概念和语法。
• 标准事件模式（EventHandler）的使用。
• 实际开发中的事件应用场景。
• 事件处理的最佳实践。