当前位置：首页 > article >正文

C# 中的 IRecipient

article 2025/8/26 7:49:03

IRecipient<TMessage> 是 .NET 中消息传递机制的重要组成部分，特别是在 MVVM (Model-View-ViewModel) 模式中广泛使用。下面我将详细介绍这一机制及其应用。

基本概念

IRecipient<TMessage> 是 .NET Community Toolkit 和 MVVM Toolkit 中定义的一个接口，用于简化消息接收的实现。

public interface IRecipient<TMessage>where TMessage : class
{void Receive(TMessage message);
}

核心组件

1. IMessenger 接口

消息传递的核心接口，负责消息的注册和发送：

public interface IMessenger
{void Register<TRecipient, TMessage>(TRecipient recipient)where TRecipient : class, IRecipient<TMessage>where TMessage : class;void Send<TMessage>(TMessage message)where TMessage : class;void Unregister<TMessage>(object recipient)where TMessage : class;
}

2. WeakReferenceMessenger

默认实现的弱引用消息传递者，防止内存泄漏：

public class WeakReferenceMessenger : IMessenger
{// 实现细节...
}

基本用法

1. 定义消息

public class UserLoggedInMessage
{public string Username { get; }public UserLoggedInMessage(string username){Username = username;}
}

2. 实现接收者

public class UserDashboardViewModel : IRecipient<UserLoggedInMessage>
{public void Receive(UserLoggedInMessage message){// 处理用户登录消息Console.WriteLine($"欢迎, {message.Username}!");}public UserDashboardViewModel(IMessenger messenger){// 注册接收消息messenger.Register<UserLoggedInMessage>(this);}
}

3. 发送消息

var messenger = new WeakReferenceMessenger();
var dashboardVM = new UserDashboardViewModel(messenger);// 发送消息
messenger.Send(new UserLoggedInMessage("张三"));

高级应用

1. 多消息接收

一个类可以接收多种消息：

public class MultiMessageReceiver : IRecipient<UserLoggedInMessage>,IRecipient<UserLoggedOutMessage>
{public void Receive(UserLoggedInMessage message){// 处理登录}public void Receive(UserLoggedOutMessage message){// 处理登出}public MultiMessageReceiver(IMessenger messenger){messenger.Register<UserLoggedInMessage>(this);messenger.Register<UserLoggedOutMessage>(this);}
}

2. 条件性接收

public void Receive(UserLoggedInMessage message)
{if (message.Username == "admin"){// 特殊处理管理员登录}
}

3. 取消注册

public void Dispose()
{_messenger.Unregister<UserLoggedInMessage>(this);_messenger.Unregister<UserLoggedOutMessage>(this);
}

在 MVVM 中的应用

1. ViewModel 间通信

// 在发送方 ViewModel
_messenger.Send(new DataUpdatedMessage(updatedData));// 在接收方 ViewModel
public class DataConsumerViewModel : IRecipient<DataUpdatedMessage>
{public void Receive(DataUpdatedMessage message){// 更新数据}
}

2. View 和 ViewModel 解耦

// 在 View 的代码隐藏中
public partial class MainView : Window, IRecipient<NavigateMessage>
{public MainView(){InitializeComponent();var messenger = App.Current.Services.GetService<IMessenger>();messenger.Register<NavigateMessage>(this);}public void Receive(NavigateMessage message){// 处理导航请求frame.Navigate(message.TargetPage);}
}